From 6cdb4e43679d28ff383ea4d1031eeb746228c500 Mon Sep 17 00:00:00 2001 From: "Juan Picado @jotadeveloper" Date: Tue, 29 May 2018 22:43:53 +0200 Subject: [PATCH] chore: update readme --- README.md | 158 ++++++++++++++++++++++++++---------------------------- 1 file changed, 75 insertions(+), 83 deletions(-) diff --git a/README.md b/README.md index 2000814d4..cb16f3e26 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,54 @@ -

- -### A lightweight private npm proxy registry +
+ + + +
+
+

3.0.0 Released 🎉

+
+
+

+ Verdaccio is lightweight private npm proxy registry. +

+ + npm version + CircleCI Status + Coverage Status + npm Downloads + npm Downloads +
+
+

-`verdaccio` is a fork of `sinopia`. It aims to keep backwards compatibility with `sinopia`, while keeping up with npm changes. +
-[![CircleCI](https://circleci.com/gh/verdaccio/verdaccio/tree/master.svg?style=svg)](https://circleci.com/gh/verdaccio/verdaccio/tree/master) -[![Backers on Open Collective](https://opencollective.com/verdaccio/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/verdaccio/sponsors/badge.svg)](#sponsors) [![npm version badge](https://img.shields.io/npm/v/verdaccio.svg)](https://www.npmjs.org/package/verdaccio) -[![downloads badge](http://img.shields.io/npm/dm/verdaccio.svg)](https://www.npmjs.org/package/verdaccio) -[![Docker Pulls](https://img.shields.io/docker/pulls/verdaccio/verdaccio.svg)](https://hub.docker.com/r/verdaccio/verdaccio/) -[![Gitter chat](https://badges.gitter.im/verdaccio/questions.png)](https://gitter.im/verdaccio/) -[![Crowdin](https://d322cqt584bo4o.cloudfront.net/verdaccio/localized.svg)](https://crowdin.com/project/verdaccio) -[![dependencies Status](https://david-dm.org/verdaccio/verdaccio/status.svg)](https://david-dm.org/verdaccio/verdaccio) -[![Known Vulnerabilities](https://snyk.io/test/github/verdaccio/verdaccio/badge.svg?targetFile=package.json)](https://snyk.io/test/github/verdaccio/verdaccio?targetFile=package.json) -[![codecov](https://codecov.io/gh/verdaccio/verdaccio/branch/master/graph/badge.svg)](https://codecov.io/gh/verdaccio/verdaccio) +

Install

+ +Install with npm: + +```bash +npm install --global verdaccio +``` + +Install with yarn: + +```bash +yarn global add verdaccio +``` + +Install with pnpm: + +```bash +pnpm i -g verdaccio +``` -

- +

Introduction

It allows you to have a **local npm private registry with zero configuration**. You don't have to install and replicate an entire database. Verdaccio keeps its own small database and, if a package doesn't exist there, **it asks any other registry** (npmjs.org) for it keeping only those packages you use. -## Quick Links - -* [Documentation](http://www.verdaccio.org/docs/en/installation.html) -* [Chat](https://gitter.im/verdaccio/questions) -* [Wiki](https://github.com/verdaccio/verdaccio/wiki) - -## Introduction - ### 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. @@ -37,7 +56,11 @@ It allows you to have a **local npm private registry with zero configuration**. ### 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](https://www.theregister.co.uk/2016/03/23/npm_left_pad_chaos/)*. + (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](https://www.theregister.co.uk/2016/03/23/npm_left_pad_chaos/)*, *[Many packages suddenly disappeared](https://github.com/npm/registry/issues/255?source=techstories.org)* or *[Registry returns 404 for a package I have installed before](https://github.com/npm/registry/issues/329)*. + +### 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 regirtries and fetching from one single endpoint. ### Override public packages @@ -46,13 +69,7 @@ It allows you to have a **local npm private registry with zero configuration**. See in detail each of these [use cases](https://github.com/verdaccio/verdaccio/tree/master/docs/use-cases.md). -## Get Started - -Installation and starting (application will create default config in config.yaml you can edit later) - -```bash -npm install --global verdaccio -``` +

Get Started

Run in your terminal @@ -73,22 +90,7 @@ Now you can navigate to [http://localhost:4873/](http://localhost:4873/) where y > Warning: Verdaccio does not currently support PM2's cluster mode, running it with cluster mode may cause unknown behavior. -#### Beta - -⚠️⚠️ **Please, help us to test the version 3.x in order to release a stable version soon. Do never test with your original storage folder, do always a backup** ⚠️⚠️ - -If you are an adventurous developer you can use and install the latest beta version, this is a non stable version, I'd recommend only use for testing purporses. - -```bash -$ npm install -g verdaccio@beta -``` -or using docker - -```bash -$ docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio:beta -``` - -## Publishing Private Packages +

Publishing Private Packages

#### Create an user and log in @@ -104,20 +106,21 @@ npm publish --registry http://localhost:4873 This will prompt you for user credentials which will be saved on the `verdaccio` server. -## Docker +

Docker

Below are the most commony needed informations, -every aspect of Docker and verdaccio is [documented separately](http://www.verdaccio.org/docs/en/docker.html) +every aspect of Docker and verdaccio is [documented separately](https://www.verdaccio.org/docs/en/docker.html) -### Prebuilt images -To pull the latest pre-built [docker image](https://hub.docker.com/r/verdaccio/verdaccio/): - -```bash +``` docker pull verdaccio/verdaccio ``` -Since version 2 images for every version are available as [tags](https://hub.docker.com/r/verdaccio/verdaccio/tags/). +Available as [tags](https://hub.docker.com/r/verdaccio/verdaccio/tags/). + +``` +docker pull verdaccio/verdaccio:3.0.0 +``` ### Running verdaccio using Docker @@ -127,17 +130,9 @@ To run the docker container: docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio ``` -### Using docker-compose - -1. Get the latest version of [docker-compose](https://github.com/docker/compose). -2. Build and run the container: - -```bash -$ docker-compose up --build -``` Docker examples are available [in this repository](https://github.com/verdaccio/docker-examples). -## Compatibility +

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. @@ -150,48 +145,36 @@ Verdaccio aims to support all features of a standard npm client that make sense - Unpublishing packages (npm unpublish) - **supported** - Tagging (npm tag) - **supported** -- Deprecation (npm deprecate) - not supported +- Deprecation (npm deprecate) - not supported - *PR-welcome* ### User management - Registering new users (npm adduser {newuser}) - **supported** -- Transferring ownership (npm owner add {user} {pkg}) - not supported, verdaccio uses its own acl management system - +- Transferring ownership (npm owner add {user} {pkg}) - not supported, *PR-welcome* ### Misc stuff - Searching (npm search) - **supported** (cli / browser) -- Starring (npm star, npm unstar) - not supported, doesn't make sense in private registry - Ping (npm ping) - **supported** +- Starring (npm star, npm unstar) - not supported, *PR-welcome* ### Security - npm audit - **supported** -## 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. - -* [Roadmap](https://github.com/verdaccio/verdaccio/wiki) -* [Most common questions](https://github.com/verdaccio/verdaccio/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Aquestion%20) -* [Reporting a bug](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 Room](https://gitter.im/verdaccio/) -* [Logos](https://github.com/verdaccio/verdaccio/tree/master/assets) - -## Contributors +

Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. -## Backers +### Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/verdaccio#backer)] -## Sponsors +### Sponsors 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)] @@ -206,10 +189,19 @@ Support this project by becoming a sponsor. Your logo will show up here with a l +

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. + +* [Roadmap](https://github.com/verdaccio/verdaccio/wiki) +* [Most common questions](https://github.com/verdaccio/verdaccio/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Aquestion%20) +* [Reporting a bug](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 Room](https://gitter.im/verdaccio/) +* [Logos](https://github.com/verdaccio/verdaccio/tree/master/assets) -## License +

License

Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE). The Verdaccio documentation and logos (e.g., .md, .png, .sketch) files in the /wiki and /assets folder) is [Creative Commons licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE-docs). -