GitHub OAuth
GitHub OAuth lets members sign in to your forum using their GitHub account. It takes about five minutes to set up.
Step 1 — Create a GitHub OAuth App
Section titled “Step 1 — Create a GitHub OAuth App”- Go to github.com/settings/developers and click New OAuth App
- Fill in the fields:
| Field | Value |
|---|---|
| Application name | Your forum name |
| Homepage URL | https://your-forum-domain.com |
| Authorization callback URL | https://your-forum-domain.com/api/v1/auth/oauth/github/callback |
- Leave Enable Device Flow unchecked
- Click Register application
Step 2 — Get your Client ID and Secret
Section titled “Step 2 — Get your Client ID and Secret”After registering, GitHub shows you the app page. Copy the Client ID.
Click Generate a new client secret, then copy the secret immediately — GitHub only shows it once.
Step 3 — Configure Nexus
Section titled “Step 3 — Configure Nexus”In your forum’s admin panel go to Admin → Integrations:
- Enable Sign in with GitHub
- Paste your Client ID
- Paste your Client Secret
- Click Save
GitHub sign-in will appear on the login and registration pages immediately.
Troubleshooting
Section titled “Troubleshooting”Clicking the GitHub button shows an offline page
This was a known issue with the PWA service worker intercepting the OAuth redirect. It is fixed in Nexus v0.2.5-beta and later. If you are on an older version, update with sudo nexus-update.
“redirect_uri mismatch” error from GitHub
The callback URL registered in your GitHub OAuth App doesn’t match what Nexus is sending. Double-check that the Authorization callback URL is exactly https://your-forum-domain.com/api/v1/auth/oauth/github/callback with no trailing slash.
“Bad credentials” or blank error The client secret is likely wrong. Generate a new one on GitHub and re-enter it in the admin panel.