Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

1.9 KB
Raw Blame
---
title: "Sign in with GitHub"
description: "Let people sign in to Kaneo with their GitHub account. For issue and pull request sync, see the GitHub integration."
---

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](https://github.com/settings/developers/). 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:

```text
https://kaneo.example.com/api/auth/callback/github
```

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](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app).

## Configure Kaneo

Add the values from the provider to your server's `.env`:

```env
GITHUB_OAUTH_CLIENT_ID=your-client-id
GITHUB_OAUTH_CLIENT_SECRET=your-client-secret
```

Apply the change to the bundled deployment:

```bash
docker compose up -d --force-recreate kaneo
```

## 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](/core/installation/environment-variables#access-control) before enforcing SSO-only access.