Skip to content

Document Cloudflare Pages DNS and 1Password deploy credentials #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sean Future (seanfuture) wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −2
Open

Document Cloudflare Pages DNS and 1Password deploy credentials #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions DEPLOY_CLOUDFLARE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ cd ~/Home/Enterprise/enterprise
pnpm publish:api-docs
```

Requires `CLOUDFLARE_API_TOKEN` and `CLOUDFLARE_ACCOUNT_ID` in the environment
(same credentials as the public site CI).
Requires Cloudflare credentials from **1Password** (Engineering → **Cloudflare API Token**),
via `modules/setup-1p.json`, or `CLOUDFLARE_API_TOKEN` / `CLOUDFLARE_ACCOUNT_ID` in the environment.

Options:

Expand Down Expand Up @@ -73,6 +73,21 @@ npm run check-config # validate scalar.config.json
| https://developers.enterprisecrm.com | **Cloudflare Pages** | Production |
| https://enterprise-api-docs-9s9.pages.dev | Cloudflare Pages | Deploy preview URL |

### Custom domain DNS (required)

`developers.enterprisecrm.com` must CNAME to the Pages project — **not** Netlify.

| Setting | Value |
| ------- | ----- |
| Type | `CNAME` |
| Name | `developers` |
| Target | `enterprise-api-docs-9s9.pages.dev` |
| Proxy | Proxied (orange cloud) |

If the CNAME still points at `enterprise-api-docs.netlify.app` while Cloudflare proxy is enabled, the dashboard shows **SSL cipher mismatch** / **522** errors because the edge connects to the wrong origin.

After updating DNS, wait for the Pages custom domain to reach **Active** (hostname + certificate validation) in **Workers & Pages → enterprise-api-docs → Custom domains**.

## GitHub Actions

`.github/workflows/deploy-cloudflare-pages.yml` deploys to Cloudflare Pages on pushes to `main` that touch docs/assets/scripts.
Expand Down