Cloudflare Pages

You can use private Capawesome npm packages within your Cloudflare Pages deployments by configuring the Capawesome npm registry. This guide shows you how to set up authentication to access the private packages from the Capawesome Insiders program.

Preparation

Create a Cloudflare Pages Environment Variable

Get your license key and add it to your Cloudflare Pages project as an environment variable with the name CAPAWESOME_NPM_REGISTRY_TOKEN as described in Environment variables.

Keep your license key secure

Never commit your license key directly to your repository and always use environment variables to store sensitive information like authentication tokens.

Configuration

Configure the npm registry

Create a new file named .npmrc in the root of your project and add the following content:

@capawesome-team:registry=https://npm.registry.capawesome.io
//npm.registry.capawesome.io/:_authToken=${CAPAWESOME_NPM_REGISTRY_TOKEN}

This file will automatically configure npm to use the Capawesome registry for @capawesome-team packages during Cloudflare Pages builds.

Managing multiple environments

In the event that your local development no longer works with your new .npmrc file, you can create a separate .npmrc.pages file specifically for Cloudflare Pages. Just navigate to your Pages project > Settings > Environment variables, add a new environment variable named NPM_CONFIG_USERCONFIG and set its value to /opt/buildhome/repo/.npmrc.pages. If your .npmrc.pages file is not in your project's root directory, adjust this path accordingly.