index.md

Local Environment Setup

<style> .markdown-body h2 { margin-top: 2em; } .markdown-body ul { list-style:none; padding-left: 1em; } .markdown-body ul li { margin: 0.5em 0; } .markdown-body ul li:before { content: ''; display: inline-block; height: 1.2em; width: 1em; background-size: contain; background-repeat: no-repeat; background-image: url(../batch_changes/file-icon.svg); margin-right: 0.5em; margin-bottom: -0.29em; } body.theme-dark .markdown-body ul li:before { filter: invert(50%); } </style>

Working on Sourcegraph code on your local machine

★ Quickstart with sg How-tos Troubleshooting

Quickstart

In order to run the Sourcegraph locally, the following pages will guide you from zero to having a local environment up and running, ready for contributions for the the most common use cases.

• Quickstart with sg

The quick start guide above provides a standard approach, focused on simplicity and accessiblility. But it's not the only way, the dependencies page below documents more exhaustively various approaches to set them up.

• Dependencies

Troubleshooting

The following pages list common problems with the local environment and their solutions:

• 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