Skip to main content

Overview

With default installation, self-hosted appcircle comes with two git providers:

  • Self-hosted Bitbucket
  • Self-hosted GitLab

But you're not limited with these options. You can configure other git providers and use them within your self-hosted appcircle, same as in cloud.

Following sections will give you more details about adding other git providers.

info

We're assuming that previously you reviewed or followed install self-hosted appcircle section in docs, understood configuration made there and scenarios told there.

caution

Current working directory is assumed appcircle-server for following steps. See here for installation details.

caution

global.yaml configuration file is located under project folder.

  • projects/${YOUR_PROJECT}

You can see an example project configuration from here.

Connecting to Private Repository via SSH

To enable "Connect via SSH" git provider option, add below configuration to global.yaml.

build:
oauths:
ssh:
enabled: true

For more details about "Connect via SSH" usage, see related docs in here.

Connecting to Public Repository

To enable "Connect to a Public Repository" git provider option, add below configuration to global.yaml.

build:
oauths:
publicRepository:
enabled: true

For more details about "Connect to a Public Repository" usage, see related docs in here.

Applying Git Provider Changes

You can add git providers at installation steps or later when you need. Following sections will explain how to apply changes especially after installation.

Let's assume we want to enable both "Connect via SSH" and "Connect to a Public Repository" options. Then we need to add below section to our global.yaml.

build:
oauths:
ssh:
enabled: true
publicRepository:
enabled: true

If we do this at installation time then there is no extra step to take. These options will be enabled on first boot without any extra effort.

If we don't do the configuration at installation, then after editing global.yaml we need to apply below steps to activate changes.

info

We're assuming that previously you reviewed or followed install self-hosted appcircle section in docs and applied example scenario.

Following steps are using example project as project naming, which was told there.

  1. Shutdown appcircle server.
cd projects/spacetech/export
docker compose down
  1. Apply configuration changes.
cd ../../../
./ac-self-hosted.sh -n "spacetech"
  1. Boot appcircle server.
cd projects/spacetech/export
docker compose up -d

On complete, refresh your browser and login to appcircle with your account. You should see new git providers on repository connection page. 🎉