0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-23 22:27:34 -05:00
verdaccio/docs/install.md

56 lines
1.4 KiB
Markdown
Raw Normal View History

---
id: installation
title: "Installation"
---
2017-08-29 00:52:43 -05:00
Verdaccio is a multiplatform web application. To install it, you need a few prerequisites.
2017-08-29 00:52:43 -05:00
#### Prerequisites
1. Node higher than
- For version `verdaccio@2.x` Node `v4.6.1` is the minimum supported version.
2018-05-31 03:32:46 -05:00
- For version `verdaccio@latest` Node `6.12.0` is the minimum supported version.
2. npm `>=3.x` or `yarn`
3. The web interface supports the `Chrome, Firefox, Edge, and IE9` browsers.
2017-08-29 00:52:43 -05:00
## Installing the CLI
`verdaccio` must be installed globaly using either of the following methods:
2017-08-29 00:52:43 -05:00
Using `npm`
2017-08-29 00:52:43 -05:00
```bash
2017-10-23 13:39:50 -05:00
npm install -g verdaccio
2017-08-29 00:52:43 -05:00
```
or using `yarn`
2017-08-29 00:52:43 -05:00
```bash
yarn global add verdaccio
```
![install verdaccio](/svg/install_verdaccio.gif)
2017-08-29 00:52:43 -05:00
## Basic Usage
Once it has been installed, you only need to execute the CLI command:
2017-08-29 00:52:43 -05:00
```bash
$> verdaccio
warn --- config file - /home/.config/verdaccio/config.yaml
2018-05-31 03:32:46 -05:00
warn --- http address - http://localhost:4873/ - verdaccio/3.0.1
2017-08-29 00:52:43 -05:00
```
For more information about the CLI, please [read the cli section](cli.md).
2017-08-29 00:52:43 -05:00
## Docker Image
`verdaccio` has an official docker image you can use, and in most cases, the default configuration is good enough. For more information about how to install the official image, [read the docker section](docker.md).
## Cloudron
`verdaccio` is also available as a 1-click install on [Cloudron](https://cloudron.io)
[![Install](https://cloudron.io/img/button.svg)](https://cloudron.io/button.html?app=org.eggertsson.verdaccio)