cloudflare_temp_email/vitepress-docs/docs/en/guide/quick-start.md

Quick Start

Before You Begin

[!IMPORTANT] A domain is required first This project relies on Cloudflare Email Routing to receive emails, so a domain is a hard prerequisite for deployment. You must already own a domain (apex or subdomain) hosted on Cloudflare DNS, with Email Routing enabled and the corresponding email DNS records provisioned. After the Worker is deployed, bind a Catch-all rule to that Worker. Without both steps, mail will not be received and verification flows will fail. See Cloudflare Email Routing for the full setup.

You need a good network environment and a Cloudflare account. Open the Cloudflare Dashboard

Please choose one of the three deployment methods below:

• Deploy via Command Line
• Deploy via User Interface
• Deploy via Github Actions

You can also refer to detailed tutorials provided by the community

• 【Tutorial】Beginner-Friendly Guide to Building Your Own Cloudflare Temporary Email (Domain Email)

Upgrade Process

First, confirm your current version, then visit the Release page and CHANGELOG page to find your current version.

[!WARNING] Warning Pay attention to Breaking Changes which require database SQL execution or configuration changes.

Then review all changes from your current version onwards. Note that Breaking Changes require database SQL execution or configuration changes, while other feature updates can be configured as needed.

Then refer to the documentation below to use CLI or UI to redeploy the worker and pages over the previous deployment.

CLI Deployment

• Update D1 via Command Line
• Deploy Worker via Command Line
• Deploy Pages via Command Line

UI Deployment

• Update D1 via User Interface
• Deploy Worker via User Interface
• Deploy Pages via User Interface

Github Actions Deployment

• How to Configure Auto-Update with Github Actions