Connecting a self-hosted GitLab repository as your source

Last modified: June 1st, 2023

Connecting to your self-hosted GitLab allows you to work on your websites locally and have the changes sync to CloudCannon. File changes made on CloudCannon also get synced back to your self-hosted GitLab repository.

To connect to a repository instead, follow the instructions listed for GitLab.

Connecting to an instance#

Before syncing with a repository in your self-hosted GitLab, you need to connect CloudCannon to your self-hosted instance. You only need to do this once per account.

To connect to your self-hosted GitLab instance:

  1. Go to Settings / Self Hosted GitLab
  2. Enter the details for your self-hosted instance of GitLab
  3. Click Configure Self Hosted GitLab
Self hosted GitLab entry interface

The details for this page come from the GitLab server under User Settings / Applications.

Settings page from Gitlab

The Redirect URI is The minimal scopes required are:

  1. api
  2. read_user
  3. read_repository
  4. write_repository
  5. openid

Once completed, the key and secret will be available for use in CloudCannon. The URLs should match the form placeholders.

Syncing with a repository#

To connect a self-hosted GitLab repository and start syncing files, follow these instructions:

  1. Go to Site Settings / Source Syncing
  2. Select Self Hosted GitLab repository
  3. Click Authenticate
Selecting self hosted GitLab as the your provider

This redirects you to your self-hosted GitLab repository. Log in and authorize CloudCannon access to your self-hosted GitLab account. You'll be redirected back to CloudCannon to pick a repository to connect. If you don't have one for this website, create a new one in your self-hosted GitLab and refresh this page.

Selecting self hosted GitLab repository to sync

Any existing files on your website will be replaced with the contents of the selected repository. Click Backup and Sync to continue, or exit the page to cancel the process.

Your self-hosted GitLab is now connected. Changes you push to the Git repository are pulled in by CloudCannon. Any changes made on CloudCannon are automatically committed and pushed.

Configuring your GitLab connection#

Once you've connected your GitLab server, you can configure CloudCannon to support your particular infrastructure. You can find these configuration options under the Server tab of your Self Hosted GitLab settings. The options you have for configuring CloudCannon are:

  • Minimum Access Level,
  • Custom Headers, and
  • Custom CA Certificate.
Self Hosted GitLab settings interface

The Minimum Access Level setting allows you to change the minimum access CloudCannon requires to a GitLab repo to connect to it. By default CloudCannon requires Maintainer access to a repo before syncing to it. Self Hosted GitLab allows custom access level permissions so a lower access level may be sufficient, depending on your setup.

The Custom Headers setting allows you to configure additional headers for CloudCannon to use when connecting to your GitLab server. Custom headers are passed using Git's http.extraHeader configuration option and in the form key:value.

The Custom CA Certificate allows you to upload a PEM encoded certificate or certificate chain for CloudCannon to trust during Git operations. The certificate is passed using Git's http.sslCAInfo configuration option.

Related Articles

Open in a new tab