Install Sourcegraph with Docker Compose
If you want to migrate from the single-container server (
sourcegraph/server) to the Docker Compose deployment, refer to this migration guide.
- Sourcegraph Enterprise license. You can run through these instructions without one, but you must obtain a license for instances of more than 10 users.
- Docker Compose.
- A dedicated host with for your deployment.
- Use the resource estimator to ensure you provision enough capacity
- Sourcegraph requires SSD backed storage.
Note About Windows Installation
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 limited to 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.
It takes less than 5 minutes to run and install Sourcegraph using Docker Compose:
# 🚨 The master branch tracks development. Use the branch of this repository corresponding to the version of Sourcegraph you wish to deploy, e.g. git checkout v3.24.1 git clone https://github.com/sourcegraph/deploy-sourcegraph-docker cd deploy-sourcegraph-docker/docker-compose SOURCEGRAPH_VERSION="v3.26.3" git checkout $SOURCEGRAPH_VERSION 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.
Cloud installation guides
Cloud specific Sourcegraph installation guides for AWS, Google Cloud and Digital Ocean.