Create a GitHub App

A self-hosted Kaneo instance uses a GitHub App for repository sync. Create the app once, install it on the repositories you need, then connect each Kaneo project. GitHub sign-in is a separate feature. Use the GitHub sign-in guide for that setup.

​

1. Register the app

Open GitHub Developer Settings and choose New GitHub App. Keep webhooks active. GitHub must be able to reach the endpoint without signing in to your reverse proxy. Use your actual public API origin if you host it separately.

​

2. Set permissions and events

Use these repository permissions: Subscribe to Issues, Issue comments, Pull requests, and Push. If you later change the app’s permissions, approve the updated permissions on its installation too. Create the app. GitHub’s app registration guide explains the remaining platform settings.

​

3. Save the credentials

On the app’s settings page, record its App ID and app slug. Generate and download a private key from Private keys. Keep the webhook secret you chose earlier. Kaneo’s repository integration needs the App ID, private key, and webhook secret. It does not use the app’s OAuth Client ID or Client Secret for repository access.

​

4. Install on your repositories

Choose Install App, select your GitHub account or organization, and select the repositories to connect. You can change that selection later under GitHub App installations. An organization may require an owner to approve the installation or permission changes. Finish that approval before verifying access in Kaneo.

​

5. Connect Kaneo

Follow Connect a GitHub repository to add the instance credentials, connect a project, and import issues. Tasks and issues can sync in both directions. Branch and pull-request activity can move tasks according to your workflow mappings; check those mappings against your project’s actual columns. If verification or sync fails, check GitHub troubleshooting.