Quickstart

To get started connect Shipfox with your CI provider.

GitHub Actions Documentation

Read the complete documentation of the GitHub Actions integration

Install the GitHub App

Install the Shipfox GitHub App

Go Shipfox GitHub App's page and follow the steps to install it in your GitHub organization. This grants Shipfox the required permissions to run your GitHub Actions jobs.

Shipfox works only with GitHub organizations. It does not support personal repositories.

Assign a Shipfox organization

After installation, go to the Shipfox dashboard and choose which Shipfox organization to link with your GitHub App installation.

Run your CI jobs on Shipfox

Edit your GitHub Actions workflow file to use the Shipfox runner:

.github/workflows/ci.yml

jobs:
  build:
-    runs-on: ubuntu-latest
+    runs-on: shipfox-2vcpu-ubuntu-2404

Setup done

You’re now ready to unlock the full potential of CI with Shipfox.

GitLab CI Documentation

Read the complete documentation of the GitLab CI integration

Generate a secret token

On the Shipfox dashboard, go to your organization's GitLab settings.
In the Secret tokens section, click on Generate (you can set a name for the token to help you identify it).
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.

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