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.
Installation and starting (application will create default config in config.yaml you can edit later)
npm install --global verdaccioRun in your terminal
verdaccioYou 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 nullNow 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.
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@betaor using docker
$ docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio:betanpm adduser --registry http://localhost:4873npm publish --registry http://localhost:4873This will prompt you for user credentials which will be saved on the verdaccio server.
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/verdaccioSince version 2 images for every version are available as tags.
To run the docker container:
docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio- Get the latest version of docker-compose.
- Build and run the container:
$ docker-compose up --buildDocker 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.
- Installing packages (npm install, npm upgrade, etc.) - supported
- Publishing packages (npm publish) - supported
- Unpublishing packages (npm unpublish) - supported
- Tagging (npm tag) - supported
- Deprecation (npm deprecate) - not supported
- Registering new users (npm adduser {newuser}) - supported
- Transferring ownership (npm owner add {user} {pkg}) - not supported, verdaccio uses its own acl management system
- Searching (npm search) - supported (cli / browser)
- Starring (npm star, npm unstar) - not supported, doesn't make sense in private registry
- Ping (npm ping) - supported
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.
This project exists thanks to all the people who contribute. [Contribute].
Thank you to all our backers! 🙏 [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
Verdaccio is MIT licensed.
The Verdaccio documentation and logos (e.g., .md, .png, .sketch) files in the /wiki and /assets folder) is Creative Commons licensed.