Enterprise Self-Hosted

This section of the documentation is meant for Sourcegraph enterprise self-hosted users.

Sourcegraph administration is primarily managed by site administrators, who are responsible for the deployment, management, and configuration of Sourcegraph instances for end users. For a comprehensive introduction to site administration, refer to our quickstart guide.

Deploy Sourcegraph

Get started running Sourcegraph on-prem.

• Deployment overview
• Single-node deployment
• Docker Compose
  • AWS installation
  • Digital Ocean installation
  • Google Cloud installation
• Kubernetes
• Machine images
• Instance sizing
• Resource estimator
• Scaling
• Best practices
• Validate a Sourcegraph deployment (experimental)

Upgrade Sourcegraph

• Upgrade Overview
• Docker Compose upgrades
• Kubernetes upgrades
• Migrator
• Upgrading PostgreSQL

Configure Sourcegraph

• For general admin tasks, see Sourcegraph Admin
• HTTP and HTTPS/SSL configuration
  • Adding SSL (HTTPS) to Sourcegraph with a self-signed certificate
• Setting the URL for your instance
• Configure email sending / SMTP server
• Scaling workers
• PostgreSQL configuration

Using external services

• External services overview
• PostgreSQL
• Redis
• Object storage (S3/GCS)

Executors

• Executors overview
• Deploy executors
• Kubernetes deployment (Beta)
• Terraform deployment: AWS | Google Cloud
• Docker deployment
• Binary deployment
• Binary deployment (offline)
• Docker-in-Docker (Beta)
• Firecracker
• Configuration
• Troubleshooting

Advanced tasks

• Loading configuration via the file system
• Restore postgres database from snapshot
• Enabling database encryption for sensitive data
• Configuring Sourcegraph in private networks
• Restricting outgoing connections
• PostgreSQL
• PostgreSQL 12 end of life notice
• PostgreSQL collation version mismatch resolution
• Profiling (pprof)

Observability

• Monitoring guide
• Metrics and dashboards
• Dashboards reference
• Alerting
• Custom alerting consumption
• Alerts reference
• Tracing
• Logs
• OpenTelemetry
• Health checks
• Troubleshooting guide

How-to Guides

• Blobstore debugging
• Blobstore update notes
• Clear code intelligence data
• Dirty database (pre 3.37)
• Dirty database
• PostgreSQL 12 to 16 drift
• PostgreSQL 14 index corruption
• Precise code intel worker crashloopbackoff
• Privileged migrations
• Rebuild corrupt PostgreSQL indexes
• Redis ConfigMap
• Rollback database
• Run psql
• Setup HTTPS
• Troubleshoot pod eviction
• Unfinished migration
• Upgrade PostgreSQL 12 to 16 (builtin DBs)

FAQs