Verdaccio is a Node.js private and proxy registry. To install it, you need a few basic prerequisites.
Your favorite Node Package Manager
yarn(classic and berry).
We highly recommend to use the latest versions of Node Package Manager clients
> email@example.com | firstname.lastname@example.org | | email@example.com | firstname.lastname@example.org. Don't support
- A modern web browser to run the web interface. We actually support
Chrome, Firefox, Edge.
Verdaccio will support latest Node.js version according the Node.js Release Working Group recomendations.
Are you still using Verdaccio 4?. Check the migration guide.
Learn the basics before getting started, how to install, where is the location of the configuration file and more.
Installing the CLI
Before using Verdaccio in production, please read and be aware of the best practices.
Verdaccio must be installed globally using either of the following methods:
npm install --location=global verdaccio
yarn global add verdaccio
pnpm install -g verdaccio
Next major release (verdaccio 6 alpha)
Next major release is under development, byt can try it out already, either for testing purposes or helping to catch any possible bug, if you find something report it under the label 6.x bugs.
npm install --location=global verdaccio@6-next
or with the docker image
docker pull verdaccio/verdaccio:nightly-master
The docker image
verdaccio/verdaccio:nightly-masteris alinged with the latest commits in master branch, while the npmjs version has a longer release cycle. It is highly recommended don't use alpha versions for production.
Once it has been installed, you only need to execute the CLI command:
warn --- config file - /home/.config/verdaccio/config.yaml
warn --- http address - http://localhost:4873/ - verdaccio/5.0.0
For more information about the CLI, please read the cli section.
You can set the registry by using the following command.
npm set registry http://localhost:4873/
you can pass a
--registry flag when needed.
npm install --registry http://localhost:4873
define in your
publishConfig in your
For alternative configurations, please read the Using a private registry section.
Create Your Own Private NPM Package Tutorial
If you'd like a broader explanation, don't miss the tutorial created by thedevlife on how to Create Your Own Private NPM Package using Verdaccio.
docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio
Verdaccio has an official docker image you can use, and in most cases, the default configuration is good enough. For more information about how to install the official image, read the docker section, furthermore you can learn more about combining Docker images in our docker-examples repository.
$ helm repo add verdaccio https://charts.verdaccio.org
$ helm repo update
$ helm install verdaccio/verdaccio
Verdaccio is also available as a 1-click install on Cloudron
Heroku with Docker
For easy deployment you could use Heroku, the free dyno tier allows you to test their platform using a Docker container, check this example.