GitHub OAuth

GitHub OAuth lets users sign in to your Archie app using their GitHub account. Distinct from Connecting GitHub, which links a project to a repository for code sync.

​

Setup

1. Create an OAuth App in your GitHub developer settings:
   • Application name: your app’s name
   • Homepage URL: your app’s URL
   • Authorization callback URL: provided by Archie when you select GitHub OAuth
2. Copy the Client ID and Client Secret from GitHub.
3. In Archie, open Backend → App services → Authentication providers.
4. Add or edit the OAuth2 provider with GitHub’s endpoints:
   • Authorization URL: https://github.com/login/oauth/authorize
   • Token URL: https://github.com/login/oauth/access_token
   • User info URL: https://api.github.com/user
   • Scopes: read:user user:email
5. Paste the client ID and secret. Save.

​

What you get

After setup, your app’s sign-in screen shows a “Sign in with GitHub” option. Users authenticate against GitHub; Archie creates or updates the local user record using their GitHub email.

​

Profile mapping

GitHub returns:

• id — GitHub user ID (use as a stable identifier)
• email — primary email (request user:email scope to get this when private)
• login — GitHub username
• avatar_url — profile picture

Map these to your app’s user fields in the auth provider configuration.

​

Errors

The Archie app handles two common error pages:

• /github-oauth-error — shown when GitHub returns an error or the user cancels
• /github-setup-complete — shown after a successful repository link or OAuth setup

​

FAQ