1
0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-11-13 03:35:52 +01:00
verdaccio/docs/install.md
2018-01-06 23:04:02 +01:00

1.2 KiB

id date title
installation 2017-07-10T23:36:56.503Z Installation

Verdaccio is a multiplatform web application, to install you need at least some prerequisites.

Prerequisites

  1. Node higher than
    • For version 2.x we support from 4.6.1
    • For version 3.x we support as minimum 6.12.0
  2. npm >=3.x or yarn

Installing the CLI

Verdaccio must be install globaly using any of the most modern

Using npm

npm install -g verdaccio

or using yarn

yarn global add verdaccio

Warning: Verdaccio current is not support PM2's cluster mode, run it with cluster mode may cause unknown behavior

Basic Usage

Once has been installed you only need to execute the CLI command.

$> verdaccio
warn --- config file  - /home/.config/verdaccio/config.yaml
warn --- http address - http://localhost:5555/ - verdaccio/3.0.0

For more information about CLI please read the cli section.

Docker Image

verdaccio has a official docker image you can use, in the most of cases is good enough just the default configuration, for more information about how to install the official image read the docker section.