Click “My Account” (or “Set Up My Account” if you’re accessing your account for the first time). Enter your contact information, the domain(s) on which you want to use Confection, and select one of our two data storage options. Then, click “Save Changes.”
If you need to create a Cloudflare account and/or add your domain, see this help document. Otherwise, log in to your Cloudflare account, and click "Workers."
If this is the first time you've accessed the "Workers" screen, you'll be asked to choose a subdomain and a plan. In most cases, unless your site gets more than 100,000 pageviews per day, the free plan should be sufficient. If you need a paid plan, set that up. Once that's done, proceed as follows.
From your account homepage, click "Workers" > "Overview" > "Create a Service." Change the default service name if you wish, select "HTTP handler," and click "Create a Service." On the next screen, click "Quick Edit." Paste this code in the code editor (left column):
Then, click "Save and Deploy," and click the service name (
cold-poetry-426b in the video) to return to the service management page.
Next, in your Confection dashboard, visit Install Confection >API Keys. Generate and copy your write key. This key will ensure only domains you've added to your dashboard can write data to your Confection account.
After copying your key, return to the settings page for the Worker you just created. Click "Settings" > "Variables" > "Add Variable." Enter
confection_key in the "Variable name" field. In the "Value" field, paste the write key you generated and copied earlier in this step. Next, to secure the key, click "Encrypt." Then, finally, click "Save and Deploy" to launch the write key variable.
Next, copy the complete Worker URL. (That's
https://cold-poetry-426b.confection--staging-testing-8236.workers.dev in the video.) You'll need this in the "Add Confection to Your Site" step.
At this point you have two options:
Option 1: "I want to use the default Cloudflare worker URL." (Recommended)
Click "Websites," and select the site on which you want to install Confection. Then, in the sidebar nav, click "Workers." On the Workers screen, click the "Add route" button. If you want to run Confection sitewide, your route will be
*.domain.com/*. Just replace
domain with your actual domain name. For more complex routing, see this help document.
Next, select the service you just created and then your preferred environment. (For most users, this will be "production.") Click "Save," and proceed to the "Add Confection to Your Site" section of this guide.
Option 2: "I'm using my own custom worker URL."
If you haven't already added the custom domain to your DNS record, click "Websites" to return to your Cloudflare account homepage. Select the site on which you want to run the Confection worker script and then "DNS." Add an A record for the route URL. Point to
192.0.2.1, and make sure "Proxy" is active. Then, click "Save."
Return to the worker service you created earlier in this step. Click "Workers" > you service's name > "Triggers" > "Add Route." Enter your custom URL here, and click "Add Route." If you don't have a lot of experience working with Cloudflare routes, see this help document.
A few notes for those new to Cloudflare workers and worker routes, especially those with more complex use cases.
100::vs. your actual IPv6 address.
example.com, you'd enter
*sub.example.com/path*in the route input field. (This is the field that reads
example.comin the previous screenshot.) Note
/pathis arbitrary. It could be anything (
First, use our code-builder tool to set your privacy options, choose your banner position, and even upload your own logo. Click the button below to get started.Get Your Custom Code
Make sure you add your complete, secure (ie.,
https:// included) route URL or custom domain/subdomain you created earlier in this step to the "Cable URL" field. (In the option one video, this is
https://cold-poetry-426b.confection--staging-testing-8236.workers.dev/) To avoid mixed content errors, make sure you load the route URL over
Once that's done, paste the custom code above your site's
Then, paste the following code anywhere between your site's
If character or line limits prevent this, host the script yourself. Copy this script, save it as a JS file (eg.,
confection.js), and upload it to a server you control. Then, add this above your site’s
https://domain.com/confection.js with the link to the file you just uploaded.
Lastly, add the route URL or custom domain/subdomain you created earlier in the "Create Worker" step to your account's list of authorized domains. (In the video, this is
cold-poetry-426b.confection--staging-testing-8236.workers.dev/) To find this list, click "My Account" inside your Confection account.
That's it. You're done.
Questions or comments about using Confection with Cloudflare? Leave them below.
You can also use the chat app in the lower right corner.