Version 5

Verdaccio is a simple, zero-config-required local private npm registry. No need for an entire database just to get started! Verdaccio comes out of the box with its own tiny database, and the ability to proxy other registries (eg. npmjs.org), caching the downloaded modules along the way. For those looking to extend their storage capabilities, Verdaccio supports various community-made plugins to hook into services such as Amazon's s3, Google Cloud Storage or create your own plugin.

Install

Install with npm:

npm install --location=global verdaccio

Node.js v12 or higher is required for Verdaccio 5

or pull Docker official image

docker pull verdaccio/verdaccio

and run

docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio

or with helm official chart.

helm repo add verdaccio https://charts.verdaccio.org
helm repo update
helm install verdaccio/verdaccio

Are you still using Verdaccio 4?. Check the migration guide from 4.x to 5.x.

Programmatic API

Verdaccio can be used as a module for launch a server programmatically, you can find more info at the website.

 const {runServer} = require('verdaccio');
 const app = await runServer(); // default configuration
 const app = await runServer('./config/config.yaml');
 const app = await runServer({ configuration });
 app.listen(4873, (event) => {
   // do something
 });

Verdaccio 6 next

Verdaccio 6 is on the way, meanwhile is ready you can start testing (not for production) the new release with:

Latest Node.js v16 required

Install with npm:

npm install --location=global verdaccio@6-next

or

docker pull verdaccio/verdaccio:nightly-master

The migration notes can be find here.

Plugins

You can develop your own plugins with the verdaccio generator. Installing Yeoman is required.

npm install --location=global yo
npm install --location=global generator-verdaccio-plugin

Learn more here how to develop plugins. Share your plugins with the community.

Donations

Verdaccio is run by volunteers; nobody is working full-time on it. If you find this project to be useful and would like to support its development and maintenance.

You can donate GitHub Sponsors or Open Collective 💵👍🏻 starting from $1/month or just one single contribution.

What does Verdaccio do for me?

Use private packages

If you want to use all benefits of npm package system in your company without sending all code to the public, and use your private packages just as easy as public ones.

Cache npmjs.org registry

If you have more than one server you want to install packages on, you might want to use this to decrease latency (presumably "slow" npmjs.org will be connected to only once per package/version) and provide limited failover (if npmjs.org is down, we might still find something useful in the cache) or avoid issues like How one developer just broke Node, Babel and thousands of projects in 11 lines of JavaScript, Many packages suddenly disappeared or Registry returns 404 for a package I have installed before.

Link multiple registries

If you use multiples registries in your organization and need to fetch packages from multiple sources in one single project you might take advance of the uplinks feature with Verdaccio, chaining multiple registries and fetching from one single endpoint.

Override public packages

If you want to use a modified version of some 3rd-party package (for example, you found a bug, but maintainer didn't accept pull request yet), you can publish your version locally under the same name. See in detail here.

E2E Testing

Verdaccio has proved to be a lightweight registry that can be booted in a couple of seconds, fast enough for any CI. Many open source projects use verdaccio for end to end testing, to mention some examples, create-react-app, mozilla neutrino, pnpm, storybook, babel.js, angular-cli or docusaurus. You can read more in here.

Furthermore, here few examples how to start:

• e2e-ci-example-gh-actions
• verdaccio-end-to-end-tests
• verdaccio-fork

Talks

• NodeTLV 20222 - Deep dive into Verdaccio, a lightweight Node.js registry - Juan Picado
• Five Ways of Taking Advantage of Verdaccio, Your Private and Proxy Node.js Registry Node Congress 2022 - Juan Picado
• Using Docker and Verdaccio to make Integration Testing Easy - Docker All Hands #4 December - 2021 - Juan Picado

View more in the YouTube channel.

Get Started

Run in your terminal

verdaccio

You would need set some npm configuration, this is optional.

$ npm set registry https://localhost:4873/

For one-off commands or to avoid setting the registry globally:

NPM_CONFIG_REGISTRY=https://localhost:4873 npm i

Now you can navigate to https://localhost:4873/ where your local packages will be listed and can be searched.

Warning: Verdaccio does not currently support PM2's cluster mode, running it with cluster mode may cause unknown behavior.

Publishing

1. create a user and log in

npm adduser --registry https://localhost:4873

if you use HTTPS, add an appropriate CA information ("null" means get CA list from OS)

$ npm set ca null

2. publish your package

npm publish --registry https://localhost:4873

This will prompt you for user credentials which will be saved on the verdaccio server.

Docker

Below are the most commonly needed information, every aspect of Docker and verdaccio is documented separately

docker pull verdaccio/verdaccio

Available as tags.

docker pull verdaccio/verdaccio:5.x-next

Running verdaccio using Docker

To run the docker container:

docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio

Docker examples are available in this repository.

Compatibility

Verdaccio aims to support all features of a standard npm client that make sense to support in private repository. Unfortunately, it isn't always possible.

Basic features

• Installing packages (npm install, npm upgrade, etc.) - supported
• Publishing packages (npm publish) - supported

Advanced package control

• Unpublishing packages (npm unpublish) - supported
• Tagging (npm tag) - supported
• Deprecation (npm deprecate) - supported

User management

• Registering new users (npm adduser {newuser}) - supported
• Change password (npm profile set password) - supported
• Transferring ownership (npm owner add {user} {pkg}) - not supported, PR-welcome
• Token (npm token) - supported (under flag)

Miscellany

• Search (npm search) - supported (cli (/-/all and v1) / browser)
• Ping (npm ping) - supported
• Starring (npm star, npm unstar, npm stars) - supported

Security

• npm/yarn audit - supported

Report a vulnerability

If you want to report a security vulnerability, please follow the steps which we have defined for you in our security policy.

Contributors

Juan Picado	Ayush Sharma	Sergio Hg
@jotadeveloper	@ayusharma_	@sergiohgz
Priscila Oliveria	Daniel Ruf
@priscilawebdev	@DanielRufde

See the full list of contributors is at the website.

Who is using Verdaccio?

• create-react-app (+96.2k ⭐️)
• Gatsby (+53.5k ⭐️)
• Babel.js (+41.3k ⭐️)
• Docusaurus (+37k ⭐️)
• Vue CLI (+29.4k ⭐️)
• Angular CLI (+25.6k ⭐️)
• Uppy (+25.8k ⭐️)
• pnpm (+19.2k ⭐️)
• bit (+15k ⭐️)
• NX (+14.1k ⭐️)
• Aurelia Framework (+11.6k ⭐️)
• ethereum/web3.js (+9.8k ⭐️)
• webiny-js (+5.9k ⭐️)
• workshopper how to npm (+1k ⭐️)
• Amazon SDK v3
• Amazon Encryption SDK for Javascript

🤓 Don't be shy, add yourself to this readme.

Open Collective Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Open Collective Backers

Thank you to all our backers! 🙏 [Become a backer]

Special Thanks

Thanks to the following companies to help us to achieve our goals providing free open source licenses.

Verdaccio also is part of to the Docker Open Source Program.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

FAQ / Contact / Troubleshoot

If you have any issue you can try the following options, do no desist to ask or check our issues database, perhaps someone has asked already what you are looking for.

• Blog
• Donations
• Reporting an issue
• Running discussions
• Chat
• Logos
• Docker Examples
• FAQ

License

Verdaccio is MIT licensed

The Verdaccio documentation and logos (excluding /thanks, e.g., .md, .png, .sketch) files within the /assets folder) is Creative Commons licensed.