A lightweight private npm proxy registry
npm install verdaccioVerdaccio 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.
Install with npm:
``bash`
npm install --global verdaccio
Node.js v18 or higher is required for Verdaccio
> It's recommended using Node.js 20 (or latest LTS)
or pull Docker official image
`bash`
docker pull verdaccio/verdaccio
and run
`bash`
docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio
or with _helm_ official chart.
`bash`
helm repo add verdaccio https://charts.verdaccio.org
helm repo update
helm install verdaccio/verdaccio
Verdaccio can be used as a module for launch a server programmatically, you can find more info at the website.
`
import {runServer} from 'verdaccio';
const app = await runServer(); // default configuration
const app = await runServer('./config/config.yaml');
const app = await runServer({ configuration });
app.listen(4873, (event) => {
// do something
});
You can develop your own plugins with the verdaccio generator. Installing Yeoman is required.
Learn more here how to develop plugins. Share your plugins with the community.
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 and maintenance.
You can donate at Open Collective 💵👍🏻 starting from _$1/month_ or just one single contribution.
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.
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.
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.
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:
- e2e-ci-example-gh-actions
- verdaccio-end-to-end-tests
- verdaccio-fork
- NodeTLV 20222 - Deep dive into Verdaccio, a lightweight Node.js registry - Juan Picado
- Five Ways of Taking Advantage of Verdaccio, Your Private and Proxy Node.js Registry Node Congress 2022 - Juan Picado
- Using Docker and Verdaccio to make Integration Testing Easy - Docker All Hands #4 December - 2021 - Juan Picado
View more in the YouTube channel.
Run in your terminal
`bash`
verdaccio
You would need set some npm configuration, this is optional.
`bash`
$ npm set registry http://localhost:4873/
For one-off commands or to avoid setting the registry globally:
`bash`
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.
#### 1. create a user and log in
`bash`
npm adduser --registry http://localhost:4873
> if you use HTTPS, add an appropriate CA information ("null" means get CA list from OS)
`bash`
$ npm set ca null
#### 2. publish your package
`bash`
npm publish --registry http://localhost:4873
This will prompt you for user credentials which will be saved on the verdaccio server.
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:6.x-next
To run the docker container:
`bash`
docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio
Docker examples are available in this repository.
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.
- Installing packages (npm install, npm upgrade, etc.) - supportednpm publish
- Publishing packages () - supported
- Unpublishing packages (npm unpublish) - supportednpm tag
- Tagging () - supportednpm deprecate
- Deprecation () - supported
- Registering new users (npm adduser {newuser}) - supportednpm profile set password
- Change password () - supportednpm owner add {user} {pkg}
- Transferring ownership () - not supported, _PR-welcome_npm token
- Token () - supported (under flag)
- Search (npm search) - supported (cli (/-/all and v1) / browser)npm ping
- Ping () - supportednpm star
- Starring (, npm unstar, npm stars`) - supported
- npm/yarn audit - supported
If you want to report a security vulnerability, please follow the steps which we have defined for you in our security policy.
| Juan Picado | Ayush Sharma | Sergio Hg |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| !jotadeveloper | !ayusharma | !sergiohgz |
| @jotadeveloper | @ayusharma\_ | @sergiohgz |
| Priscila Oliveria | Daniel Ruf |
| !priscilawebdev | !DanielRuf |
| @priscilawebdev | @DanielRufde |
See the full list of contributors is at the website.
Thank you to all our backers! 🙏 [Become a backer]
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 |
This project exists thanks to all the people who contribute. [Contribute].
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.
- Blog
- Donations
- Reporting an issue
- Running discussions
- Chat
- Logos
- Docker Examples
- FAQ
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.