Deployment

PageZERO is built specifically for Cloudflare’s infrastructure, leveraging Cloudflare Workers for compute and Cloudflare D1 for database storage.

The deployment process involves setting up D1 databases and deploying your application as Cloudflare Workers. You can deploy manually or set up automated deployments through a GitHub Actions CI/CD pipeline.

Cloudflare setup

1. If you don’t have a Cloudflare account, create one at https://dash.cloudflare.com/sign-up.

2. Go to your project root directory

3. Login to Cloudflare through wrangler CLI:

   bunx wrangler login

4. Create production and preview database:

   bunx wrangler d1 create <project-name>-production
   bunx wrangler d1 create <project-name>-preview

5. Update wrangler.json with the returned project name, database names, and database_ids

6. Create Cloudflare Workers through initial deployment:

   bun run deploy:production
   bun run deploy:preview

7. Add the necessary secrets for your Cloudflare Workers:

   Open-source edition

   No secrets are needed for the open-source edition.

   Paid edition

   The following secrets are needed to successfully setup authentication, email delivery and payments services:

   bunx wrangler secret put OTP_SECRET --env=production
   bunx wrangler secret put OTP_SECRET --env=preview
   bunx wrangler secret put SESSION_COOKIE_SECRET --env=production
   bunx wrangler secret put SESSION_COOKIE_SECRET --env=preview
   bunx wrangler secret put RESEND_API_KEY --env=production
   bunx wrangler secret put RESEND_API_KEY --env=preview
   bunx wrangler secret put POLAR_WEBHOOK_SECRET --env=production
   bunx wrangler secret put POLAR_WEBHOOK_SECRET --env=preview
   bunx wrangler secret put CLOUDFLARE_TURNSTILE_SECRET_KEY --env=production
   bunx wrangler secret put CLOUDFLARE_TURNSTILE_SECRET_KEY --env=preview

   Additionally, set CLOUDFLARE_TURNSTILE_PUBLIC_KEY in wrangler.json under env.production.vars and env.preview.vars.

   Note

   • OTP_SECRET and SESSION_COOKIE_SECRET values can be generated with bun -e "console.log(require('crypto').randomBytes(32).toString('hex'))" command.
   • RESEND_API_KEY value can be obtained from your Resend account. Check E-mail documentation for more details.
   • POLAR_WEBHOOK_SECRET value can be obtained from your Polar account. Check Payments documentation for more details.
   • CLOUDFLARE_TURNSTILE_SECRET_KEY and CLOUDFLARE_TURNSTILE_PUBLIC_KEY values can be obtained from your Cloudflare account. Check Authentication documentation for more details.

   Get PowerUP Learn more

Manual

1. Perform initial Cloudflare setup first to create D1 databases and Cloudflare Workers.

2. Set the following environment variables in your project’s .env file:

   CLOUDFLARE_ACCOUNT_ID=<your-cloudflare-account-id>
   CLOUDFLARE_API_TOKEN=<your-cloudflare-api-token>

   Note

   CLOUDFLARE_ACCOUNT_ID value can be obtained through bunx wrangler whoami command.

   CLOUDFLARE_API_TOKEN value can be obtained through the Cloudflare dashboard under “Manage account / Account API Tokens”. You will need to create a new token there. The token will require the following permission: D1:Edit.

3. Perform Cloudflare D1 databases migrations:

   bun run db:migrate:preview
   bun run db:migrate:production

4. Perform Cloudflare Workers deployments:

   bun run deploy:preview
   bun run deploy:production

Automatic

Automatic deployment happens through the GitHub Actions CI/CD pipeline. Once the pipeline is set up, every merge to the main branch will automatically trigger deployment to Cloudflare Workers and a database migration for Cloudflare D1. Additionally, every PR will trigger a preview deployment, allowing you to access a specific version of your app for each PR.

Note

Steps below require GitHub CLI.

1. Perform initial Cloudflare setup first to create D1 databases and Cloudflare Workers.

2. Login through gh auth login

3. Create a GitHub repo for the project and push all changes

   gh repo create <project-name> --private --source=. --remote=origin --push

4. Add the following repository variables:

   gh variable set CLOUDFLARE_ACCOUNT_ID --body "<your-cloudflare-account-id>"

   Note

   CLOUDFLARE_ACCOUNT_ID value can be obtained through bunx wrangler whoami command.

5. Add the following repository secret:

   gh secret set CLOUDFLARE_API_TOKEN
   gh secret set CLOUDFLARE_API_TOKEN --app dependabot

   Note

   CLOUDFLARE_API_TOKEN value can be obtained through the Cloudflare dashboard under “Manage account / Account API Tokens”. You will need to create a new token there. The token will require the following permissions: D1:Edit, Workers Scripts:Edit.

   The secret for Dependabot needs to be set separately; otherwise, Dependabot PRs will not perform preview deployments.

Now you can test everything. Create a PR in your project’s GitHub repository. You should see an action in the “Actions” section being triggered. If the basic checks pass, the workflow will perform a preview deployment to Cloudflare Workers and run a database migration on your preview database. After deployment, a “View deployment” button should appear in your PR with a link to the preview deployment.

When you merge the PR to main, a production deployment will occur, and a database migration will be performed on your production database.