Core
PaaS v2.x
2

Access private packages #

Licensed Kuzzle JavaScript packages are distributed through the private package registry hosted by Kuzzle PaaS.

You can authenticate either with npm login or with Kourou.

Using npm login #

Use the npm login command with the @kuzzleio scope:

npm login --scope=@kuzzleio --registry=https://packages.paas.kuzzle.io --auth-type=legacy

Enter your username and password when prompted.

The command creates an .npmrc file in your home directory. This file contains the registry authentication information used by npm.

If your CI/CD pipeline needs the same access, copy or recreate the relevant .npmrc configuration in the project or CI secret store:

cp ~/.npmrc .npmrc

You can then install private packages:

npm install @kuzzleio/<kuzzle-plugin>

Using kourou paas:login #

The Kourou CLI is a command line tool that allows you to interact with a Kuzzle API. Through our dedicated command kourou paas:login you can login to our private registry.

Under the hood, this command creates an .npmrc file in your home directory.

kourou paas:login --help

USAGE
  $ kourou paas:login

OPTIONS
  --help               show CLI help
  --only_npm           Only perform the login on the private NPM registry
  --project=project    Current PaaS project
  --username=username  PaaS username

From this point, you can install any private package using npm install.

npm install @kuzzleio/<kuzzle-plugin>

See the official plugin list for available Kuzzle plugins.

What's next? #

Once private packages are available, you can use the public API or your CI/CD pipeline to deploy application versions.

Community #