Package detail

@verdaccio/core

verdaccio1.2mMIT6.0.0-6-next.76

core utilities

private, package, repository, registry

readme

Verdaccio stands for peace, stop the war, we will be yellow / blue 🇺🇦 until that happens.

verdaccio logo

verdaccio gif

Version Next (Development Branch)

Looking for Verdaccio version 5 or 6? Version 6 is the latest version and successor to version 5. Version 6 requires Node.js 18 or higher and is maintained in the 6.x branch.

The plugins for versions 5 and 6 are located at the verdaccio/monorepo repository. Plugins for the next-8 version are hosted in this project under the ./packages/plugins folder.

Note that contributing guidelines might be different based on the branch.

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.

Versions

You can find more details about the different versions of Verdaccio, minimum requirements, as well as links to associated npm packages and docker images in the version history.

Install

Node.js v18 as minimum version required

Install with npm:

npm install -g verdaccio@next-8

With yarn

yarn global add verdaccio@next-8

With pnpm

pnpm i -g verdaccio@next-8

docker pull verdaccio/verdaccio:nightly-master

or with helm official chart.

helm repo add verdaccio https://charts.verdaccio.org
helm repo update
helm install verdaccio/verdaccio

Furthermore, you can read the Debugging Guidelines and the Docker Examples for more advanced development.

Plugins

You can develop your own plugins with the verdaccio generator. Installing Yeoman is required.

npm install -g yo
npm install -g generator-verdaccio-plugin

Learn more here how to develop plugins. Share your plugins with the community.

End to End Testing

In our compatibility testing project, we're dedicated to ensuring that your favorite commands work seamlessly across different versions of npm, pnpm, and Yarn. From publishing packages to managing dependencies. Our goal is to give you the confidence to use your preferred package manager without any issues. So dive in, check out our matrix, and see how your commands fare across the board!

Learn or contribute here

Commands

cmd	npm6	npm7	npm8	npm9	npm10	npm11	pnpm8	pnpm9	pnpm10	yarn1	yarn2	yarn3	yarn4
publish	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
unpublish	✅	✅	✅	✅	✅	✅	✅	✅	✅	❌	❌	❌	❌
info	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
audit	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	❌
install	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
deprecate	✅	✅	✅	✅	✅	✅	✅	✅	✅	⛔	⛔	⛔	⛔
ping	✅	✅	✅	✅	✅	✅	✅	✅	✅	⛔	⛔	⛔	⛔
search	✅	✅	✅	✅	✅	✅	✅	✅	✅	⛔	⛔	⛔	⛔
star	✅	✅	✅	✅	✅	✅	✅	✅	✅	⛔	⛔	⛔	⛔
stars	✅	✅	✅	✅	✅	✅	✅	✅	✅	⛔	⛔	⛔	⛔
dist-tag	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	❌	❌	❌

notes:

yarn search cmd exist in modern but, it do not uses the search registry endpoint.

yarn modern has two info commands, the one used here is yarn npm info

❌ = no tested ✅ = tested ⛔ = no supported

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 doing a long support donation - and your logo will be on this section of the readme.

Donate 💵👍🏻 starting from $1/month or just one single contribution.

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 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, babel.js, angular-cli or docusaurus. You can read more in here.

Furthermore, here few examples how to start:

Watch our Videos

Node 2022, February 2022, Online Free

You might want to check out as well our previous talks:

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 a 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:nightly-master

Available as tags.

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 a private repository. Unfortunately, it isn't always possible.

Basic features

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

Advanced package control

Unpublishing packages (npm unpublish) - supported
Tagging (npm dist-tag) - supported
Deprecation (npm deprecate) - supported

User management

Registering new users (npm adduser {newuser}) - supported
Change password (npm profile set password) - supported
Transferring ownership (npm owner) - supported
Token (npm token) - supported

Miscellaneous

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

Security

