Setting up CloudFlare as a Proxy (Orange Cloud)

First, ensure your domain is on CloudFlare and the “Proxy Status” is set to “Proxied” in your DNS Records. CloudFlare DNS settings The cloud icon should be orange.
If you need help adding a custom domain to GitBook, refer to the GitBook DNS configuration guide. Note that GitBook recommends not using CloudFlare as a proxy, but it’s required for our integration.

Configuration of CloudFlare

After setting up CloudFlare as a proxy, you’ll need to adjust settings. Choose between automatic or manual setup. This is the fastest and safest method using our auto-configuration tool.

Get API Key

  1. Visit CloudFlare API Tokens
  2. Click “Create Token”
  3. Click “Get started”
  4. Configure with these parameters:
Token Name: Anything
Permissions:
- Zone:Config Rules:Edit
- Zone:Zaraz:Edit and Publish
Zone Resources:
- Include:Specific zone:[your domain]
Client IP Address Filtering:
None
TTL:
Today -> Tomorrow
  1. Click “Create Token”
  2. Copy your token

Get Zone ID

  1. Visit CloudFlare Zones
  2. Click on your domain
  3. Copy the Zone ID

Configure with our tool

  1. Visit https://cms.cookbook.dev/cloudflare
  2. Enter your API Key and Zone ID
  3. Enter your desired subdomain/domain
  4. Click “Configure Cloudflare”

Manual Setup (Temporary not available!)

As of August 28, due to CloudFlare API changes, manual setup is temporarily unavailable. Please use the automatic setup method above.

Any troubles?

Contact us at tyler@cookbook.dev for help.