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 fork of sinopia. It aims to keep backwards compatibility with sinopia, while keeping up with npm changes.
It allows you to have a local npm private registry with zero configuration. You don't have to install and replicate an entire database. Verdaccio keeps its own small database and, if a package doesn't exist there, it asks any other registry (npmjs.org) for it keeping only those packages you use.
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.
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 each of these use cases.
npm or yarnInstallation and starting (application will create default config in config.yaml you can edit later)
npm install --global verdaccio
Run in your terminal
verdaccio
After npm 5.2 you can use npx which install and launch verdaccio with the same command
npx verdaccio
You would need set some npm configuration, this is optional.
$ npm set registry http://localhost:4873/
# if you use HTTPS, add an appropriate CA information
# ("null" means get CA list from OS)
$ npm set ca null
Now you can navigate to http://localhost:4873/ where your local packages will be listed and can be searched.
If you are an adventurous developer you can use and install the latest beta version, this is a non stable version, I'd recommend only use for testing purporses.
$ npm install -g verdaccio@beta
npm adduser --registry http://localhost:4873
npm publish --registry http://localhost:4873
This will prompt you for user credentials which will be saved on the verdaccio server.
When you start a server, it auto-creates a config file. For instructions on how to run Verdaccio as a service, with a nice URL or behind a proxy have a look at the server-side configure document.
Below are the most commony needed informations, every aspect of Docker and verdaccio is documented separately
To pull the latest pre-built docker image:
docker pull verdaccio/verdaccio
Since version 2 images for every versions are availabel as tags.
To run the docker container:
docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio
$ docker-compose up --build
Docker examples are available in this repository.
A Verdaccio playbook is available at galaxy
Source: https://github.com/verdaccio/ansible-verdaccio
Maintainer: @030
The Verdaccio Chef cookbook is available via the chef supermarket.
Source: https://github.com/verdaccio/verdaccio-cookbook.
Maintainer: @kgrubb
Source: https://github.com/verdaccio/puppet-verdaccio.
Maintainer: No asigned yet
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.
No CouchDB here. This application is supposed to work with zero configuration, so filesystem is used as a storage.
If you want to use a database instead, ask for it, we'll come up with some kind of a plugin system.
About the storage there is a running discussion here.
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.
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
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.