Installing Enterprise plugins

EnterpriseThis is available with an Enterprise plan. 5.57.0This feature requires Strapi version 5.57.0 or later.

Page summary:

Enterprise plugins are distributed from the Strapi package registry to the licenses that include them. The strapi enterprise install command finds your license, sets up access to the registry, and installs a version compatible with your Strapi application.

Enterprise plugins are not published on the public npm registry. They are installed like any other dependency, and the Strapi package registry only serves the plugins your Strapi license includes. The strapi enterprise install command sets up the registry for you, so package manager configuration files don't need to be edited by hand.

Prerequisites

• A Strapi 5.57.0 or later application, with its dependencies installed.
• A license for the CMS Enterprise plan. The license key is available in the Strapi billing portal.
• npm, pnpm, or Yarn (1 or 2 and later).

Installing a plugin

To install Enterprise plugins, run the strapi enterprise install command from the root folder of your Strapi application:

• Without any argument, the command lists the Enterprise plugins your license includes, so you can choose which ones to install or upgrade.
• When passing one or more plugin name(s) as arguments, the command installs them directly. The @strapi-enterprise/ prefix is optional.

Yarn

Listing available plugins to install or upgrade:

terminal

yarn strapi enterprise install

Installing plugins by name:

terminal

yarn strapi enterprise install plugin-byok

NPM

Listing available plugins to install or upgrade:

terminal

npm run strapi enterprise install

Installing plugins by name:

terminal

npm run strapi enterprise install plugin-byok

pnpm

Listing available plugins to install or upgrade:

terminal

pnpm strapi enterprise install

Installing plugins by name:

terminal

pnpm strapi enterprise install plugin-byok

Setting up access manually

The command is optional. To set up access yourself, add these lines to your user-level configuration file, with your license in place of <your license>:

npm, pnpm, Yarn 1 (~/.npmrc)

~/.npmrc

@strapi-enterprise:registry=https://packages.strapi.io/
//packages.strapi.io/:_authToken=<your license>

Yarn 2 and later (~/.yarnrc.yml)

~/.yarnrc.yml

npmScopes:
  strapi-enterprise:
    npmRegistryServer: 'https://packages.strapi.io/'
    npmAlwaysAuth: true
    npmAuthToken: '<your license>'

If the file already has an npmScopes key, add the strapi-enterprise entry under it.

The file now holds your license, so restrict it to your user with chmod 600 ~/.npmrc. Then install the plugin with your package manager, saving the exact version: npm install --save-exact @strapi-enterprise/<plugin-name>.

Troubleshooting

Message	What to do
No Strapi license found…	Set STRAPI_LICENSE, or run the command in a terminal to paste the license.
This Strapi license is not valid…	Copy the whole license again from the billing portal.
This Strapi license expired on…	Renew your license.
…rejected this Strapi license…	Check that the license is still active in the billing portal.
Your license does not include…	Check the plugin name. If the name is correct, contact your account manager.
No Enterprise package named…	Check the plugin name.
… has no version or tag …	Check the version you added to the plugin name.
… requires Strapi … and this app uses …	Upgrade Strapi first.
Could not reach https://packages.strapi.io…	Check your network connection, proxy, and firewall.
Could not tell which package manager this app uses…	Install your application's dependencies first, or set packageManager in package.json.
… already sets up packages.strapi.io with another license…	Replace those lines with the ones in the message.
… sets another license for packages.strapi.io and takes precedence…	Update or remove that line in the named file.
… could not be updated automatically…	Add the lines from the message to the named file, then run the command again.
Could not search packages.strapi.io…	Try again later, or pass the plugin name.
Pass package names, or run the command in an interactive terminal.	Run the command in a terminal, or pass the plugin names, as in CI.
Installing dependencies fails with a 401 or 404 error	See Setting up access manually.