Verdaccio 使用 Docker 安装及迁移教程

前言

Verdaccio 是一个 npm 私有源，代码在 GitHub 开源，公司由于业务需要使用也有一段时间，非常稳定，社区也很活跃。入门可以看我之前写的一篇文章：

npm私服安装教程 - verdaccio 入门

前一段时间由于所在服务器升级，顺便更新了下 Verdaccio 版本，并将之前的数据都迁移过来。由于公司服务器上有 docker，所以就使用 docker 来安装。

安装

下载镜像

先下载最新的 Verdaccio 镜像，使用官方的 docker 镜像

docker pull verdaccio/verdaccio

上面命令拉取的即是 latest 的镜像

启动前配置

如果没有安装 docker-compose，可以看文末链接。

在工作目录新建文件夹 npm，然后新建 docker-compose.yml 文件

mkdir npm && touch npm/docker-compose.yml

然后将以下配置粘贴到 docker-compose.yml 文件中：

version: '3.4'

services:
  verdaccio:
    image: verdaccio/verdaccio
    container_name: "verdaccio"
    networks:
      - node-network
    environment:
      - VERDACCIO_PORT=4873
    ports:
      - "4873:4873"
    volumes:
      - "./storage:/verdaccio/storage"
      - "./config:/verdaccio/conf"
      - "./plugins:/verdaccio/plugins"
networks:
  node-network:
    driver: bridge

上面配置即使用了刚才下载的 verdaccio 镜像，容器和宿主机都绑定在 4873 端口。同时挂载了当前目录的 storage，config， plugins 文件夹到容器内部。

如果需要修改端口号，就将上面配置文件中三个 4873 都改成其他端口号即可。

又由于启动时容器会去找 ./config/config.yaml 文件，所以在 config 文件夹新建该文件，填入以下内容：

storage: /verdaccio/storage
auth:
  htpasswd:
    file: /verdaccio/conf/htpasswd
uplinks:
  npmjs:
    url: https://registry.npm.taobao.org/
packages:
  '@*/*':
    access: $all
    publish: $authenticated
    proxy: npmjs
  '**':
    proxy: npmjs
logs:
  - {type: stdout, format: pretty, level: http}

• htpasswd 文件是用来存储 npm 用户及密码信息的文件

• uplinks 上游源改为了淘宝的镜像源，这样在下载找不到的包的时候就会从淘宝下载。

• 需要注意的是，上面配置文件的路径都是针对 docker 容器内部来说的。

启动容器

执行以下命令启动：

docker-compose up -d --build

启动后通过访问 http://your.domain:4873 端口号应该就可以看到 Verdaccio 的 web 页面了，笔者安装时候的最新版本为 4.3.3

配置 nginx

如果 nginx 直接安装在宿主机，直接新建配置文件填入以下内容即可：

server {
  listen 80;
  server_name your.npm-server.com;
  location / {
    proxy_pass              http://127.0.0.1:4873/;
    proxy_set_header        Host $host;
  }
}

如果想使用跑在 docker 容器中的 nginx，首先查看一下 docker0 这个网卡的 ip 地址：

ifconifg

可以看到我用的服务器的 docker 虚拟网卡的ip 为：172.17.0.1

docker0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
        inet 172.17.0.1  netmask 255.255.0.0  broadcast 0.0.0.0
        ether 02:42:2f:ed:ec:0e  txqueuelen 0  (Ethernet)
        RX packets 30587  bytes 17826762 (17.0 MiB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 38051  bytes 25920436 (24.7 MiB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

然后将上面 nginx 配置文件中反向代理的 ip 地址改为该内网 ip 即可。

权限问题

打开刚才配置的域名即可看到 Verdaccio 的 web 界面，我们来新增用户测试一下：

npm adduser --registry http://your.npm-server.com

根据提示输入用户名和密码，最后却提示 500 服务器错误。

我们在服务器上执行以下命令查看容器日志：

docker logs --tail 20 verdaccio

发现：

EACCES: permission denied, open '/verdaccio/conf/htpasswd'

原来是没有权限。查了一番资料得知，用户在新增 npm 用户的时候会写入 htpasswd 文件，由于该文件是在宿主机中，默认是 root 用户建立的，而 verdaccio 容器中拥有自己的用户名，名字就叫 verdaccio，所以无法写入 root 用户拥有的文件。
那么是不是还要在宿主机上新建 verdaccio 用户呢？不用这么麻烦。根据官方文档和文末的最后一篇文章得知，docker 容器中的 uid 和 gid 和宿主机是共享的，只不过没有具体的名称，而容器内 verdaccio 使用的 uid 为 10001，gid 为 65533，所以我们在宿主机改一下 htpasswd 文件的权限：

sudo chown 10001:65533 htpasswd

然后再试一下添加用户，就可以成功了。

同理，storage 目录是 verdaccio 存放包数据的目录，也需要修改一下权限：

sudo chown -R 10001:65533 storage

然后试一下发布包，成功~

迁移

由于笔者是从 [email protected] 升级到 4.3，所以将原服务器上的 config.yaml、htpasswd 和 storage 文件夹 scp 过去，然后修改一下权限即可。

scp config.yaml [email protected]:/path/to/config.yaml
scp htpasswd [email protected]:/path/to/htpasswd
scp -r storage [email protected]:/path/to/storage

同时迁移后注意修改 config.yaml 中的 htpasswd 和 storage 路径。

参考文章

• Verdaccio 官方文档

• docker-compose 安装加速

• Understanding how uid and gid work in Docker containers