Sourcegraph is a code search and navigation tool used in software development. This tutorial will guide you through the process of installing Sourcegraph on your Ubuntu Server.
Make sure your server satisfies the following requirements before attempting to install Sourcegraph:
Create a dedicated system user for Sourcegraph by running the following command:
sudo adduser --system --group sourcegraph
Sourcegraph requires a PostgreSQL database to store its data.
Install PostgreSQL by running the following command:
sudo apt-get update
sudo apt-get install postgresql postgresql-contrib
Create a new PostgreSQL user for Sourcegraph by running the following command, replacing sourcegraph
with your desired username:
sudo su - postgres
createuser --interactive --pwprompt sourcegraph
Create a new PostgreSQL database for Sourcegraph by running:
createdb -O sourcegraph sourcegraph
Edit the PostgreSQL configuration file by running:
sudo nano /etc/postgresql/13/main/postgresql.conf
Update the following settings:
listen_addresses = '*' # Set the IP address to listen on
max_connections = 200 # Maximum number of connections
shared_buffers = 1GB # Recommended value for Sourcegraph
work_mem = 10485kB # Recommended value for Sourcegraph
Save and close the file.
Restart the PostgreSQL service by running:
sudo systemctl restart postgresql
Run the following command to download and install the Sourcegraph Docker image:
sudo docker run --publish 2633:2633 --rm --name=sourcegraph -v /home/sourcegraph/config:/etc/sourcegraph -v /home/sourcegraph/data:/var/opt/sourcegraph sourcegraph/server:3.31.0
Note that you should replace /home/sourcegraph/config
and /home/sourcegraph/data
with your preferred file paths.
The above command will download and start the Sourcegraph Docker container on your server.
You can now access the Sourcegraph server by visiting http://your_server_ip_address:2633
in your web browser.
After installing Sourcegraph, you need to configure its settings.
Create an admin account by visiting http://your_server_ip_address:2633/signup
and following the prompts.
To secure the connection to the Sourcegraph server, you can configure a TLS certificate.
Obtain a TLS certificate from a trusted certificate authority (CA) or use a self-signed certificate.
Create a file named tls.crt
and paste your TLS certificate content into it.
Create a file named tls.key
and paste your private key content into it.
Move the two files to the /home/sourcegraph/config/
directory.
Open the Sourcegraph configuration file by running:
sudo nano /home/sourcegraph/config/config.yaml
Update the following settings:
tls:
cert: /etc/sourcegraph/tls.crt # Path to your TLS certificate
key: /etc/sourcegraph/tls.key # Path to your private key
Save and close the file.
Restart the Sourcegraph container by running:
sudo docker restart sourcegraph
You can now access the Sourcegraph server securely by visiting https://your_server_ip_address:2633
in your web browser.
Congratulations, you have successfully installed and configured Sourcegraph on your Ubuntu Server.
If you want to self-host in an easy, hands free way, need an external IP address, or simply want your data in your own hands, give IPv6.rs a try!
Alternatively, for the best virtual desktop, try Shells!