Skip to content

GitHub Actions Deployment

API Token Creation

  1. create a token using a template.

  2. Configure the required permissions.

  3. Copy the generated API token.

  4. Copy the Cloudflare account ID.

Environment Setup

  1. Fork the repository: https://github.com/maillab/cloud-mail

  2. Configure GitHub Actions secrets.

Secret NameRequiredDescription
CLOUDFLARE_API_TOKENCloudflare API token
CLOUDFLARE_ACCOUNT_IDCloudflare account ID
CUSTOM_DOMAINWorker custom domain, e.g., skymail.ink
DOMAINEmail domains, e.g., ["example.com", "example2.com"]
ADMINAdministrator email address, e.g., admin@example.com
JWT_SECRETJWT secret key (any random string, do not use special characters)
NAMEWorker project name (optional)
D1_DATABASE_IDD1 database ID (optional)
KV_NAMESPACE_IDKV namespace ID (optional)

Deployment

  1. Run the GitHub Actions workflow.

  2. Wait for the workflow to complete.

Configure Email Forwarding

  1. Refer to the Dashboard deployment steps: Configure Email Forwarding

  2. Open the custom domain in a browser and create an admin account to log in.