Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/cloudflare/cloudflare-os/llms.txt

Use this file to discover all available pages before exploring further.

The fastest way to get a production Cloudflare OS instance running is the online deploy wizard at os.cloudflare.app/deploy. In a few clicks it provisions all the Workers, Durable Objects, and R2 buckets your deployment needs and wires them together automatically — no manual wrangler deploy required.

​
What the wizard deploys

The wizard bundles and deploys four components into your Cloudflare account:

workshop-backend

The OS kernel — handles workspaces, agents, blueprints, and the Gadget sandbox.

workshop-frontend

The single-page UI served as Workers Assets, including the agent chat and Gadget viewer.

router

The public-facing Worker that routes /api/* to the backend and /gatekeeper/<name>/* to each installed gatekeeper.

gatekeepers

Any authentication or integration gatekeepers you enable during setup (GitHub, Google, Cloudflare, and more).
Each gatekeeper runs as its own separate Worker and is wired to the router and backend via Workers service bindings. Installing a new gatekeeper later is purely a binding change — you don’t need to redeploy the backend.

​
Prerequisites

Before you start the wizard, make sure you have:
  • A Cloudflare account (free tier is fine for personal use)
  • Permission to create Workers and Durable Objects in that account
  • For each OAuth gatekeeper you want to enable: a registered OAuth app with that provider (see Authentication for redirect URIs and setup guides)
Durable Objects require at least the Cloudflare Workers Paid plan ($5/month). If your account is on the free plan, Workers and KV will work but Durable Objects — which back every workspace, user, and Gadget — require an upgrade.

​
Running the deploy wizard

1

Open the deploy wizard

Navigate to os.cloudflare.app/deploy and sign in with the Cloudflare account you want to deploy into.
2

Choose your gatekeepers

Select which gatekeeper Workers to install. Each gatekeeper you enable will be deployed as its own Worker and bound to the router. You can install more gatekeepers later from the same wizard.
3

Enter OAuth credentials

For each OAuth-capable gatekeeper you enabled, paste its Client ID and Client Secret. The wizard stores these as encrypted Worker secrets — they never appear in your wrangler config files.
4

Deploy

Click Deploy. The wizard bundles the current release, creates all required Workers, KV namespaces, Durable Object namespaces, and R2 buckets, then sets every service binding. Deployment takes around 30–60 seconds.
5

Visit your instance

Once deployment completes, the wizard shows your instance URL. Open it, create an account, and you’re in.

​
Post-deploy configuration

After the wizard finishes, a few things are worth configuring immediately:
  1. Visit /admin — Sign in and go to /admin on your instance URL to open the admin panel. From here you can set a site name, upload a logo, write an announcement, and configure which gatekeepers are offered to users.
  2. Configure sign-up access — By default, signupsEnabled is true, meaning anyone who reaches your instance can create an account. If you want a closed deployment, toggle Allow new signups off in the admin panel, then manually create accounts for your team.
  3. Enable OAuth sign-in — If you deployed with GitHub, Google, or Cloudflare gatekeepers and want users to sign in with them (not just connect them after sign-in), add their vendor IDs to the AUTH_GATEKEEPERS environment variable on the backend Worker. See Authentication for details.
  4. Configure AI Gateway billing (optional) — If you want users to have a free daily AI allowance topped up by their own Cloudflare credits, set ENABLE_CLOUDFLARE_LIMITS=true along with the gateway variables. See AI Billing for the full configuration.

​
Customized deployments with cloudflare-os-starter

The deploy wizard is optimized for getting started quickly with the standard configuration. For more sophisticated deployments — custom branding baked into the build, code modifications, or scripted CI/CD — use the starter repository: github.com/cloudflare/cloudflare-os-starter The starter repo is a thin wrapper around the Cloudflare OS packages that gives you a place to commit your own wrangler configuration, gatekeeper selections, and any code customizations, while still tracking upstream releases as a dependency.

​
Deploying to self-hosted workerd

Coming soon. Cloudflare OS can run entirely on workerd, Cloudflare’s open-source Workers runtime, on your own servers. The “run locally” mode already uses workerd under the hood. Full self-hosted server documentation and tooling are under active development. If you’re feeling adventurous, see the low-level workerd config reference and the Run Locally guide as a starting point.

Build docs developers (and LLMs) love

Get started for freeTalk to us