跳到主要内容
版本号：6.x

安装

Verdaccio 是一个 Node.js 私有和代理 registry。 在安装之前，您需要确保系统环境已满足以下条件。

最低要求:​

  1. Node.js v18 或更高版本。

  2. 你喜爱的 Node 包管理器 npm，pnpm 或 yarn(classic 以及 berry)。

我们强烈建议使用最新版本的Node包管理工具，比如> npm@6.x | yarn@1.x | | yarn@2.x | pnpm@6.x。 不再支持npm@5.x或更低版本。

  1. 使用现代浏览器以访问Web界面， 支持使用 Chrome、 Firefox、 Edge和IE11 浏览器。

Verdaccio 将根据 Node. js 发布工作组 的推荐支持最新的 Node. js 版本。

仍在使用 Verdaccio 4？ 查看 迁移指南。

快速开始​

在开始之前学习基础：如何安装、配置文件的位置在哪里等等。

安装CLI​

在生产环境中使用Verdaccio前，请先阅读并了解 最佳实践案例。

Verdaccio 必须使用以下方法之一全局安装:

使用 npm

npm install -g verdaccio

或使用 yarn

yarn global add verdaccio

或使用 pnpm

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

安装 Verdaccio

下一个主要版本 (verdaccio 6 alpha)​

下一个 主要版本正在开发中，但已经可以尝试了，无论是为了测试目的，还是帮助捕捉任何可能的 Bug，如果你发现了一些问题，在 6.x bugs 标签下报告它。

npm install -g verdaccio@7-next

或者使用 docker 镜像

docker pull verdaccio/verdaccio:nightly-master

Docker 镜像 verdaccio/verdaccio:nightly-master 与主分支中的最新提交保持一致，而 nmpjs 版本的发布周期更长。 强烈建议不要将 alpha 版本用于生产。

基本用法​

一旦安装完成后，你只需要执行 CLI 命令：

$> verdaccio
warn --- config file  - /home/.config/verdaccio/config.yaml
warn --- http address - http://localhost:4873/ - verdaccio/5.0.0

关于 CLI 的详细信息，请 阅读 cli 章节。

你可以通过以下命令来设置 registry。

npm set registry http://localhost:4873/

你可以在需要时带上 --registry 参数。

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

在你的 .npmrc 中设置一个 registry 属性。

.npmrc
registry=http://localhost:4873

或在你的 package.json 中设置 publishConfig

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

如需其他配置，请阅读 使用私有 registry 部分。

创建属于你自己的私有NPM包教程​

如果你想要更详细的介绍，不要错过 thedevlife 编写的关于如何使用 Verdaccio 创建你自己的私有 NPM 包的教程。

Docker 镜像​

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

Verdaccio 有官方 docker 镜像可以使用，在大多数情况下，默认配置已经足够了。 关于如何安装官方镜像的更多信息，请 阅读 docker 部分。此外，你可以在我们的 docker-examples 存储库中了解更多关于组合 Docker 镜像的信息。

Helm Chart​

$ helm repo add verdaccio https://charts.verdaccio.org
$ helm repo update
$ helm install verdaccio/verdaccio

Cloudron​

Verdaccio 可以使用 Cloudron 一键安装

安装

Heroku 与 Docker​

为了更容易地开发你可能使用 Heroku，这个 免费 的测功机层允许您使用 Docker 容器测试他们的平台，请查看此示例。

https://github.com/juanpicado/verdaccio-heroku-example