Verdaccio stands for peace, stop the war, we will be yellow / blue 🇺🇦 until that happens.

Version Next (Development Branch)

Version 6 requires Node.js 18 or higher and is maintained in the 6.x branch. Note that contributing guidelines might be different based on the branch.

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.

Versions

You can find more details about the different versions of Verdaccio, minimum requirements, as well as links to associated npm packages and docker images in the version history.

Install

Node.js v24 as minimum version required

Install with npm:

npm install -g verdaccio@next-9

With yarn

yarn global add verdaccio@next-9

With pnpm

pnpm i -g verdaccio@next-9

or

docker pull verdaccio/verdaccio:nightly-master

or with helm official chart.

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

Furthermore, you can read the Debugging Guidelines and the Docker Examples for more advanced development.

Plugins

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

npm install -g yo
npm install -g generator-verdaccio-plugin

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

End to End Testing

We test compatibility across different versions of npm, pnpm, and Yarn to ensure your favorite commands — from publishing packages to managing dependencies — work seamlessly with Verdaccio.

E2E CLI tests run in CI via the verdaccio-e2e tool on Node.js 24 against the following matrix:

| Package Manager | Versions | | --------------- | --------------- | | npm | 7, 8, 9, 10, 11 | | yarn classic | 1 | | yarn modern | 2, 3, 4 | | pnpm | 9, 10 |

Donations

Verdaccio is run by volunteers; nobody works on it full-time. If you find this project useful and would like to support its development, consider making a long-term support donation — your logo will be featured in this section of the README.

You can support the project via Donate 💵👍🏻 — starting from just $1/month, or with a one-time contribution.

Note: There is currently no funding available for contributions or security research.

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

Watch our Videos

Node 2022, February 2022, Online Free

<div> <a href="https://portal.gitnation.org/contents/five-ways-of-taking-advantage-of-verdaccio-your-private-and-proxy-nodejs-registry"> <img src="https://cdn.verdaccio.dev/readme/nodejscongress2022.jpg" alt="nodejs" width="200"/> </a> </div>

You might want to check out as well our previous talks:

• Using Docker and Verdaccio to make Integration Testing Easy - Docker All Hands #4 December - 2021
• Juan Picado – Testing the integrity of React components by publishing in a private registry - React Finland - 2021
• BeerJS Cba Meetup No. 53 May 2021 - Juan Picado
• Node.js Dependency Confusion Attacks - April 2021 - Juan Picado
• OpenJS World 2020 about *Cover your Projects with a Multi purpose Lightweight Node.js Registry - Juan Picado
• ViennaJS Meetup - Introduction to Verdaccio by Priscila Olivera and Juan Picado
• Open Source? trivago - Verdaccio (Ayush and Juan Picado) January 2020
• GitNation Open Source Stage - How we have built a Node.js Registry with React - Juan Picado December 2019
• Verdaccio - A lightweight Private Proxy Registry built in Node.js | Juan Picado at The Destro Dev Show

Get Started

Run in your terminal

verdaccio

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

npm set registry http://localhost:4873/

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

NPM_CONFIG_REGISTRY=http://localhost:4873 npm i

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

Warning: Verdaccio [does not currently support PM2's cluster mode](https://github.com/verdaccio/verdaccio/issues/1301#issuecomment-489302298