Skip to content

One-click install

Install cf-orbs with the Deploy to Cloudflare button. No Node, Docker, wrangler or terminal on your machine.

Updated

Deploy to Cloudflare

The button installs cf-orbs with no tools on your machine. Cloudflare clones the template repo into your GitHub or GitLab account, builds both container images with Workers Builds and deploys the Worker to your account. The provider then starts by itself.

Before you start

You need Where
A Cloudflare account on Workers Paid Dashboard → Workers & Pages → Plans
A workers.dev subdomain on that account. Most accounts have one, and the deploy needs it Dashboard → Workers & Pages
A GitHub or GitLab account The button makes a repo in it
An Amp provider token (aop_live_...) and its provider name Amp → Settings → Orbs → Add Provider

Install

  1. Click the button

    Use Deploy to Cloudflare at the top of this page. It opens the Cloudflare setup page.

  2. Fill in the setup page

    Setting What to pick
    Project name Any name. The Worker and its containers take it
    AMP_ORB_PROVIDER_TOKEN Your Amp provider token. It is the only secret the page asks for
    Enable Preview builds Off. This Worker gets no preview URL, so a branch build only uses build minutes
    Create private Git repository Your choice. The repo holds no secrets; they live on the Worker

    The page may say "No Wrangler configuration detected". That is expected: the config is at .cf-orbs/wrangler.jsonc and the deploy finds it. Leave the advanced settings as they are.

  3. Wait for the build

    The first build takes 10 to 15 min, plus 2 to 4 min in the queue. Watch it in Workers & Pages → your Worker → Deployments.

When the build finishes, the provider starts within 5 min and registers with Amp. There is nothing else to set up.

If you left the token empty, the Worker idles until you add AMP_ORB_PROVIDER_TOKEN in the dashboard (Worker → Settings → Variables and Secrets).

Try it

This command uses your Amp credits:

amp -ox "hello from cf-orbs" --orb-provider <name from Amp>

In the Amp app, pick the provider under Self-Hosted when you start a thread. The first orb on each Cloudflare host pulls the 1.8 GB orb image (40 to 50 s).

A second install

Click the button again and pick another project name. Each install is its own Worker with its own containers. Give each one its own Amp provider token: two providers must not share a token.

Changes and upgrades

Workers Builds redeploys your repo on every push to main. To change the orb image, edit image/Dockerfile and push. To rotate the Amp token, paste a new one in the dashboard (Worker → Settings → Variables and Secrets).

Add the CLI later

The install needs no CLI. Add it if you want status, logs, doctor or upgrade, or to change cf-orbs.config.jsonc (orb size, caps, prewarm). In a clone of the repo the button made:

npx wrangler login          # once, to the account you deployed to
npx cf-orbs init --no-deploy --adopt --name <your project name>

init --adopt makes the control token the CLI authenticates with, sets it as a Worker secret and writes .cf-orbs/state.json. Until then the Worker’s control API answers 404 to everyone. It also updates the generated files to the CLI’s version; commit and push them. It asks for the Amp token: press Enter to keep the one you set. It prints Workers Builds dashboard steps too; the button already did those.

Caveats

The button uses Workers Builds, so the Workers Builds caveats apply: no Docker layer cache, no prewarm after a build, the build token can deploy any Worker in the account, and awake orbs keep the old Worker code.

  • The template can lag the CLI. The button deploys what the template repo holds. init --adopt brings a clone up to the CLI’s current files.
  • The repo keeps the name cf-orbs-template in its config. The build writes your project name into .cf-orbs/wrangler.jsonc in its own checkout and commits nothing, because wrangler names the container applications from that file and not from the project name (workers-sdk#15827). init --adopt --name writes the name into your repo.

For build errors, see the Workers Builds troubleshooting table. To remove the install, disconnect the repo first (Settings → Builds → Disconnect), then see Uninstall.

Type to search…

↑↓ navigate↵ selectEsc close