Getting Started
Follow these four steps for a new site. For an existing site, use the update guide. The workflow is named 00 Deploy Worker in newer versions and Deploy Worker in older ones.
1. Prepare Cloudflare
Follow Create a Cloudflare API Token to obtain a token and Account ID. Enable R2 in Cloudflare if you want file uploads.
2. Fork and Add Secrets
Fork the EdgeChat repository to your GitHub account.
Open your fork's Settings → Secrets and variables → Actions → Secrets, click New repository secret, and add:
| Name | Value |
|---|---|
CLOUDFLARE_API_TOKEN | The Cloudflare API token you created |
CLOUDFLARE_ACCOUNT_ID | Account ID of the deployment account |
EDGECHAT_ADMIN_USERNAME | Your initial administrator username |
EDGECHAT_ADMIN_PASSWORD | Your own strong administrator password |
There is no default administrator password. Optionally set EDGECHAT_ADMIN_DISPLAY_NAME; it defaults to the username.
3. Deploy
- Open
Actionsand enable workflows for the fork. - Select
00 Deploy Worker → Run workflow. - Select the default branch, leave both encryption options unchecked, and start the run.
- Wait for every step to succeed, then find the site URL in the deployment log.
The workflow tests and builds the application, reuses or creates resources, initializes or migrates D1, creates the administrator, and deploys the Worker. Encryption keys are generated on first deployment and preserved afterward. See GitHub Actions Deployment for the workflow details.
4. Sign In and Check
- Open the site and sign in with your administrator credentials.
- Open registration invitations to create users or invitation links.
- Test messages between two users; test file uploads if R2 is enabled.
- Run a self-check under Installation & Maintenance.
Text chat works without R2. Enable R2 and rerun deployment to add attachment support.
Next Steps
- Site Configuration: message retention and other settings outside the admin panel.
- Automatic Updates: sync upstream releases and deploy them.
- Telegram Bridge: connect a Telegram group.
- Administrator Setup and Recovery: missing initial credentials, manual setup, and recovery.
Token instructions now have a separate guide. Manual first-login steps are in Administrator Setup.