Skip to main content

Using private npm / yarn registries

  • Updated

Gatsby Cloud will respect any .yarnrc or .npmrc files included in your repository.

To avoid committing authorization token to your git repository you can use NPM_TOKEN and optionally NPM_REGISTRY environment variables:

  1. Navigate to the Site Settings page, then click on the Environment Variables tab
  2. Add a custom npm auth token by adding NPM_TOKEN as an environment variable.
  3. Set a custom registry by adding NPM_REGISTRY as an environment variable.

Keep in mind that we have separate variables for Builds and for CMS Preview - you will need set those environment variables for both.

Examples

Private packages hosted on the npm registry

Because NPM registry is default one, it's enough to define just the NPM_TOKEN environment variable in your site settings, you don't even need an .npmrc file.

NPM_TOKEN=your-token

Private packages hosted on Github Packages

You will need to declare package repository in .npmrc in root directory of your site - for GitHub Packages:

@OWNER:registry=https://npm.pkg.github.com

Then add NPM_TOKEN and NPM_REGISTRY environment variables

NPM_TOKEN=your-token
NPM_REGISTRY=https://npm.pkg.github.com

Related articles