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

50 lines
1.2 KiB
Markdown
Raw Normal View History

---
id: installation
date: '2017-07-10T23:36:56.503Z'
title: "Installation"
---
2017-08-29 07:52:43 +02:00
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
2017-08-29 07:52:43 +02:00
## Installing the CLI
`Verdaccio` must be install globaly using any of the most modern
Using `npm`
2017-08-29 07:52:43 +02:00
```bash
2017-10-23 20:39:50 +02:00
npm install -g verdaccio
2017-08-29 07:52:43 +02:00
```
or using `yarn`
2017-08-29 07:52:43 +02:00
```bash
yarn global add verdaccio
```
2017-08-29 08:23:06 +02:00
> Warning: Verdaccio current is not support PM2's cluster mode, run it with cluster mode may cause unknown behavior
2017-08-29 07:52:43 +02:00
## Basic Usage
Once has been installed you only need to execute the CLI command.
```bash
$> verdaccio
warn --- config file - /home/.config/verdaccio/config.yaml
warn --- http address - http://localhost:5555/ - verdaccio/3.0.0
2017-08-29 07:52:43 +02:00
```
![](https://cdn-images-1.medium.com/max/720/1*jDHnZ7_68u5s1lFK2cygnA.gif)
For more information about CLI please [read the cli section](cli.md).
## 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](docker.md).