|Deployment Type||Suggested for||Setup time||Multi-machine?||Auto healing?||Monitoring?|
|Single-container server||Local testing||60 seconds||Impossible||No||No|
|Docker Compose||Small & medium production deployments||5 minutes||Possible||No||Yes|
|Kubernetes||Medium & large highly-available cluster deployments||30 minutes||Easily||Yes||Yes|
sourcegraph/server) to the Docker Compose deployment, refer to this migration guide.
It takes less than 5 minutes to run and install Sourcegraph using Docker Compose:
git clone https://github.com/sourcegraph/deploy-sourcegraph-docker cd deploy-sourcegraph-docker/docker-compose git checkout v3.18.0-1 docker-compose up -d
Once the server is ready (the
sourcegraph-frontend-0 service is healthy when running
docker ps), navigate to the hostname or IP address on port
80. Create the admin account, then you’ll be guided through setting up Sourcegraph for code searching and navigation.
For next steps and further configuration options, visit the site administration documentation.
The docker compose installation requires a minimum of 8 CPU cores (logical) on the host machine in order to complete successfully. If using the Docker for Windows app, the default CPU count is only 2 which will result in errors during installation. You can go into the docker app settings->resources window to increase the CPU count to > 8 to resolve this issue.
release branch (to track all of your customizations to Sourcegraph. When you upgrade Sourcegraph’s Docker Compose definition, you will merge upstream into this branch.
SOURCEGRAPH_VERSION="v3.18.0-1" git checkout $SOURCEGRAPH_VERSION -b release
Use the resource estimator to find a good starting point for your deployment.
Cloud specific Sourcegraph installation guides for AWS, Google Cloud and Digital Ocean.
To test new development builds of Sourcegraph (triggered by commits to master), change all
index.docker.io/sourcegraph/* Docker image semver tags in docker-compose.yaml to
To keep this up to date, run
docker-compose pull to pull in the latest images, and run
docker-compose restart to restart all container to access new changes.