Skip to content
Truchsess

Step 6: Connections

A connection lets workers use an outside service. The box keeps the secret. Workers never see it.

You need a connection only when a worker needs it. Workers that work on code need GitHub. Some workers need an API key of another service. You can also do this step later: the list of installed workers tells you what is missing.

Who can do this

Section titled “Who can do this”

The administrator, in the office on https://myai.local/. Connections cannot be changed from the remote address.

Before you start

Section titled “Before you start”
  • For GitHub: you can create apps in your GitHub organisation (you are an owner of the organisation), and you are signed in to GitHub in the same browser.
  • For an API key: the key from the service’s website. The card of each key has a link Where to get a key.

Steps

Section titled “Steps”

Connect GitHub

Section titled “Connect GitHub”
  1. Open Administration, sub-tab Connections.
  2. In the panel GitHub, enter your GitHub organisation (for example my-org). Leave it empty to use your personal GitHub account.
  3. Press Connect GitHub.
  4. GitHub opens. Press Create GitHub App.
  5. GitHub sends you back to the box. Wait until the box shows Choose the repositories on GitHub, then press it.
  6. On GitHub, choose the repositories the box may reach, then confirm.
  7. GitHub sends you back again. The card shows “Connected: your organisation, N repositories”.

Add an API key

Section titled “Add an API key”
  1. Open Administration, sub-tab Connections, panel API keys.
  2. Find the card that says “: needed” (one card per key that an installed worker needs).
  3. Press Add key.
  4. Paste the key.
  5. Press Save.

What you see afterwards

Section titled “What you see afterwards”
  • The GitHub card lists the repositories, who connected it and when, and “Last used”.
  • An API key card shows “Key ending …”, who added it and when.
  • Under Administration, Packages, Installed packages, the column Ready shows “Ready” for every worker that now has what it needs.
  • The panel Recent changes lists the change. It never shows a secret.

Your choices

Section titled “Your choices”
Choice What it does When to pick it Can you undo it?
Connect GitHub Creates a GitHub App for your box on GitHub, so nobody handles a private key. Recommended. Yes: Disconnect, then delete the App on GitHub.
Advanced: use an existing GitHub App Uses an App your IT already made. You enter App id, Installation id and the Private key (.pem). Only when your IT asks for it. Yes: Disconnect.
Repositories on GitHub Which repositories the box can reach at all. Each worker reaches only the repository it was given at install. Choose only what workers need. Yes: Change repositories.
Add key / Replace / Remove Stores, replaces or removes an API key. When a worker needs a key. Yes. A worker that needs a removed key refuses tasks.
Section titled “Related pages”