2019-05-26 05:40:49 -05:00
2018-05-29 15:43:53 -05:00
2020-06-24 05:39:10 -05:00
# Version 5.x (Under development)
2019-01-20 04:34:10 -05:00
[Verdaccio ](https://verdaccio.org/ ) 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,
2018-11-06 00:46:58 -05:00
Google Cloud Storage** or create your own plugin.
2018-02-11 06:30:16 -05:00
2018-11-06 00:46:58 -05:00
[](https://opencollective.com/verdaccio)
2019-03-29 00:37:53 -05:00
[](https://stackshare.io/verdaccio)
2019-10-01 05:40:29 -05:00
[](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)
2018-11-06 00:46:58 -05:00
[](https://crowdin.com/project/verdaccio)
2020-03-04 01:38:36 -05:00
[](https://www.tickgit.com/browse?repo=github.com/verdaccio/verdaccio)
2018-01-18 00:55:17 -05:00
2018-11-06 00:46:58 -05:00
[](https://twitter.com/verdaccio_npm)
[](https://github.com/verdaccio/verdaccio/stargazers)
2017-07-16 02:21:10 -05:00
2020-06-24 05:39:10 -05:00
## Install 5.x
2018-11-06 00:46:58 -05:00
2020-06-24 05:39:10 -05:00
> ⚠️ Not available on npmjs yet
2018-11-06 00:46:58 -05:00
2020-06-24 05:39:10 -05:00
With docker
2021-03-29 06:09:37 -05:00
2020-03-04 01:38:36 -05:00
```bash
docker pull verdaccio/verdaccio:5.x-next
```
2021-03-29 06:09:37 -05:00
2020-06-24 05:39:10 -05:00
## Development
2017-07-25 07:59:45 -05:00
2020-12-22 15:16:11 -05:00
Please check [docs/development.md ](docs/development.md ) for further notes.
2020-03-04 01:38:36 -05:00
2020-12-22 15:16:11 -05:00
## Roadmap
2020-03-04 01:38:36 -05:00
2020-12-22 15:16:11 -05:00
Please check [the roadmap ](https://github.com/verdaccio/verdaccio/discussions/1690 ) if you are willing to contribute.
2013-10-02 13:56:06 -05:00
2020-06-24 05:39:10 -05:00
## Donations
2013-05-22 01:48:04 -05:00
2020-06-24 05:39:10 -05:00
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.** 😉
2018-05-21 04:28:04 -05:00
2020-09-03 14:15:29 -05:00
**[Donate](https://opencollective.com/verdaccio)** 💵👍🏻 starting from _\$1/month_ or just one single contribution.
2018-05-21 04:28:04 -05:00
2019-05-25 15:11:13 -05:00
## 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 ](https://github.com/verdaccio/verdaccio/security/policy ).
2019-01-20 04:35:57 -05:00
## Open Collective Sponsors
2018-02-17 00:57:18 -05:00
2018-11-06 00:46:58 -05:00
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor ](https://opencollective.com/verdaccio#sponsor )]
2018-02-17 00:57:18 -05:00
2018-11-06 00:46:58 -05:00
[](https://opencollective.com/verdaccio/sponsor/0/website)
[](https://opencollective.com/verdaccio/sponsor/1/website)
[](https://opencollective.com/verdaccio/sponsor/2/website)
[](https://opencollective.com/verdaccio/sponsor/3/website)
[](https://opencollective.com/verdaccio/sponsor/4/website)
[](https://opencollective.com/verdaccio/sponsor/5/website)
[](https://opencollective.com/verdaccio/sponsor/6/website)
[](https://opencollective.com/verdaccio/sponsor/7/website)
[](https://opencollective.com/verdaccio/sponsor/8/website)
[](https://opencollective.com/verdaccio/sponsor/9/website)
2018-02-17 00:57:18 -05:00
2019-01-20 04:35:57 -05:00
## Open Collective Backers
2018-02-17 00:57:18 -05:00
2018-11-06 00:46:58 -05:00
Thank you to all our backers! 🙏 [[Become a backer ](https://opencollective.com/verdaccio#backer )]
2018-02-17 00:57:18 -05:00
2018-11-06 00:46:58 -05:00
[](https://opencollective.com/verdaccio#backers)
2019-05-26 07:20:38 -05:00
## Special Thanks
Thanks to the following companies to help us to achieve our goals providing free open source licenses.
[](https://www.jetbrains.com/)
[](https://crowdin.com/)
2020-03-04 01:38:36 -05:00
[](https://balsamiq.com/)
2019-05-26 07:20:38 -05:00
2018-11-06 00:46:58 -05:00
## Contributors
This project exists thanks to all the people who contribute. [[Contribute ](CONTRIBUTING.md )].
2019-10-06 13:07:36 -05:00
[](../../graphs/contributors)
2018-11-06 00:46:58 -05:00
### FAQ / Contact / Troubleshoot
2018-05-29 15:43:53 -05:00
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.
2020-09-03 14:15:29 -05:00
- [Blog ](https://verdaccio.org/blog/ )
- [Donations ](https://opencollective.com/verdaccio )
- [Reporting an issue ](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md#reporting-a-bug )
- [Running discussions ](https://github.com/verdaccio/verdaccio/issues?q=is%3Aissue+is%3Aopen+label%3Adiscuss )
- [Chat ](http://chat.verdaccio.org/ )
- [Logos ](https://verdaccio.org/docs/en/logo )
- [Docker Examples ](https://github.com/verdaccio/docker-examples )
- [FAQ ](https://github.com/verdaccio/verdaccio/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Aquestion%20 )
2018-02-17 00:57:18 -05:00
2018-11-06 00:46:58 -05:00
### License
2018-01-06 12:34:51 -05:00
2018-05-29 16:03:51 -05:00
Verdaccio is [MIT licensed ](https://github.com/verdaccio/verdaccio/blob/master/LICENSE )
2020-09-03 14:15:29 -05:00
The Verdaccio documentation and logos (excluding /thanks, e.g., .md, .png, .sketch) files within the /assets folder) is
[Creative Commons licensed ](https://github.com/verdaccio/verdaccio/blob/master/LICENSE-docs ).
