#Installation Guide for Sourcegraph on macOS

Sourcegraph is a code search and navigation tool that is designed to help developers to find and understand the code easily. The following tutorial provides a step-by-step guide to install Sourcegraph on macOS.

##Prerequisites

  • A working macOS machine with an internet connection.
  • A terminal app.

##Steps

  1. Open the terminal app on your macOS machine.

  2. Install Docker on the system. Execute the following command in the terminal:

brew cask install docker

  1. After installation, launch Docker by typing 'Docker' in Spotlight or Applications.

  2. Clone the Sourcegraph Docker configuration repository using the following command:

git clone https://github.com/sourcegraph/deploy-sourcegraph.git && cd deploy-sourcegraph

  1. Create a personal access token on the Sourcegraph website by visiting https://sourcegraph.com/user/settings/tokens. This token will be used to authenticate Sourcegraph to your code hosting provider. Save the token in a safe place, as you will not be able to retrieve it once this page is closed.

  2. Open the .env file in the deploy-sourcegraph directory.

cp sample.env .env
open .env
  1. Set the EXTERNAL_URL variable to the URL of the instance that you want to run Sourcegraph on. Replace external.example.com with your own URL.
EXTERNAL_URL=https://external.example.com
  1. Add the token created in step 5 to the AUTH0_CLIENT_SECRET field.
AUTH0_CLIENT_SECRET=<your_personal_access_token>
  1. Configure Sourcegraph to connect to your code hosting provider by adding your provider's configuration to the configure.sh script. Sample provider configurations can be found in the deploy-sourcegraph/config directory. For example, openLDAP is included.
vim config/conf-ldap.json
  1. Run the configuration script to set up Sourcegraph with your configuration:
./configure.sh
  1. Start the Sourcegraph server:
docker-compose up -d
  1. You can now access your Sourcegraph instance by visiting the URL you specified in step 7 in your web browser. Please note that for the first use, the server might take some time to start up.

##Conclusion

By following these steps, you can install Sourcegraph on your macOS machine and start using it as a code search and navigation tool. Happy Coding!