Github OAuth
Plane also supports GitHub OAuth so your users can sign in with GitHub.
Configure Plane as an OAuth app on GitHub
- Log in to your GitHub account.
- Click your profile avatar and go to Settings.
- Click Developer Settings and then OAuth Apps.
- Click Register a new application.
- Configure the following OAuth credentials for your Plane app:
- Homepage URL: The domain (with HTTPS) where you host Plane, e.g.,
https://app.plane.so
- Authorization Callback URL: Append the path users should be redirected to after authenticating with GitHub. Use
https://<plane.example.com>/auth/github/callback/
andhttps://<plane.example.com>/auth/mobile/github/callback/
where<plane.example.com>
is your self-hosted instance's domain.
- Homepage URL: The domain (with HTTPS) where you host Plane, e.g.,
- Click
Register application
to save it. - Find the app you just registered and copy the client ID and client secret for the next steps.
Configure Plane
- Go to
GitHub
on the Authentication screen of/god-mode
. - Add the client ID and client secret from the GitHub app you just registered.
- Click
Save
.
Your Plane instance should now support GitHub sign-in.