github.com
/
verdaccio
mirror of https://github.com/verdaccio/verdaccio.git
1
0
Fork 0
Code Releases Wiki Activity
verdaccio/website/docs/install.md

2.7 KiB
Raw Blame History

id title
installation Installation

Verdaccio is a multiplatform web application. To install it, you need a few basic prerequisites.

Prerequisites

  1. Node higher Node 10.x (LTS "Carbon") is the minimum supported version.

After v4.5.0 Node.js v10 is now the minimum supported version. If you cannot upgrade Node.js v8, keep using v4.4.4.

  1. npm >=5.x or, pnpm or yarn

We highly recommend to use the latest Node Package Managers clients > npm@6.x | yarn@1.x | pnpm@4.x

  1. The web interface supports the Chrome, Firefox, Edge, and IE11 browsers.

Verdaccio will support latest Node.js version according the Node.js Release Working Group recomendations.

''

Installing the CLI

verdaccio must be installed globaly using either of the following methods:

Using npm

npm install -g verdaccio

or using yarn

yarn global add verdaccio

install verdaccio

Basic Usage

Once it 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:4873/ - verdaccio/4.5.0

For more information about the CLI, please read the cli section.

You can set the registry by using the following command.

npm set registry http://localhost:4873/

you can pass a --registry flag when needed.

npm install --registry http://localhost:4873

define in your .npmrc a registry field.

//.npmrc
registry=http://localhost:4873

Or a publishConfig in your package.json

{
  "publishConfig": {
    "registry": "http://localhost:4873"
  }
}

Create Your Own Private NPM Package Tutorial

If you still need a deep explanation, don't miss the at thedevlife tutorial how to publish your own private package using Verdaccio.

Docker Image

docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio

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.

Cloudron

verdaccio is also available as a 1-click install on Cloudron

Install