GitHub App Setup
Kuayle uses a GitHub App for repository access and webhook delivery. Public instances can use the generated webhook URL; private instances need a relay or tunnel.
Publicly reachable instance
Settings → GitHub starts GitHub’s App Manifest flow with callback, permission and webhook values generated from your instance URL. After GitHub returns the manifest code, Kuayle stores the App credentials encrypted.
- Go to Settings → GitHub in your workspace
- Click "Set up GitHub App"
- Authorize on GitHub — pre-filled manifest
- Webhook URL generated from the configured instance URL
- Click "Install on GitHub" to grant repo access
Private network support
GitHub must reach `/api/github/webhook` to deliver branch, push and pull-request events. For private instances, run a smee.io relay or expose the webhook endpoint through a controlled tunnel such as cloudflared or ngrok.
- smee.io — third-party webhook relay
- cloudflared or ngrok — public tunnel to the webhook endpoint
- Without webhook delivery, GitHub events and status transitions are not processed
What the integration does
Kuayle scans branch names, pull-request titles and bodies, and commit messages for issue identifiers. Supported webhook events can record activity and move matched issues according to enabled automation rules.
- Auto-links PRs, branches, and commits via issue key matching
- Configurable auto-transitions based on GitHub events
- Webhook signature verification before processing
- Linked activity displayed in the issue detail view
Review Kuayle before you deploy it
Inspect the Apache 2.0 source, then follow the Docker Compose guide to run an instance on your infrastructure.