Configure Cloudflare on Zephyr
Originally launched as an email spam tracker, Cloudflare today offers extensive capabilities for users to register, manage domains as a registrar, and monitor, secure, and configure an entire IT infrastructure.
In this guide, we'll walk you through configuring Cloudflare as your default cloud provider for deploying and versioning applications with Zephyr Cloud. This setup leverages Cloudflare's global edge network, KV namespaces, Workers, and Pages to deliver your content at the edge.
Prerequisites
- A registered Cloudflare account
- A domain registered on Cloudflare, or a domain whose DNS can be managed by Cloudflare
- A registered Zephyr Account
Configure and Enable Cloudflare
Log in to the Zephyr Dashboard
After signing in, select your organization.
Locate Cloudflare under Deployment Integration
- Select Settings from the top navigation tabs.
- On the left sidebar, select Deployment Integration.
- Choose Available to find Cloudflare, then click on Add integration.
Retrieve Credentials and Configure Cloudflare
Before proceeding, you will need two details and one DNS configuration from Cloudflare:
1. Zone ID
- On your domain’s Overview tab, scroll down to the API section on the right sidebar.
- Find the Zone ID in this section.
2. API Token
- Near Zone ID and Account ID, right-click on Get your API token to open it in a new tab.
- Scroll to the bottom and select Create Custom Token by clicking on "Get started."
- Give your API token a meaningful name (e.g., the purpose or creator).
- Configure the required Permissions:
| Resource | Resource Type | Permission |
|---|---|---|
| Account | Worker KV Storage | Edit |
| Account | Worker Scripts | Edit |
| Account | Cloudflare Pages | Edit |
| Zone | Worker Routes | Edit |
-
Zone Resources: When prompted, include a Specific zone under your domain.
-
Leave other configurations (e.g., Account resources, Client IP Address Filtering) as defaults.
-
Scroll to the bottom and select Continue to summary to review your configurations, then Create Token. The token will display on the next page.
3. Configure Your DNS Record
- Return to your domain’s home page (the Overview page should still be open) and click on DNS on the left sidebar.
- Click Add record on the Records page and enter the following details:
Click to view DNS record details
| Type | Name | Content | Proxy Status | TTL |
|---|---|---|---|---|
| CNAME | * | ze.zephyrcloud.app | Proxied | Auto |
Configuration Inputs
Details for each input after clicking Add Integration under Cloudflare:
Obtainable from Cloudflare. See instructions for creating your API token.
This operation is idempotent and will create a Cloudflare Pages project. This field will become the name of your Cloudflare Pages project.
When set as default, all Zephyr deployments will use this integration until a new one (default integration) is set.
Testing It
Visit our recipes to test an application. Your next deployment should use your designated domain! (If not, contact us).
When using our managed cloud (Cloudflare) or custom Cloudflare integration, avoid including capital letters in names for package.json, module federation configuration, or assets to prevent issues with Cloudflare queries.
What Will Be Created on Your Cloudflare Account?
When Cloudflare is added as your provider on Zephyr, these properties will be created on your Cloudflare account:
- KV Namespaces
Three namespaces will be added:
- ze_snapshots
- ze_files
- ze_env
- Workers
ze-worker-for-static-upload(for uploading and serving assets)
- Worker Routes
ze.<domain.com>/*on workerze-worker-for-static-upload*-ze.<domain.com>/*on workerze-worker-for-static-upload
Deployment and Inspecting Assets
Once your first Cloudflare deployment is complete, you can inspect assets.
In your Cloudflare dashboard, navigate to Workers & Pages and then KV to view assets under ze_files.
ze_files: stores your actual assets.ze_envs: stores application environment and access rights.ze_snapshot: stores application snapshots compared against the previous build.- If deploying an application previously on our managed cloud, run
rm -rf ~/.zephyrbefore deployment. - If you encounter issues deploying Micro-frontend applications, see our Micro-frontend deployment guide.
Clean Uninstall and Reset
- Zephyr Cloud does not manage deletion of API tokens or any Cloudflare account properties.
- Assets and information on your Cloudflare account are immutable by default. During a clean uninstall, previously deployed assets and information are unrecoverable.
To delete an existing Cloudflare integration, follow these steps:
Delete Workers & Pages Projects
-
Sign in to Cloudflare. In the navigation bar, select Workers & Pages.
-
Click on ze-worker-for-static-upload, select Manage, then click Delete.
-
Return to Workers & Pages and locate these two properties:
- Cloudflare integration name: created under Cloudflare Project Name on the Zephyr dashboard.
- ze-worker-for-static-upload: created by Zephyr when integration was added.
Select both projects, choose Manage, and click Delete.
Delete KV Namespace
-
In Workers & Pages, select KV.
-
Locate and delete the following namespaces:
- ze_envs
- ze_snapshots
- ze_files
Delete Worker Routes
-
On the dashboard, select the domain used for Deployment integration.
-
Choose Workers Routes in the navigation bar. Locate routes with
zeand*-zeprefixes, then select Edit and Remove.
Delete Deployment Integration
-
Log into Zephyr, select the organization with the integration to delete.
-
Go to Settings in the organization dashboard, choose Deployment Integration.
-
Select the integration name and click Remove.