Connect GitHub

A GitHub connection keeps GitHub as the source of truth while Tokay mirrors one branch for deployment. Every new commit on that branch prepares an update, and the Project's auto-deploy setting decides whether it deploys automatically or waits for you.

AI agent? Start with llms.txt.

Connect a GitHub repo

How it works

  1. 1

    Under Add code, choose GitHub.

  2. 2

    Authorize Tokay. Install the GitHub App for durable access that's built for teams, or use personal GitHub access if you can't install apps on the repo.

  3. 3

    Pick the repository. Choose it from the list, or type owner/repo if it isn't shown.

  4. 4

    Tokay mirrors and analyzes it. Check the services we found and configure the one you want.

  5. 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 mirror for builds and doesn't need write access, so you keep committing exactly where you do now. We follow the branch you pick, and commits to other branches don't deploy. If you ever disconnect, your running services stay up and the latest mirror becomes a Tokay hosted repo, 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.

Read the detailed GitHub reference in the docs