Tokay documentation

Everything Tokay does, explained. Start with the promise and your first deploy, then go deeper as your app grows.

AI agent? Start with llms.txt.

Start here

• What is Tokay. The promise, the four service types, and what your account includes.
• Your first deploy. Paste code, get a live service. Start here with code in hand.
• Deploy from Git. Push to a Tokay hosted repo.
• Deploy from GitHub. Connect a GitHub repo and keep working there.
• Deploy with an AI agent. Hand the whole job to an agent, and why that's safe here.
• Which service type is my code? Web app, scheduled job, webhook, or worker.
• Supported languages and stacks. What Tokay detects and runs.

How Tokay works

• How Tokay is organized. Workspaces, projects, services, and code, and what shares what.
• How Tokay sets up your app. What's detected, what you review, and what stays predictable.
• Permissions. Who can reach what, and what each credential can do.
• Your server. The dedicated VM everything runs on.

Your services

• Web apps. URLs, HTTPS, zero downtime updates.
• Scheduled jobs. Plain language schedules, run history, failure alerts.
• Webhooks. Your URL, request logs, testing and replay.
• Background workers. Kept alive, restarted, swapped cleanly.

Working with your app

• Config, secrets, and environment variables. Inspectable Config, protected Secrets, and one runtime delivery model.
• Databases. Created when needed, queryable in the browser, exportable always.
• Database migrations. Rehearsed on a copy before production, with snapshots and approval for risky or uncertain changes under Normal release safety.
• Deploys, updates, and rollback. The pipeline, zero downtime cutover, one click restore.
• Files and persistent storage. What survives a deploy and how to keep uploads safe.
• Service files. Browse, download, upload, and rescue files without SSH.
• One-off tasks. Run a maintenance command in your app's own environment.
• Editing your code. Browser editing, git, and the one way door between them.
• Logs and debugging. Live logs, plain English errors, and reviewed change proposals.
• Projects and organization. Grouping, dashboards, deploy all, auto-deploy.
• Pause and resume. Stop a service without losing anything.
• Deleting and restoring. The 30-day trash.

Access and domains

• Who can open your app. Project and Service access, shared audiences, and the access log.
• Know who is signed in. Read the signed in visitor in your code, and link to sign out.
• Public endpoints. Keep a web app restricted while selected paths stay public.
• Machines and credentials. Give scripts and CI stable identities for protected apps.
• Custom domains. Your apps on your domain.

Account

• Workspaces and members. Teams, roles, invitations.
• SSH keys and git tokens. Credentials for pushing code.
• Security. The isolation model and everything else the security reviewer asks.

For AI agents

• Tokay MCP. Connect an AI agent to deploy, operate, and inspect apps through the official Tokay MCP.
• For AI agents. Credentials, the deploy loop, and what's stable to rely on. Written for your agent.
• Repository source for agents. List the files at the current commit and fetch one text file without cloning. Written for your agent.
• Files and one-off tasks for agents. SAVED vs CURRENT scopes, file tickets, live file rescue, and runServiceTask. Written for your agent.
• Operating and recovering services for agents. Logs, failure diagnosis, runs and test events, pause, rollback, and the trash. Written for your agent.
• Managed databases for agents. The query envelope, exports, credential rotation, and snapshots. Written for your agent.
• Releases and migration safety for agents. Rehearsal evidence, confirming parked releases, and the safety dial. Written for your agent.
• App access control for agents. Project and Service access, public paths, Tokay Access OAuth, and Machine credentials. Written for your agent.
• Identity and permissions for agents. Scoped Bot identities, Platform OAuth, grant actions, and reading denials. Written for your agent.

When something's wrong

• Troubleshooting. Symptom first fixes.

Can't find it? Email hello@tokay.io.