Skip to main content
This sets up sign-in for your instance. It does not connect a repository or send project notifications.

​
Register the application

Open the GitHub developer console. Create an OAuth App. Set its homepage to your Kaneo URL and its authorization callback URL to the address below. For a bundled Kaneo deployment at https://kaneo.example.com, the callback is:
Use your own hostname. If the API is hosted separately, use its public origin instead. The callback path is /api/auth/callback/github; do not append a second /api when your API URL already includes it. For provider-specific options, see the official OAuth guide.

​
Configure Kaneo

Add the values from the provider to your server’s .env:
Apply the change to the bundled deployment:

​
Test sign-in

Open Kaneo in a private browser window and choose the GitHub sign-in option. Complete authorization and confirm you return to Kaneo. If the provider reports a redirect mismatch, compare the full URL, including the scheme, hostname, port, and path. If sign-in succeeds but joining a workspace fails, check the invitation email and instance registration settings.

​
Turn it off

Remove the two environment variables and recreate Kaneo. Make sure people have another way to sign in before disabling the provider. Review access settings before enforcing SSO-only access.