Cortex-Publisher

Cortex Publisher is a cloudflare worker deployed leveraging Wrangler CLI inside a Github Actions pipeline. Visit the official docs for more information on Cloudflare Workers. For more information on the Cortex, what it does, and how to use it please visit the Cortex FAQ and Cortex Docs

Prerequisites

1. First you must have created a Cloudflare account, and purchased a domain for use with Cloudflare. You may do this through Cloudflare directly, or use external registrars such as Namecheap. If you have a Cloudflare account and domain you may proceed to adding the domain as a site to Cloudflare. This will populate the domain's Zone ID for use in later steps. For more information on how to setup your domain in Cloudflare please visit Add site to Cloudflare.

2. Create a Cloudflare API Token. For more information on how create and use API tokens for use in CI/CD please visit Create a Cloudflare API token.

3. Install the Wrangler CLI.

4. (Optional): Install the Github CLI.

Deployment

1. <---- Click Here

   • This will bring you to a web page requiring your Cloudflare account ID and API Token that you created from the previous step.
   • You will also be linked to the newly forked repository to enable Github Workflows. For more information on workflows pleas visit Github's About workflows.

   Note: This will run an initial workflow that will fail by design as you do not currently have the required environment variables populated for a clean deployment. Updates to come on this part of the deployment process in the future.

2. Create the following KV namespaces in your Cloudflare account.

   • RESOLVER
   • RESOLVER-PREVIEW
   • ZONES
   • ZONES-PREVIEW

   To create the KV namespaces, you must have Wrangler CLI installed then run the following commands in your console. Make sure to record the output ID's for each KV namespace as they are needed for use in a later step.

       wrangler kv:namespace create "RESOLVER"
       wrangler kv:namespace create "RESOLVER" --preview
       wrangler kv:namespace create "ZONE"
       wrangler kv:namespace create "ZONE" --preview
   

   Note: If you didn't capture the KV namespace ID's you can run the following command from your console to acquire them.

       wrangler kv:namespace list

3. Navigate to your newly forked repository to configure github actions with the following secrets. Visit the official Github docs on how to use Encrypted Secrets.

   • CLOUDFLARE_API_TOKEN: The API token associated to your Cloudflare account.
   • CLOUDFLARE_ACCOUNT_ID: The ID of your Cloudflare account.
   • CLOUDFLARE_ZONE_ID: The Zone ID of the domain you wish to target.
   • CLOUDFLARE_ROUTE_PATTERN: The pattern of the route you wish to use for your worker. Example: hello.example.come/*
   • RESOLVER_KV_ID: The ID of the RESOLVER KV you created in the previous step
   • RESOLVER_KV_PREVIEW_ID: The ID of the RESOLVER_PREVIEW KV you created in the previous step.
   • ZONES_KV_ID: The ID of the ZONES KV you create in the previous step.
   • ZONES_KV_PREVIEW_ID: The ID of the ZONES-PREVIEW KV you created in the previous.

   Note: You may also use the Github CLI to accomplish the same.

       gh secret set REPO_OWNER/REPO_NAME <__*CLOUDFLARE_API_TOKEN*__>
       gh secret set REPO_OWNER/REPO_NAME <__*CLOUDFLARE_ACCOUNT_ID*__>
       gh secret set REPO_OWNER/REPO_NAME <__*CLOUDFLARE_ZONE_ID*__>
       gh secret set REPO_OWNER/REPO_NAME <__*CLOUDFLARE_ROUTE_PATTERN*__>
       gh secret set REPO_OWNER/REPO_NAME <__*RESOLVER_KV_ID*__>
       gh secret set REPO_OWNER/REPO_NAME <__*RESOLVER_KV_PREVIEW_ID*__>
       gh secret set REPO_OWNER/REPO_NAME <__*ZONES_KV_ID*__>
       gh secret set REPO_OWNER/REPO_NAME <__*ZONES_KV_PREVIEW_ID*__>

4. Navigate to the initial failed workflow from deployment step 1 in Github Actions and click the "Re-run jobs" dropdown and "Re-run all jobs" selection. The Github workflow will re-run and deploy the cloudflare worker to your account.