verdaccio
Advanced tools
Verdaccio is a lightweight private npm proxy registry that allows you to host your own npm registry and cache npm packages. It is useful for speeding up npm installs, working offline, and hosting private packages.
Private Registry
This configuration sets up Verdaccio as a private npm registry with authentication and proxying to the official npm registry.
const config = {
storage: './storage',
auth: {
htpasswd: {
file: './htpasswd'
}
},
uplinks: {
npmjs: {
url: 'https://registry.npmjs.org/'
}
},
packages: {
'@*/*': {
access: '$all',
publish: '$authenticated',
proxy: 'npmjs'
},
'**': {
access: '$all',
publish: '$authenticated',
proxy: 'npmjs'
}
}
};
module.exports = config;Caching
This configuration allows Verdaccio to cache packages from the official npm registry, speeding up subsequent installs.
const config = {
storage: './storage',
uplinks: {
npmjs: {
url: 'https://registry.npmjs.org/'
}
},
packages: {
'**': {
access: '$all',
proxy: 'npmjs'
}
}
};
module.exports = config;Offline Mode
This configuration sets up Verdaccio to work in offline mode, using only the locally cached packages.
const config = {
storage: './storage',
uplinks: {},
packages: {
'**': {
access: '$all'
}
}
};
module.exports = config;Sinopia is an older private npm registry server that allows you to host your own npm registry. It is similar to Verdaccio but is no longer actively maintained.
npm-registry-couchapp is a CouchDB-based npm registry implementation. It is more complex to set up compared to Verdaccio but offers more flexibility and scalability.
cnpm is a private npm registry and web for Enterprise, base on the official npm registry. It is designed for use within a company and offers features like syncing with the official npm registry.
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 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.
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
});
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.
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.
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.
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.
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.
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.
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:
View more in the YouTube channel.
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.
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
Available as tags.
docker pull verdaccio/verdaccio:5.x-next
To run the docker container:
docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio
Docker examples are available in this repository.
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.
npm install, npm upgrade, etc.) - supportednpm publish) - supportednpm unpublish) - supportednpm tag) - supportednpm deprecate) - supportednpm adduser {newuser}) - supportednpm profile set password) - supportednpm owner add {user} {pkg}) - not supported, PR-welcomenpm token) - supported (under flag)npm search) - supported (cli (/-/all and v1) / browser)npm ping) - supportednpm star, npm unstar, npm stars) - supportedIf you want to report a security vulnerability, please follow the steps which we have defined for you in our security policy.
| 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.
🤓 Don't be shy, add yourself to this readme.
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
Thank you to all our backers! 🙏 [Become a backer]
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.
This project exists thanks to all the people who contribute. [Contribute].
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.
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.
FAQs
A lightweight private npm proxy registry
The npm package verdaccio receives a total of 145,684 weekly downloads. As such, verdaccio popularity was classified as popular.
We found that verdaccio demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.