How to guides

Local development

• How to debug live code
• Set up local development with Zoekt and Sourcegraph

New features

• How to add support for a language

Troubleshooting

• Problems with node_modules or Javascript packages
• dial tcp 127.0.0.1:3090: connect: connection refused
• Database migration failures
• Internal Server Error
• Increase maximum available file descriptors.
• Caddy 2 certificate problems
• Running out of disk space
• Certificate expiry
• CPU/RAM/bandwidth/battery usage

Implementing Sourcegraph

• Developing the product documentation
• Observability
  • How to find monitoring
  • How to add monitoring
  • Set up local Sourcegraph monitoring development

Testing Sourcegraph

• How to run tests
• Configure a test instance of Phabricator and Gitolite
• Test a Phabricator and Gitolite instance

Windows support

Running Sourcegraph on Windows is not actively tested, but should be possible within the Windows Subsystem for Linux (WSL). Sourcegraph currently relies on Unix specifics in several places, which makes it currently not possible to run Sourcegraph directly inside Windows without WSL. We are happy to accept contributions here! :)

Offline development

Sometimes you will want to develop Sourcegraph but it just so happens you will be on a plane or a train or perhaps a beach, and you will have no WiFi. And you may raise your fist toward heaven and say something like, "Why, we can put a man on the moon, so why can't we develop high-quality code search without an Internet connection?" But lower your hand back to your keyboard and fret no further, you can develop Sourcegraph with no connectivity by setting the OFFLINE environment variable:

OFFLINE=true dev/start.sh