@mastra/deployer-cloudflare

A Cloudflare Workers deployer for Mastra applications.

Features

• Deploy Mastra applications to Cloudflare Workers
• Configure custom domains and routes
• Support for worker namespaces
• Automatic environment variable configuration

Installation

1pnpm add @mastra/deployer-cloudflare

Usage

The Cloudflare deployer is used as part of the Mastra framework:

1import { Mastra } from '@mastra/core';
2import { CloudflareDeployer } from '@mastra/deployer-cloudflare';
3
4const deployer = new CloudflareDeployer({
5  scope: 'your-account-id',
6  projectName: 'your-project-name',
7  routes: [
8    {
9      pattern: 'example.com/*',
10      zone_name: 'example.com',
11      custom_domain: true,
12    },
13  ],
14  workerNamespace: 'your-namespace',
15  auth: {
16    apiToken: 'your-api-token',
17    apiEmail: 'your-email',
18  },
19});
20
21const mastra = new Mastra({
22  deployer,
23  // ... other Mastra configuration options
24});

Configuration

Constructor Options

• scope (required): Your Cloudflare account ID
• projectName: Name of your worker project
• routes: Array of route configurations for your worker
  • pattern: URL pattern to match
  • zone_name: Domain zone name
  • custom_domain: Whether to use a custom domain
• workerNamespace: Namespace for your worker
• auth: Cloudflare authentication details
  • apiToken: Your Cloudflare API token
  • apiEmail: Your Cloudflare account email

Environment Variables

The deployer will automatically load environment variables from:

• .env files in your project
• Environment variables passed through the Mastra configuration

Routes

Routes can be configured to direct traffic to your worker based on URL patterns and domains:

1const routes = [
2  {
3    pattern: 'api.example.com/*',
4    zone_name: 'example.com',
5    custom_domain: true,
6  },
7  {
8    pattern: 'example.com/api/*',
9    zone_name: 'example.com',
10  },
11];

Each route requires:

• pattern: URL pattern to match
• zone_name: Domain zone name
• custom_domain: (optional) Set to true to use a custom domain

Requirements

• Cloudflare account with Workers enabled
• API token with appropriate permissions
• Domain(s) configured in Cloudflare (for custom domains)