sourcegraph

Universal code search (self-hosted)

Programming language: Go

License: GNU General Public License v3.0 or later

Tags: Software Development     IDE/Tools    

Latest version: v3.31.2

README

[](LICENSE)

Sourcegraph OSS edition is a fast, open-source, fully-featured code search and navigation engine. Enterprise editions are available.

Features

• Fast global code search with a hybrid backend that combines a trigram index with in-memory streaming.
• Code intelligence for many languages via the Language Server Index Format.
• Enhances GitHub, GitLab, Phabricator, and other code hosts and code review tools via the Sourcegraph browser extension.
• Integration with third-party developer tools via the Sourcegraph extension API.

Try it yourself

• Try out the public instance on any open-source repository at sourcegraph.com.
• Install the free and open-source browser extension.
• Spin up your own instance with the quickstart installation guide
• File feature requests and bug reports in our issue tracker.
• Visit about.sourcegraph.com for more information about product features.

Installation

Prebuilt Docker images are the fastest way to use Sourcegraph Enterprise. See the quickstart installation guide.

To use Sourcegraph OSS:

1. [Ensure Docker is running](doc/dev/getting-started/quickstart_2_start_docker.md)
2. [Initialize the PostgreSQL database](doc/dev/getting-started/quickstart_3_initialize_database.md)
3. [Configure the HTTPS reverse proxy](doc/dev/getting-started/quickstart_5_configure_https_reverse_proxy.md)
4. [Start the development server](doc/dev/getting-started/quickstart_6_start_server.md) sh ./dev/start.sh

Sourcegraph should now be running at https://sourcegraph.test:3443.

For detailed instructions and troubleshooting, see the [local development documentation](./doc/dev/index.md).

Development

Refer to the [Developing Sourcegraph guide](doc/dev/index.md) to get started.

Documentation

The doc directory has additional documentation for developing and understanding Sourcegraph:

• [Project FAQ](./doc/admin/faq.md)
• [Architecture](./doc/dev/background-information/architecture/index.md): high-level architecture
• [Database setup](./doc/dev/background-information/postgresql.md): database best practices
• General style guide
• Go style guide
• Documentation style guide
• [GraphQL API](./doc/api/graphql/index.md): useful tips when modifying the GraphQL API
• [Contributing](./CONTRIBUTING.md)

License

Sourcegraph OSS is available freely under the [Apache 2 license](LICENSE.apache). Sourcegraph OSS comprises all files in this repository except those in the enterprise/ and client/web/src/enterprise directories.

All files in the enterprise/ and client/web/src/enterprise/ directories are subject to the [Sourcegraph Enterprise license](LICENSE.enterprise).