0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-16 21:56:25 -05:00
A lightweight Node.js private proxy registry
Find a file
Juan Picado @jotadeveloper d470cfeeed
fix: overrides existing package to zero bytes file #1191
Publishing existing package overrides existing package to 0 bytes file
2019-02-24 10:11:56 +01:00
.circleci chore: relocate website (#1132) 2018-11-22 10:37:24 +01:00
.github Update main.workflow 2019-02-15 17:17:41 +01:00
.vscode fix: debugging with all ports 2019-02-13 14:14:23 +01:00
assets feat: update logos & add new page for logos on website (#941) 2018-08-24 09:18:49 +02:00
bin refactor: Update cli path and fix eslint errors for transpiled code 2018-01-07 07:59:36 +00:00
conf feat: introduce server keepAliveTimeout into config files 2019-01-27 10:19:46 +01:00
debug chore: add debug bootstrap entry point 2018-05-26 22:41:18 +02:00
docs chore: add info where the new docs are (#1138) 2018-11-27 14:43:29 +01:00
flow-typed/npm chore: update flow to 0.75.0 2018-07-18 07:52:39 +02:00
scripts Update publish.sh 2019-02-15 15:55:07 +01:00
src fix: overrides existing package to zero bytes file #1191 2019-02-24 10:11:56 +01:00
static fix: favicon refers to .png while only .ico exists #681 2018-05-25 07:42:18 +02:00
systemd Using the env path in the systemd service 2017-11-04 03:33:21 +01:00
test fix: overrides existing package to zero bytes file #1191 2019-02-24 10:11:56 +01:00
tools feat: adds option to set scope in webui instructions header 2018-07-29 18:30:08 +02:00
types feat: adds support for external plugin directory (#532) 2018-07-18 14:53:08 +02:00
wiki docs(wiki): update wiki main page 2018-02-11 12:26:08 +01:00
.babelrc fix: login without reload (#678) (#679) (#914) 2018-08-20 16:29:47 +02:00
.dockerignore chore: update gitignore 2018-03-17 11:53:10 +01:00
.editorconfig refactor: 🔧 add .jsx into editorconfig 2018-01-07 07:59:36 +00:00
.env allow to configure port for docker 2017-06-24 11:21:28 +02:00
.eslintignore refactor: migrate unit test to Jest 2018-01-07 07:59:36 +00:00
.eslintrc refactor: add new constants 2018-07-04 00:15:00 +02:00
.flowconfig refactor: add types to new files 2018-02-24 20:31:03 +01:00
.gitignore chore: exclude bundle files on git 2018-06-03 17:35:12 +02:00
.npmignore refactor: improve code with es6 style 2018-06-24 10:11:52 +02:00
.stylelintrc refactor: ⬆️ upgrade dependencies & fix issues in dev mode 2018-01-07 07:59:36 +00:00
.yarnrc refactor(flow): add flow support to storage 2018-02-04 00:24:28 +01:00
AUTHORS chore: update authors 2018-05-26 22:40:33 +02:00
CHANGELOG.md chore(release): 3.11.5 2019-02-21 06:58:28 +01:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md docs: cleanup contribution guide (#1094) 2018-10-31 22:58:16 +08:00
docker-compose.yaml allow to configure port for docker 2017-06-24 11:21:28 +02:00
Dockerfile fix: update docker node to 10.14.1 (#1148) 2018-12-06 08:34:54 +01:00
Dockerfile.rpi
index.js feat: add node api to launch verdaccio programmatically 2018-01-18 07:03:12 +01:00
jest.config.js fix: login without reload (#678) (#679) (#914) 2018-08-20 16:29:47 +02:00
jestEnvironment.js refactor: migrate unit test to Jest 2018-01-07 07:59:36 +00:00
LICENSE docs: Add MIT license file 2018-01-07 07:59:36 +00:00
LICENSE-docs docs: Add license reference to README and add specific license for documentation 2018-01-07 07:59:36 +00:00
package.json fix: overrides existing package to zero bytes file #1191 2019-02-24 10:11:56 +01:00
README.md chore: remove empty shield 2019-01-08 13:13:22 +01:00
renovate.json chore(deps): force renovate to resolve only 1 day per month 2018-02-11 11:54:57 +01:00
yarn.lock fix: overrides existing package to zero bytes file #1191 2019-02-24 10:11:56 +01:00

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.

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]

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.