Audit (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.

Special Thanks

Thanks to the following companies to help us to achieve our goals providing free open source licenses. Every company provides enough resources to move this project forward.

Company	Logo	License
JetBrains		JetBrains provides licenses for products for active maintainers, renewable yearly
Crowdin		Crowdin provides platform for translations
BrowserStack		BrowserStack provides plan to run End to End testing for the UI
Netlify		Netlify provides pro plan for website deployment
Algolia		Algolia provides search services for the website
Docker		Docker offers unlimited pulls and unlimited egress to any and all users

Maintainers

Juan Picado	Ayush Sharma	Sergio Hg

	@ayusharma_	@sergiohgz
Priscila Oliveria	Daniel Ruf

@priscilawebdev	@DanielRufde

You can find and chat with them over Discord, click here.

Who is using Verdaccio?

create-react-app (+86.2k ⭐️)
Grafana (+54.9k ⭐️)
Gatsby (+49.2k ⭐️)
Babel.js (+38.5k ⭐️)
Docusaurus (+34k ⭐️)
Vue CLI (+27.4k ⭐️)
Angular CLI (+24.3k ⭐️)
Uppy (+23.8k ⭐️)
bit (+13k ⭐️)
Aurelia Framework (+11.6k ⭐️)
pnpm (+10.1k ⭐️)
ethereum/web3.js (+9.8k ⭐️)
Webiny CMS (+6.6k ⭐️)
NX (+6.1k ⭐️)
Mozilla Neutrino (+3.7k ⭐️)
workshopper how to npm (+1k ⭐️)
Amazon SDK v3
Amazon Encryption SDK for Javascript

🤓 Don't be shy, add yourself to this readme.

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]

Open Collective Backers

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

Contributors

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

FAQ / Contact / Troubleshoot

If you have any issue you can try the following options. Do no hesitate 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) are Creative Commons licensed.

changelog

@verdaccio/core

6.0.0-6-next.76

6.0.0-6-next.75

Patch Changes

0a6412ca9: refactor: got instead undici

6.0.0-6-next.74

6.0.0-6-next.73

Patch Changes

f859d2b1a: fix: official package "-" cannot be synced

6.0.0-6-next.72

6.0.0-6-next.71

6.0.0-6-next.70

6.0.0-6-next.69

Minor Changes

c9d1af0e: feat: async bcrypt hash

6.0.0-6-next.68

6.0.0-6-next.67

Minor Changes

16e38df8: feat: trustProxy property

6.0.0-6-next.66

6.0.0-6-next.65

Patch Changes

a1da1130: fix: minor typo on warning message

6.0.0-6-next.64

Minor Changes

974cd8c1: fix: startup messages improved and logs support on types

6.0.0-6-next.63

Minor Changes

dc571aab: feat: add forceEnhancedLegacySignature

6.0.0-6-next.62

Patch Changes

378e907d: fix(core): fix isObject function.isObject(true) should return false.

6.0.0-6-next.61

6.0.0-6-next.60

6.0.0-6-next.59

6.0.0-6-next.58

6.0.0-6-next.57

6.0.0-6-next.56

6.0.0-6-next.55

Patch Changes

9718e033: fix: build targets for 5x modules

6.0.0-6-next.54

Minor Changes

ef88da3b: feat: improve support for fs promises older nodejs

6.0.0-6-next.53

6.0.0-6-next.52

6.0.0-6-next.51

Minor Changes

4b29d715: chore: move improvements from v5 to v6

Migrate improvements form v5 to v6:

6.0.0-6-next.50

6.0.0-6-next.49

6.0.0-6-next.48

Minor Changes

62c24b63: feat: add passwordValidationRegex property

Patch Changes

43f32687: fix: abbreviated headers handle quality values

6.0.0-6-next.47

6.0.0-6-next.8

Patch Changes

b849128d: fix: handle upload scoped tarball

6.0.0-6-next.7

Patch Changes

351aeeaa: fix(deps): @verdaccio/utils should be a prod dep of local-storage

