Connect with GitHub

Haddock allows users to authenticate via GitHub OAuth, enabling project deployment directly from your repositories. Here’s how to set up GitHub integration from scratch.

Step 1: Start GitHub App Configuration#

From the welcome screen, click “App Configuration”.

This will open a form asking you to input:

• GitHub Client ID
• GitHub Client Secret

Step 2: Create a GitHub OAuth App#

You must create a GitHub OAuth application to obtain the required credentials.

🔧 How to Create a GitHub OAuth App#

1. Go to: GitHub Developer Settings
2. Under OAuth Apps, click “New OAuth App”

Fill in the following fields:

• Application name:
  Choose any name, for example: Haddock

• Homepage URL:
  This must point to your Haddock instance.
  Example: http://192.168.122.64

  (Replace with your real domain or IP)

• Authorization callback URL:
  This must end with /github so Haddock can handle the login response.
  Example: http://192.168.122.64/github

After submission, GitHub will generate two keys:

• Client ID
• Client Secret

Copy these values into the Haddock form.

Step 3: Submit the Configuration#

Paste the credentials in Haddock:

• GitHub Client ID
• GitHub Client Secret

Then click Update to save the configuration.

Haddock is now ready to authenticate users via GitHub OAuth.

Step 4: Sign in with GitHub#

Once the GitHub app is configured:

1. Return to the welcome screen
2. Click Login with GitHub again
3. You will now be redirected to GitHub to authorize access
4. Login and grant access when prompted

Step 5: Configure Your Domain (Same as Email Setup)#

After GitHub login, you will be redirected to the domain setup flow:

• Enter your main domain
• Add DNS records (A, wildcard A, TXT challenge)
• Click Refresh, wait for validation
• Save when all checks are ✅

For detailed steps, refer to the Email Signup Guide

Step 6: Update Your GitHub OAuth Callback (Important)#

Once your domain is configured, your platform is no longer on an IP like 192.168.122.64 — it has a real name like mydomain.com.

⚠️ You must update your OAuth app on GitHub to reflect this.

Go back to GitHub Developer Settings:#

• Change the Homepage URL to: https://mydomain.com/github

Click Update Application to save.

Your GitHub authentication is now fully functional with your custom domain.

✅ You’re Done!#

You can now log in to Haddock using GitHub on your domain and deploy projects from private or public repositories with ease.