Repository authentication

If authentication (HTTP(S) or SSH) is required to git clone a repository then you must provide credentials to the container.

First, ensure your Site admin > Manage code hosts code host configuration is configured to use SSH. For example, by setting the gitURLType field to "ssh". Alternatively, you may use the "Generic Git host" code host type, which allows you to directly specify Git repository URLs for cloning.

Then, you need to supply the SSH keys and passphrase to Sourcegraph if applicable. You have two options:

  • Option 1: Configure the SSH credentials in code host configuration in the Web UI. (Recommended)
  • Option 2: Mount the SSH keys into the container.

In supported code hosts configuration, you can provide the credentials in the JSON configuration. For example:

JSON
{
  "url": "https://github.com",
  "token": "<personal access token>",
  "gitURLType": "ssh",
  "gitSSHCredential": {
    // make sure the key is base64 encoded
    // $ cat ~/.ssh/id_rsa | base64
    "privateKey": "<base64 encoded of the SSH private key>",
    "passphrase": "<passphrase if applicable, omit if none is needed>"
  }
}

Some providers may require additional configuration, consult the code host specific documentation for more information.

Mounting SSH keys into the container

Troubleshooting

Error: illegal base64 data at input byte 0

This error indicates that the provided private key is not base64-encoded. Ensure that the private key is base64-encoded before providing it to Sourcegraph.

BASH
cat ~/.ssh/id_rsa | base64

What should be included in my config file?

We recommend adding the StrictHostKeyChecking no and AddKeysToAgent yes flags to prevent the need to give permission interactively when cloning from a new host.

YAML
Host *
  StrictHostKeyChecking no
  AddKeysToAgent yes

See git configuration for more details.

Error: sign_and_send_pubkey: no mutual signature supported

In Sourcegraph 5.1.0 and later, the insecure SSH rsa-sha1 signature algorithm is no longer supported when fetching data from code hosts.

If you use an RSA SSH key to authenticate to your code host, you should ensure that your code host runs OpenSSL 7.2 or newer.

If it is not possible to update the code host, you should generate a new ed25519 SSH key to use for authentication. This can be achieved by running ssh-keygen -t ed25519, and configuring Sourcegraph to use this new key.

Error: Host key verification failed

This indicates an invalid key is being used. You can confirm the error by cloning inside the gitserver directly. For example:

BASH
docker exec -it gitserver-0 sh
cd data/repos/<CODE-HOST>/<REPO-OWNER>
git clone <SSH-URL>

Error: Bad owner or permissions on /home/sourcegraph/.ssh/<YOUR-CONFIG-FILE>

This indicates the container is having trouble reading the configuration files due to permission / owner issues. The permission and ownership settings inside your .ssh/ directory should look similar to:

BASH
$ ls -al #command to display list of file with detailed information
total 20
drwxr-xr-x    6 sourcegr sourcegr       192 May 12 19:54 .
drwxr-sr-x    1 sourcegr sourcegr      4096 May 12 19:43 ..
-rw-------    1 sourcegr sourcegr        34 May 12 19:22 config
-rw-------    1 sourcegr sourcegr       411 May 12 18:52 id_ed25519
-rw-------    1 sourcegr sourcegr        98 May 12 18:52 id_ed25519.pub
-rw-------    1 sourcegr sourcegr       799 May 12 19:54 known_hosts
Solution
  • Inside the .ssh directory on the Host Machine:
    • Permission on all files must be set to 600, and 700 for the directory itself.
    • Files must be owned by a user who has access to the docker container. This can be done via sudo chown -v -R $USER:$GROUP (the user may need to set these values).
  • (OR) Inside the /home/sourcegraph/ directory on Docker Compose:
    • Permission on all files must be set to 600, and 700 for the directory itself.
    • Files must be owned by the root user, which is sourcegraph by default. This can be done via sudo chown -v -R $USER:$GROUP (the user may need to set these values).

NOTE: Once the volume for the configuration files has been mounted, both the /ssh directory on the host machine and docker will be synced and changes within one directory will be reflected by the other one. Consquently, you will only need to make the changes within one directory.

Error: Permissions 0644 for '/home/sourcegraph/.ssh/<YOUR-PRIVATE-KEY-FILE>' are too open

This indicates the permission on your private key file is accessible by users other than the file owner. Setting the file permission to 600 resolves the issue.