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
2019-11-17 07:03:01 +01:00
.circleci ci(circleci): store test results in junit format (#1497) 2019-10-05 16:29:49 +02:00
.github fix: minor typos, formatting, and docs (#1512) 2019-10-06 20:07:36 +02:00
.vscode fix: debugging with all ports 2019-02-13 14:14:23 +01:00
assets chore: restore image reference 2019-05-24 09:22:34 +02:00
bin refactor(docker): multistage build / support for running as random uid 2018-08-02 20:23:26 +02:00
conf fix: minor typos, formatting, and docs (#1512) 2019-10-06 20:07:36 +02:00
contrib/aws fix: use test + mkdir for strict dir check 2019-08-14 23:38:34 +09:00
debug feat: convert project to typescript (#1374) 2019-07-16 08:40:01 +02:00
docker-bin refactor(docker): multistage build / support for running as random uid 2018-08-02 20:23:26 +02:00
docs chore: add info where the new docs are (#1138) 2018-11-27 14:43:29 +01:00
scripts feat: prepare release v4 (#1307) 2019-05-26 14:20:38 +02:00
src refactor: removes ts ignore comments (#1541) 2019-11-02 11:18:37 +01:00
systemd fix: Make systemd unit more production-like (#929) 2018-08-22 23:12:26 +02:00
test fix: fixing typos in comments (#1504) 2019-10-02 21:14:19 +02:00
types chore: fix eslint warnings (#1471) 2019-09-26 18:22:14 +02:00
wiki fix: minor typos, formatting, and docs (#1512) 2019-10-06 20:07:36 +02:00
.babelrc feat: npm token command support (#1427) 2019-09-07 15:46:50 -07:00
.dockerignore chore: allow prettier config within docker image 2018-09-25 22:19:51 +02: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 feat: convert project to typescript (#1374) 2019-07-16 08:40:01 +02:00
.eslintrc feat: npm token command support (#1427) 2019-09-07 15:46:50 -07:00
.gitignore ci(circleci): store test results in junit format (#1497) 2019-10-05 16:29:49 +02:00
.npmignore chore: avoid add to package unrelevant files 2019-04-06 14:45:04 +02:00
.npmrc feat: npm token command support (#1427) 2019-09-07 15:46:50 -07:00
.prettierrc feat: convert project to typescript (#1374) 2019-07-16 08:40:01 +02:00
.secrets-baseline feat: npm token command support (#1427) 2019-09-07 15:46:50 -07:00
.stylelintrc chore: reduce severity on stylelint 2018-12-15 09:40:43 +01:00
.yarnrc refactor(flow): add flow support to storage 2018-02-04 00:24:28 +01:00
CHANGELOG.md chore(release): 4.3.4 2019-10-23 20:52:12 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-06-19 21:14:23 +02:00
CONTRIBUTING.md fix: minor typos, formatting, and docs (#1512) 2019-10-06 20:07:36 +02:00
crowdin.yaml Merge remote-tracking branch 'origin/master' into 4.x 2018-11-24 09:07:29 +01:00
docker-compose.yaml refactor: add prettier for yaml files (#931) 2018-08-20 16:31:39 +02:00
Dockerfile feat(docker): Node.js update to 10.16.3 (#1473) 2019-09-26 20:27:46 +02:00
index.js feat: add node api to launch verdaccio programmatically 2018-01-18 07:03:12 +01:00
jest.config.js ci(circleci): store test results in junit format (#1497) 2019-10-05 16:29:49 +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
package.json build(deps-dev): bump @types/lodash from 4.14.141 to 4.14.148 (#1579) 2019-11-17 07:03:01 +01:00
README.md chore: add babe.js as oss user 2019-11-16 13:39:42 +01:00
SECURITY.md chore: update policy 2019-06-12 10:06:09 +02:00
security.txt feat: create security policy (#1322) 2019-05-25 22:11:13 +02:00
tsconfig.json chore: fix eslint warnings (#1471) 2019-09-26 18:22:14 +02:00
yarn.lock build(deps-dev): bump @types/lodash from 4.14.141 to 4.14.148 (#1579) 2019-11-17 07:03:01 +01:00

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

Donations

Verdaccio is run by volunteers; nobody is working full-time on it. If you find this project to be useful and would like to support its development, consider making a donation - your logo might end up in this readme. 😉

Donate 💵👍🏻 starting from $1/month.

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.

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

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.

Talks

Do not miss our talk (Introduction to Verdaccio) with @priscilawebdev and @jotadeveloper on stage.

viennajs-meetup

Get Started

Run in your terminal

verdaccio

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

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

For one-off commands or to avoid setting the registry globally:

NPM_CONFIG_REGISTRY=http://localhost:4873 npm i

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 information, 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) - (more info #1427) - supported

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 responsible for driving this project ahead, team is ordered by antiquity and areas of responsibility.

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

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.

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

contributors

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.