Getting started

Install the GitHub App

1. Go to the Shipfox GitHub App's page.
2. Click on Install.
3. Select the GitHub account or organization on which to install the App.
4. Grant access to all repositories or select the ones that you want to connect with Shipfox (you can change this setting later).
5. Click Install & Authorize.

Assign a Shipfox organization

1. You should have been redirected to the Shipfox dashboard automatically. If this is not the case, connect to it.
2. You will see all the GitHub App connections which have not been assigned to a Shipfox organization.
3. Click Select organization, and choose the organization you want to assign the GitHub installation to.
4. Once you have selected an organization for each installation, click Assign organizations.

Generate a secret token

1. On the Shipfox dashboard, go to your organization's GitLab settings.
2. In the Secret tokens section, click on Generate (you can set a name for the token to help you identify it).
3. A window will display with the token, copy it, and store it somewhere safe. It will not be displayed again.

Setup GitLab webhooks

Detailed documentation on setting webhooks in GitLab can be found here.

1. In GitLab go to your project or group webhook settings.
2. Click on Add new webhook.
3. In the URL field, set https://edge.shipfox.io/webhook/gitlab.
4. In the Secret token field, paste the token created in the previous section.
5. In the Trigger field, select Job events and Pipeline events.
6. Click on Save changes.