Managing GitHub Authorizations
Haddock allows you to authorize access to GitHub repositories through three methods:
- OAuth
- Personal Access Tokens
- SSH Private Keys
These authorizations are then available when creating or deploying projects.
Step 1: Open the Settings Drawer
From anywhere in the dashboard, click on the gear icon to open the Settings Drawer.
Once opened:
- Locate the section labeled “Authorizations”
- Click the arrow to expand it
This will reveal:
- A list of all current authorizations
- A trash icon next to each to delete them
- A purple “+” button to add a new one
Step 2: Add a New Authorization
Click the "+" button to open the authorization modal.
You will see a form asking for:
- Label: A custom name (e.g., “My GitHub OAuth”, “My PAT”, etc.)
- Authorization Type: Choose between OAuth, Personal Access Token, or Private Key
Type 1: OAuth Authorization
To use OAuth:
- Enter a label (e.g., “Team GitHub OAuth”)
- Select the OAuth option
- Click Login with GitHub
You will be redirected to GitHub to authorize the app. Once complete, Haddock will store the credentials.
⚠️ You must have previously configured a GitHub App in the App Configuration section.
Type 2: Personal Access Token
To use a Personal Access Token:
- Choose a label (e.g., “My Token Access”)
- Select Personal Access Token
- Paste your GitHub token in the input field
- Click Confirm
🧠 Make sure the token has the appropriate scopes (e.g.,
repo
,workflow
) depending on your needs.
Type 3: SSH Private Key
To use an SSH Private Key:
- Choose a label (e.g., “SSH Deploy Key”)
- Select Private Key
- Paste your full private key content (starts with
-----BEGIN RSA PRIVATE KEY-----
) - Click Confirm
💡 You can obtain your key using the command:
cat ~/.ssh/id_rsa
⚠️ Ensure that the key is not protected by a password.
Step 3: Manage Existing Authorizations
After creating authorizations:
- They will appear in the list under the “Authorizations” section.
- You can delete any authorization at any time using the trash icon.
- These methods will be available when choosing a repository source during project creation.
✅ You’re Ready!
You can now connect your GitHub projects to Haddock using your preferred method of authentication.