JavaScript CSS Other
Clone or download
Latest commit 7282faf Aug 14, 2018
Permalink
Failed to load latest commit information.
.circleci chore: add step to control the bundle sizes Jul 28, 2018
.github chore: add lock setup for old issues May 30, 2018
.vscode chore: update gitignore Mar 17, 2018
assets chore: add fonts and new svg Jun 28, 2018
bin refactor: Update cli path and fix eslint errors for transpiled code Jan 7, 2018
conf feat: adds option to set scope in webui instructions header Jul 31, 2018
debug chore: add debug bootstrap entry point May 26, 2018
docs docs: document package regex syntax Aug 13, 2018
flow-typed/npm chore: update flow to 0.75.0 Jul 18, 2018
scripts build: improve beta and alpha release Jan 7, 2018
src Merge branch 'master' into master Aug 13, 2018
static fix: favicon refers to .png while only .ico exists #681 May 25, 2018
systemd Using the env path in the systemd service Nov 4, 2017
test Merge branch 'master' into master Aug 13, 2018
tools feat: adds option to set scope in webui instructions header Jul 29, 2018
types feat: adds support for external plugin directory (#532) Jul 18, 2018
website chore: fix typo Aug 13, 2018
wiki docs(wiki): update wiki main page Feb 11, 2018
.babelrc refactor: use plugins type on loadPlugin Jul 18, 2018
.dockerignore chore: update gitignore Mar 17, 2018
.editorconfig refactor: πŸ”§ add .jsx into editorconfig Jan 7, 2018
.env allow to configure port for docker Jun 24, 2017
.eslintignore refactor: migrate unit test to Jest Jan 7, 2018
.eslintrc refactor: add new constants Jul 3, 2018
.flowconfig refactor: add types to new files Feb 24, 2018
.gitignore chore: exclude bundle files on git Jun 3, 2018
.npmignore refactor: improve code with es6 style Jun 24, 2018
.stylelintrc refactor: ⬆️ upgrade dependencies & fix issues in dev mode Jan 7, 2018
.yarnrc refactor(flow): add flow support to storage Feb 3, 2018
AUTHORS chore: update authors May 26, 2018
CHANGELOG.md chore(release): 3.6.0 Aug 13, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jun 19, 2017
CONTRIBUTING.md docs: update contributing guidelines Mar 10, 2018
Dockerfile fix: fix docker python issue #883 Aug 1, 2018
Dockerfile.rpi - Added docker image for rpi Mar 6, 2017
LICENSE docs: Add MIT license file Jan 7, 2018
LICENSE-docs docs: Add license reference to README and add specific license for do… Jan 7, 2018
README.md docs: changes gitter link to Discord Jul 31, 2018
crowdin.yaml chore: update crowdin mapping Aug 9, 2018
docker-compose.yaml allow to configure port for docker Jun 24, 2017
index.js feat: add node api to launch verdaccio programmatically Jan 18, 2018
jest.config.js refactor: <Package /> , <Footer /> and package sidebar code refactoring Jul 22, 2018
jestEnvironment.js refactor: migrate unit test to Jest Jan 7, 2018
package.json chore(release): 3.6.0 Aug 13, 2018
renovate.json chore(deps): force renovate to resolve only 1 day per month Feb 11, 2018
yarn.lock refactor: header component test (#878) Aug 1, 2018

README.md



Version 3 Released πŸŽ‰

All the new features you need to know

A lightweight private npm proxy registry

npm version CircleCI Status Coverage Status npm Downloads npm Downloads discord

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

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 commony 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

Misc stuff

  • 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]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

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.