Version 4

merdaccio is a simple, zero-config-required local private npm registry. No need for an entire database just to get started! merdaccio 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, merdaccio supports various community-made plugins to hook into services such as Amazon's s3, Google Cloud Storage or create your own plugin.

Install

Install with npm:

npm install --global merdaccio

What does merdaccio 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 merdaccio, 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

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

merdaccio

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: merdaccio 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 merdaccio server.

Docker

Below are the most commonly needed informations, every aspect of Docker and merdaccio is documented separately

docker pull merdaccio/merdaccio

Available as tags.

docker pull merdaccio/merdaccio:4.0.0

Running merdaccio using Docker

To run the docker container:

docker run -it --rm --name merdaccio -p 4873:4873 merdaccio/merdaccio

Docker examples are available in this repository.

Compatibility

merdaccio 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

Miscellany

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

Security

npm audit - supported

Who is using merdaccio?

Nobody

Special Thanks

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

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 desist to ask or check our issues database, perhaps someone has asked already what you are looking for.

License

merdaccio is MIT licensed

The merdaccio documentation and logos (excluding /thanks, e.g., .md, .png, .sketch) files within the /assets folder) is Creative Commons licensed.

MichaelSiddi/merdaccio