📦🔐 A lightweight Node.js private proxy registry
Verdaccio stands for peace, stop the war, we will be yellow / blue 🇺🇦 until that happens.
Version Next (Development branch)
Looking for Verdaccio 5 version? Check the branch
5.x
The plugins for thev5.x
that are hosted within this organization are located at theverdaccio/monorepo
repository, while for thenext
version are hosted on this project./packages/plugins
, keep on mindnext
plugins will eventually would be incompatible withv5.x
versions. 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.
Install
Latest Node.js v16 required
Install with npm:
npm install --location=global verdaccio@next
With yarn
yarn global add verdaccio@next
With pnpm
pnpm i -g verdaccio@next
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 --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, consider do a long support donation - and your logo will be on this section of the readme.
Donate 💵👍🏻 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:
Watch our Videos
Node Congress 2022, February 2022, Online Free
You might want to check out as well our previous talks:
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, running it with cluster mode may cause unknown behavior.
Publishing
npm adduser --registry http://localhost:4873
if you use HTTPS, add an appropriate CA information ("null" means get CA list from OS)
npm set ca null
npm publish --registry http://localhost:4873
This will prompt you for user credentials which will be saved on the verdaccio
server.
Below are the most commonly needed information, every aspect of Docker and verdaccio is documented separately
docker pull verdaccio/verdaccio:nightly-master
Available as tags.
Running verdaccio using DockerTo run the docker container:
docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio
Docker examples are available in this repository.
CompatibilityVerdaccio 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 featuresIf you want to report a security vulnerability, please follow the steps which we have defined for you in our security policy.
Special ThanksThanks to the following companies to help us to achieve our goals providing free open source licenses. Every company provides enough resources to move this project forward.
Company Logo License
JetBrains JetBrains provides licenses for products for active maintainers, renewable yearly
Crowdin Crowdin provides platform for translations
BrowserStack BrowserStack provides plan to run End to End testing for the UI
Netlify Netlify provides pro plan for website deployment
Algolia Algolia provides search services for the website
Docker Docker offers unlimited pulls and unlimited egress to any and all users
Maintainers
Juan Picado Ayush Sharma Sergio Hg
@jotadeveloper @ayusharma_ @sergiohgz
You can find and chat with then over Discord, click here or follow them at Twitter.
Who is using Verdaccio?
🤓 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]
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.
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.
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.