Connect GitHub
A GitHub connection keeps GitHub as the source of truth. Each Service follows a branch, every new commit on it prepares an update, and the Project's auto-deploy setting decides whether that update deploys automatically or waits for you.
AI agent? Start with llms.txt.
Connect a GitHub repoHow it works
-
1
Under Add code, choose GitHub.
-
2
Connect GitHub. Install the GitHub App so your team keeps access, or choose Use your GitHub account if you can't install apps on the account that owns the repository.
-
3
Pick the repository. Choose the GitHub account or organization, then search for the repository. If it isn't listed, add it to the GitHub App on GitHub.
-
4
Tokay copies and analyzes it. Check the services we found and configure the one you want.
-
5
Deploy the first version. Choose Deploy after reviewing the detected Service. Future commits follow the Project's auto-deploy setting.
How the connection works
GitHub stays in control of your code. Tokay keeps a copy for builds and doesn't need write access, so you keep committing exactly where you do now. Each Service follows the branch you pick, and commits to other branches don't deploy it. You can also edit in Tokay, which opens a pull request for you to merge. If you ever disconnect, your running services stay up and the code Tokay has becomes hosted in Tokay, so you're never locked in.
A GitHub connected Service has the same live URL, logs, deployment history, and settings as a Service using Tokay hosted code.