Version 3 Released 🎉

All the new features you need to know

A lightweight private npm proxy registry

Install

Install with npm:

npm install --global verdaccio

Install with yarn:

yarn global add verdaccio

Install with pnpm:

pnpm i -g verdaccio

Introduction

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 and Google Cloud Storage.

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 each of these use cases.

Get Started

Run in your terminal

$ 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.

Warning: Verdaccio does not currently support PM2's cluster mode, running it with cluster mode may cause unknown behavior.

Publishing Private Packages

Create an user and log in

$ npm adduser --registry http://localhost:4873

For scoped packages, you can log in for a specific scope:

$ npm adduser --registry http://localhost:4873 --scope=@mycompany

Publish your package

$ npm publish --registry http://localhost:4873

This will prompt you for user credentials which will be saved on the verdaccio server.

If you are publishing a scoped package, the registry argument is optional

Docker

Below are the most commonly needed informations, every aspect of Docker and verdaccio is documented separately

$ docker pull verdaccio/verdaccio

Available as tags.

$ docker pull verdaccio/verdaccio:3.0.0

Running verdaccio using Docker

To run the docker container:

$ docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio

Docker examples are available in this repository.

Compatibility

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.

Basic features

Installing packages (npm install, npm upgrade, etc.) - supported
Publishing packages (npm publish) - supported

Advanced package control

Unpublishing packages (npm unpublish) - supported
Tagging (npm tag) - supported
Deprecation (npm deprecate) - not supported - PR-welcome

User management

Registering new users (npm adduser {newuser}) - supported
Transferring ownership (npm owner add {user} {pkg}) - not supported, PR-welcome

Miscellany

Searching (npm search) - supported (cli / browser)
Ping (npm ping) - supported
Starring (npm star, npm unstar) - not supported, PR-welcome

Security

npm audit - supported

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

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 (e.g., .md, .png, .sketch) files in the /docs and /assets folder) is Creative Commons licensed.

nphyatt / verdaccio Goto Github PK

verdaccio's Introduction