Connect GitHub

Deploy straight from a GitHub repository. Tokay mirrors your repo, redeploys when you push, and your code stays on GitHub the whole time.

Connect a GitHub repo

How it works

  1. 1

    Open New Service and choose Connect 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

    Hit Deploy. That's the last manual step. From here on, push to GitHub and Tokay redeploys on its own.

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.

Once it's live, a GitHub connected service behaves like any other. Same URL, same logs, same history.

Read the detailed GitHub reference in the docs