Skip to content

Conversation

@waleedlatif1
Copy link
Collaborator

@waleedlatif1 waleedlatif1 commented Dec 8, 2025

Summary

  • added additional self-hosting documentation

Type of Change

  • Documentation

Testing

Tested manually

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel
Copy link

vercel bot commented Dec 8, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Dec 8, 2025 3:24am

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Dec 8, 2025

Greptile Overview

Greptile Summary

Added comprehensive self-hosting documentation covering Docker, Kubernetes, and cloud platform deployments.

  • New documentation section with 6 pages: overview, Docker setup, Kubernetes/Helm deployment, cloud platforms (Railway, AWS, Azure, DigitalOcean), environment variables reference, and troubleshooting guide
  • README updated with external Ollama/vLLM configuration, environment variables table, and troubleshooting tips
  • Documentation references valid helm charts (helm/sim/examples/values-*.yaml) and docker-compose files that exist in the repository
  • Well-structured navigation with proper meta.json configuration

Confidence Score: 5/5

  • Documentation-only changes with no code impact; safe to merge
  • This PR contains only documentation changes (markdown/MDX files and JSON navigation configs). All file references to helm charts and docker-compose files are valid. The documentation is well-structured and consistent with existing patterns.
  • No files require special attention

Important Files Changed

File Analysis

Filename Score Overview
README.md 5/5 Added documentation for external Ollama/vLLM setup, environment variables table, and troubleshooting section
apps/docs/content/docs/en/meta.json 5/5 Added "self-hosting" to pages array to include new documentation section
apps/docs/content/docs/en/self-hosting/index.mdx 5/5 New landing page for self-hosting docs with requirements, quick start, and deployment options
apps/docs/content/docs/en/self-hosting/docker.mdx 5/5 Comprehensive Docker deployment guide with SSL setup (Caddy/Nginx), Ollama configuration, and useful commands
apps/docs/content/docs/en/self-hosting/kubernetes.mdx 5/5 Helm deployment guide with cloud-specific values for AWS/Azure/GCP and external database configuration
apps/docs/content/docs/en/self-hosting/platforms.mdx 5/5 Cloud platform deployment guides for Railway, DigitalOcean, AWS EC2, Azure VM with step-by-step instructions
apps/docs/content/docs/en/self-hosting/environment-variables.mdx 5/5 Complete environment variables reference covering required, AI provider, OAuth, and optional configurations
apps/docs/content/docs/en/self-hosting/troubleshooting.mdx 5/5 Common issues and solutions for database, Ollama, WebSocket, SSL, Windows, and migration problems
apps/docs/content/docs/en/self-hosting/meta.json 5/5 Navigation configuration for self-hosting documentation section

Sequence Diagram

sequenceDiagram
    participant User
    participant Docs as Documentation Site
    participant SelfHost as Self-Hosting Section
    
    User->>Docs: Navigate to documentation
    Docs->>SelfHost: Access self-hosting section
    SelfHost-->>User: index.mdx (Overview & Requirements)
    
    alt Docker Deployment
        User->>SelfHost: Choose Docker
        SelfHost-->>User: docker.mdx (Docker Compose + SSL setup)
    else Kubernetes Deployment
        User->>SelfHost: Choose Kubernetes
        SelfHost-->>User: kubernetes.mdx (Helm + cloud values)
    else Cloud Platform
        User->>SelfHost: Choose Cloud Platform
        SelfHost-->>User: platforms.mdx (Railway, AWS, Azure, DO)
    end
    
    User->>SelfHost: Reference configuration
    SelfHost-->>User: environment-variables.mdx
    
    User->>SelfHost: Encounter issues
    SelfHost-->>User: troubleshooting.mdx
Loading

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

9 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

@waleedlatif1 waleedlatif1 merged commit 5b9f3d3 into staging Dec 8, 2025
9 checks passed
@waleedlatif1 waleedlatif1 deleted the feat/docs branch December 8, 2025 03:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants