Skip to content
πŸ“¦πŸ”A lightweight private npm proxy registry
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci build: test Node.js 12 (#1291) Apr 28, 2019
.github chore: remove step frm GitHub actions Jun 14, 2019
.vscode fix: debugging with all ports Feb 13, 2019
assets chore: restore image reference May 24, 2019
bin refactor(docker): multistage build / support for running as random uid Aug 2, 2018
conf feat: prepare release v4 (#1307) May 26, 2019
contrib/aws feat: theme as plugin (#1252) Apr 6, 2019
debug refactor babel7 (#1164) Dec 22, 2018
docker-bin refactor(docker): multistage build / support for running as random uid Aug 2, 2018
docs chore: add info where the new docs are (#1138) Nov 27, 2018
flow-typed/npm fix: remove unused dependencies #1292 Apr 30, 2019
scripts feat: prepare release v4 (#1307) May 26, 2019
src fix(api): return 503 to npm/yarn on uplink connection timeout (#1331) Jun 13, 2019
systemd fix: Make systemd unit more production-like (#929) Aug 22, 2018
test fix(api): return 503 to npm/yarn on uplink connection timeout (#1331) Jun 13, 2019
types Package Refactor (#1145) Dec 13, 2018
wiki docs(wiki): update wiki main page Feb 11, 2018
.babelrc chore: using betas Feb 3, 2019
.dockerignore chore: allow prettier config within docker image Sep 25, 2018
.editorconfig refactor: πŸ”§ add .jsx into editorconfig Jan 7, 2018
.env allow to configure port for docker Jun 24, 2017
.eslintignore Merge remote-tracking branch 'origin/master' into 4.x Jan 31, 2019
.eslintrc feat: theme as plugin (#1252) Apr 6, 2019
.flowconfig refactor: add types to new files Feb 24, 2018
.gitignore chore: fix unpublish issues, fix unit test Feb 24, 2019
.npmignore chore: avoid add to package unrelevant files Apr 6, 2019
.prettierrc chore: set all to warning Dec 15, 2018
.stylelintrc chore: reduce severity on stylelint Dec 15, 2018
.yarnrc refactor(flow): add flow support to storage Feb 3, 2018
CHANGELOG.md chore(release): 4.0.3 Jun 14, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jun 19, 2017
CONTRIBUTING.md docs: cleanup contribution guide (#1094) Oct 31, 2018
Dockerfile fix: update docker node to latest lts version Apr 13, 2019
LICENSE docs: Add MIT license file Jan 7, 2018
README.md feat: prepare release v4 (#1307) May 26, 2019
SECURITY.md chore: update policy Jun 12, 2019
crowdin.yaml Merge remote-tracking branch 'origin/master' into 4.x Nov 24, 2018
docker-compose.yaml refactor: add prettier for yaml files (#931) Aug 20, 2018
index.js feat: add node api to launch verdaccio programmatically Jan 18, 2018
jest.config.js chore(docs): add testing development notes (#1343) Jun 13, 2019
jestEnvironment.js refactor: migrate unit test to Jest Jan 7, 2018
package.json chore(release): 4.0.3 Jun 14, 2019
security.txt feat: create security policy (#1322) May 25, 2019
yarn.lock fix(api): return 503 to npm/yarn on uplink connection timeout (#1331) Jun 13, 2019

README.md

verdaccio logo

verdaccio gif

Version 4

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.

verdaccio (latest) verdaccio (downloads) docker pulls backers stackshare

circle ci status codecov discord node MIT Crowdin

Twitter followers Github

Install

Install with npm:

npm install --global verdaccio

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

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, alfresco or eclipse theia. You can read more in dedicated article to E2E in our blog.

Get Started

Run in your terminal

verdaccio

You would need set some npm configuration, this is optional.

$ npm set registry http://localhost:4873/

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

1. create an user and log in

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

2. publish your package

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

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

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:4

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
  • Change password (npm profile set password) - supported
  • Transferring ownership (npm owner add {user} {pkg}) - not supported, PR-welcome
  • Token (npm token) - wip #1271

Miscellany

  • Searching (npm search) - supported (cli / browser)
  • Ping (npm ping) - supported
  • Starring (npm star, npm unstar, npm stars) - supported

Security

  • npm/yarn audit - supported

Report a vulnerability

If you want to report a security vulnerability, please follow the steps which we have defined for you in our security policy.

Core Team

The core team is the responsable for drive this project, team is ordered by antiquity and areas of responsability.

Juan Picado Ayush Sharma Sergio Hg Priscila Oliveria
jotadeveloper ayusharma sergiohgz priscilawebdev
@jotadeveloper @ayusharma_ @sergiohgz @priscilawebdev
All areas All areas Docker,Builds,Stack UI, Stack

You can find and chat with then over Discord, click here or follow them at Twitter.

Who is using Verdaccio?

πŸ€“ Don't be shy, you also can be in the list.

Sponsorship

If you are a company/project and you 😍 Verdaccio and FOSS, your logo can be here πŸ˜‰ if you support our activities. Donate.

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]

sponsor sponsor sponsor sponsor sponsor sponsor sponsor sponsor sponsor sponsor

Open Collective Backers

Thank you to all our backers! πŸ™ [Become a backer]

backers

Special Thanks

Thanks to the following companies to help us to achieve our goals providing free open source licenses.

jetbrain crowdin balsamiq

Contributors

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

contrubitors

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.

You can’t perform that action at this time.