6.0.0-6-next.6

Major Changes

292c0a37: feat!: replace deprecated request dependency by got

This is a big refactoring of the core, fetching dependencies, improve code, more tests and better stability. This is essential for the next release, will take some time but would allow modularize more the core.

Notes
- Remove deprecated request by other got, retry improved, custom Agent ( got does not include it built-in)
- Remove async dependency from storage (used by core) it was linked with proxy somehow safe to remove now
- Refactor with promises instead callback wherever is possible
- ~Document the API~
- Improve testing, integration tests
- Bugfix
- Clean up old validations
- Improve performance
💥 Breaking changes
- Plugin API methods were callbacks based are returning promises, this will break current storage plugins, check documentation for upgrade.
- Write Tarball, Read Tarball methods parameters change, a new set of options like AbortController signals are being provided to the addAbortSignal can be internally used with Streams when a request is aborted. eg: addAbortSignal(signal, fs.createReadStream(pathName));
- @verdaccio/streams stream abort support is legacy is being deprecated removed
- Remove AWS and Google Cloud packages for future refactoring #2574.
a3a209b5: feat: migrate to pino.js 8

Minor Changes

00d1d2a1: chore: env variable for launch fastify

Update fastify to major release v4.3.0
Update CLI launcher

via CLI

VERDACCIO_SERVER=fastify verdaccio

with docker

docker run -it --rm --name verdaccio \
  -e "VERDACCIO_SERVER=8080" -p 8080:8080 \
  -e "VERDACCIO_SERVER=fastify" \
  verdaccio/verdaccio

6.0.0-6-next.5

Major Changes

82cb0f2b: feat!: config.logs throw an error, logging config not longer accept array or logs property

💥 Breaking change

This is valid

log: { type: stdout, format: pretty, level: http }

This is invalid

logs: { type: stdout, format: pretty, level: http }

logs:
  - [{ type: stdout, format: pretty, level: http }]

Minor Changes

5167bb52: feat: ui search support for remote, local and private packages

The command npm search search globally and return all matches, with this improvement the user interface is powered with the same capabilities.

The UI also tag where is the origin the package with a tag, also provide the latest version and description of the package.

6.0.0-6-next.4

Minor Changes

24b9be02: refactor: improve docker image build with strict dependencies and prod build

6.0.0-6-next.3

Minor Changes

6c1eb021: feat: use warning codes for deprecation warnings

6.0.0-6-next.2

Major Changes

794af76c: Remove Node 12 support
- We need move to the new undici and does not support Node.js 12

Minor Changes

154b2ecd: refactor: remove @verdaccio/commons-api in favor @verdaccio/core and remove duplications

6.0.0-6-next.1

Major Changes

459b6fa7: refactor: search v1 endpoint and local-database
- refactor search api v1 endpoint, improve performance
- remove usage of async dependency https://github.com/verdaccio/verdaccio/issues/1225
- refactor method storage class
- create new module core to reduce the ammount of modules with utilities
- use undici instead node-fetch
- use fastify instead express for functional test
Breaking changes
- plugin storage API changes
- remove old search endpoint (return 404)
- filter local private packages at plugin level
The storage api changes for methods get, add, remove as promise base. The search methods also changes and recieves a query object that contains all query params from the client.
```
export interface IPluginStorage<T> extends IPlugin {
  add(name: string): Promise<void>;
  remove(name: string): Promise<void>;
  get(): Promise<any>;
  init(): Promise<void>;
  getSecret(): Promise<string>;
  setSecret(secret: string): Promise<any>;
  getPackageStorage(packageInfo: string): IPackageStorage;
  search(query: searchUtils.SearchQuery): Promise<searchUtils.SearchItem[]>;
  saveToken(token: Token): Promise<any>;
  deleteToken(user: string, tokenKey: string): Promise<any>;
  readTokens(filter: TokenFilter): Promise<Token[]>;
}
```