前言

市面上目前有很多种 npm 私有服务方案，这里列举一些方案以及他们的优缺点

npm Enterprise ：这是 npm 官方提供的企业级服务，它支持私有包和公共包，并提供了一些高级功能，如集成身份验证和内置审计功能。然而，这是一项付费服务，而且价格相对较高。
1. 优点：来自 npm 官方，高级功能，集成身份验证和审计。
2. 缺点：价格高，可能超出一些小型团队或个人开发者的预算。
Artifactory ： JFrog 的 Artifactory 是一款强大的仓库管理器，支持多种包管理系统，包括 npm 。它提供了一些高级功能，如安全扫描和元数据跟踪。
1. 优点：支持多种包管理系统，高级功能如安全扫描和元数据跟踪。
2. 缺点：与 Verdaccio 相比，设置和管理可能更复杂。
Sonatype Nexus Repository： Nexus 是另一款支持多种包管理系统的仓库管理器，它也支持 npm 。它的界面直观易用，且支持 LDAP 和 Active Directory 这类目录服务。
1. 优点：支持多种包管理系统，直观的界面，支持目录服务。
2. 缺点：可能不如 Verdaccio 那么简洁和轻量级。
GitHub Packages：这是 GitHub 提供的包管理服务，支持 npm 和其他一些包管理系统。它可以与你的 GitHub 项目紧密集成，并支持在同一个组织中共享包。
1. 优点：与 GitHub 项目紧密集成，支持在组织中共享包。
2. 缺点：如果你的项目或团队并不使用 GitHub，那么这项服务可能就不那么有用了。
GitLab
1. 团队没有使用它作为代码仓库，相对于 Verdaccio 来说比较重

为什么使用 verdaccio :

自主管理：Verdaccio 允许团队拥有自己的私有 npm 存储库，对包的发布和版本控制有更大的自主权。这样可以减少对公共 npm 存储库的依赖，并提高安全性。
加速开发：由于 Verdaccio 将下载过的包缓存在本地，这将极大地提高了安装包的速度，特别是在网络不佳的情况下。
易于设置和使用：Verdaccio 的安装和配置过程相对简单，基本不需要过多的系统知识。一旦设置完成，开发者们可以直接使用 npm 命令来发布和安装包，无需学习新的工具。
节省成本：与一些商业的 npm 存储库管理服务相比，Verdaccio 是开源的，免费的。它可以帮助团队节省预算。
控制访问：通过 Verdaccio，你可以配置包的访问权限，比如你可以只允许特定用户或团队访问某个包，或者限制哪些用户可以发布包，这可以提高安全性并减少错误的可能。
持续集成友好：由于 Verdaccio 提供了本地的 npm 服务，这意味着你可以在没有互联网连接的情况下进行开发和测试。这对于持续集成/持续部署 (CI/CD) 环境特别有用。
生态系统兼容性：Verdaccio 与 npm 和 yarn 完全兼容，这意味着开发者们不需要改变他们现有的工作流程。
社区支持：Verdaccio 有一个活跃的开源社区，你可以从中获得帮助和支持。同时，由于其开源的特性，如果你遇到问题，你甚至可以参与到其开发和改进中去。

安装

首先在服务器上确保安装最新版本的 [[pnpm]]，全局安装 verdaccio

 1
pnpm add -g verdaccio

如果是第一次通过 pnpm 全局安装依赖，可能会提示 Run pnpm setup to create it automatically, or set the global-bin-dir setting, or the PNPM_HOME env variable. The global bin directory should be in the PATH.

这条信息建议运行”pnpm setup”命令来自动创建设置，或者设置”global-bin-dir”配置项，或者设置”PNPM_HOME”环境变量。全局bin目录应该在PATH环境变量中。

执行 pnpm setup

 1
pnpm setup

输出

 1
# 表示在 `/root/.bashrc` 文件中添加了新行。 `.bashrc` 文件是 Bash shell 的启动脚本文件，用于配置和初始化 Bash 环境
2
Appended new lines to /root/.bashrc
3

4
Next configuration changes were made:
5
# 将 `PNPM_HOME` 环境变量设置为 `/root/.local/share/pnpm`。这意味着 [[PNPM]] 将使用该目录作为全局包和其他文件的存储位置。
6
export PNPM_HOME="/root/.local/share/pnpm"
7
# 将 `PNPM_HOME` 目录添加到 PATH 环境变量中。PATH 环境变量定义了可执行文件的搜索路径，这样你可以在终端中直接运行 PNPM 命令，而无需指定完整的路径。
8
export PATH="$PNPM_HOME:$PATH"
9

10
To start using pnpm, run:
11
# 开始使用 PNPM，需要运行 "source /root/.bashrc" 命令。该命令将重新加载 ".bashrc" 文件
12
source /root/.bashrc

启动

执行 source /root/.bashrc 后继续执行 pnpm add -g verdaccio ，安装完成后执行 verdaccio 命令，输入

 1
# Verdaccio 的配置文件路径
2
info --- config file  - /root/.config/verdaccio/config.yaml
3
# 加密算法警告
4
info --- the "crypt" algorithm is deprecated consider switch to "bcrypt" in the configuration file. Read the documentation for additional details
5
# Verdaccio 使用的 htpasswd 文件的路径，htpasswd 文件用来存储用户的身份验证凭据
6
info --- using htpasswd file: /root/.config/verdaccio/htpasswd
7
# 下面两个表示 verdaccio 成功加载了 verdaccio-htpasswd 和 verdaccio-audit 插件
8
info --- plugin successfully loaded: verdaccio-htpasswd
9
info --- plugin successfully loaded: verdaccio-audit
10
# 启动的地址和当前的 verdaccio 版本
11
warn --- http address - http://localhost:4873/ - verdaccio/5.24.1

执行 verdaccio 之后就可以在 localhost:4873 中访问到了， localhost:4873 是默认配置的地址，可以通过CLI 或者 config.yaml 文件来修改

CLI 启动参数

Command Line Tool | Verdaccio

如果想要修改默认的启动主机地址和端口，可以通过以下命令启动，监听所有可用的网络接口，并使用端口 4873

 1
verdaccio --listen 0.0.0.0:4873 --config ./config.yaml

这种启动方式是临时的，如果想要永久修改，则需要修改 config.yaml 配置文件，路径为 /root/.config/verdaccio ，找到其中的 listen 配置项

 1
listen:
2
# - localhost:4873            # default value
3
# - http://localhost:4873     # same thing
4
  - 0.0.0.0:4873              # listen on all addresses (INADDR_ANY)
5
# - https://example.org:4873  # if you want to use https
6
# - "[::1]:4873"                # ipv6
7
# - unix:/tmp/verdaccio.sock    # unix socket

修改后再使用 verdaccio 命令启动后就是 0.0.0.0:4873 主机和端口

PM2启动

使用 PM2 来启动服务，方便进程管理、监控守护和自动重启等，首先确保已安装 PM2 - Home

 1
npm install pm2 -g | pnpm install -g pm2

执行 pm2 start verdaccio 或者 pm2 start which verdaccio 来启动使用verdaccio搭建npm私有库 pm2守护进程_npm守护进程_青鱼梦镜白的博客-CSDN博客

pm2 启动有点问题，一直报错，怀疑是跟 Node 版本有关系，当期 Node 版本是 16.4，想要升级最新版，但是服务器是 Centos7 ，缺少 Node 18 所必须的依赖，想升级 18 还需要升级 Ctntos 为 18，所以使用 Docker 把

使用 Docker

确保已安装 [[Docker]]，拉取 docker 镜像

 1
docker pull verdaccio/verdaccio

创建 docker/verdaccio 目录并新建 config.yaml 文件，文件内容可以从这里复制verdaccio/docker.yaml at master · verdaccio/verdaccio · GitHub 创建

conf/config.yaml 文件夹及文件
htpasswd 文件
storage 文件夹
plugins 文件夹

[!WARNING] 注意， htpasswd 是文件，不是文件夹，不要新建错了

 1
/root/docker/verdaccio/config.yaml
2
/root/docker/verdaccio/storage
3
/root/docker/verdaccio/plugins
4
/root/docker/verdaccio/htpasswd

[!WARING] 注意，如果没有目录权限的话需要先获取权限 chown -R 10001:65533 /home/verdaccio/storage

修改 config.yaml 文件:

 1
# 存放软件所有软件包的目录
2
storage: /verdaccio/storage
3
# 存放所有插件的目录
4
plugins: /verdaccio/plugins
5
# 存放用户信息设置
6
auth:
7
  htpasswd:
8
    file: /verdaccio/htpasswd

命令启动

修改保存后执行以下命令

 1
V_PATH=/root/docker/verdaccio; docker run -d -it --name verdaccio \
2
  -p 4873:4873 \
3
  -v $V_PATH/conf/config.yaml:/verdaccio/conf/config.yaml \
4
  -v $V_PATH/storage:/verdaccio/storage \
5
  -v $V_PATH/htpasswd:/verdaccio/htpasswd \
6
  -v $V_PATH/plugins:/verdaccio/plugins \
7
  verdaccio/verdaccio

V_PATH=/home/verdaccio ：这个就是给后面 $V_PATH 使用的
docker run -d -it --name verdaccio
1. -d 守护进程之前可能是使用PM2来管理;
2. -it 是 -i 与 -t 的缩写;
3. -i : 以交互模式运行容器，通常与 -t 同时使用；
4. -t : 为容器重新分配一个伪输入终端，通常与 -i 同时使用
5. --name verdaccio : 为容器指定一个名称；
6. \ 换行
7. -p : 指定端口映射，格式为：主机(宿主)端口:容器端口。当然还有-P 随机端口映射，容器内部端口随机映射到主机的端口
8. --volume , -v : 绑定一个卷 : /verdaccio/conf —> /home/verdaccio/conf 等等

启动成功后访问 ip:4873 就可以看到服务启动成功了

docker-compose 启动

如果不想用命令行的方式启动，可以通过 docker-compose 来启动，首先在 verdaccio 目录下创建 docker-compose.yaml 文件，内容如下

 1
version: '3'
2
services:
3
  verdaccio:
4
    image: verdaccio/verdaccio
5
    container_name: 'verdaccio'
6
    networks:
7
      - node-network
8
    environment:
9
      - VERDACCIO_PORT=4873
10
    ports:
11
      - 4873:4873
12
    volumes:
13
      - /root/docker/verdaccio/conf:/verdaccio/conf
14
      - /root/docker/verdaccio/storage:/verdaccio/storage
15
      - /root/docker/verdaccio/htpasswd:/verdaccio/htpasswd
16
      - /root/docker/verdaccio/plugins:/verdaccio/plugins
17
networks:
18
  node-network:
19
    driver: bridge

然后在当前目录下执行

 1
docker-compose up -d

这里我执行完成之后显示正在启动，然后 done 掉了，容器没有启动成功，通过 docker ps -a 查看所有的容器发现 verdaccio 容器状态为失败

查看日志 docker logs verdaccio ：

 1
verdaccio    | info --- config file  - /verdaccio/conf/config.yaml
2
verdaccio    | fatal--- uncaught exception, please report this
3
verdaccio    | Error: EACCES: permission denied, access '/root/docker/verdaccio/storage/data/.sinopia-db.json'
4
verdaccio    |     at Object.accessSync (node:fs:260:3)
5
verdaccio    |     at LocalDatabase._buildStoragePath (/usr/local/lib/node_modules/verdaccio/node_modules/@verdaccio/local-storage/lib/local-database.js:248:19)
6
verdaccio    |     at new LocalDatabase (/usr/local/lib/node_modules/verdaccio/node_modules/@verdaccio/local-storage/lib/local-database.js:27:22)
7
verdaccio    |     at LocalStorage._loadStorage (/usr/local/lib/node_modules/verdaccio/build/lib/local-storage.js:734:14)
8
verdaccio    |     at new LocalStorage (/usr/local/lib/node_modules/verdaccio/build/lib/local-storage.js:33:31)
9
verdaccio    |     at Storage.init (/usr/local/lib/node_modules/verdaccio/build/lib/storage.js:43:25)
10
verdaccio    |     at _default (/usr/local/lib/node_modules/verdaccio/build/api/index.js:121:17)
11
verdaccio    |     at startVerdaccio (/usr/local/lib/node_modules/verdaccio/build/lib/bootstrap.js:50:22)
12
verdaccio    |     at InitCommand.execute (/usr/local/lib/node_modules/verdaccio/build/lib/cli/commands/init.js:63:37)
13
verdaccio    |     at InitCommand.validateAndExecute (/usr/local/lib/node_modules/verdaccio/node_modules/clipanion/lib/advanced/Command.js:73:37)

显式因为权限问题报错了，搞了好久没搞好，本身我的 docker 也不会多少，找朋友问了下，朋友一眼就看出问题了，是因为我的 config.yaml 文件中的配置路径写错了，在 config.yaml 文件中， storage 路径应该是相对于容器内的路径，而不是宿主机的绝对路径。

 1
# 错误路径
2
storage: /root/docker/verdaccio/storage
3
plugins: /root/docker/verdaccio/plugins
4
auth:
5
  htpasswd:
6
    file: /root/docker/verdaccio/htpasswd
7

8
# 正确路径
9
storage: /verdaccio/storage
10
plugins: /verdaccio/plugins
11
auth:
12
  htpasswd:
13
    file: /verdaccio/htpasswd

修改完路径后再次执行 docker-compose up -d 就能正确启动服务了。

另外注意一点，我这里所有的东西都是在 root 目录下操作的，因为是自己的服务器随表搞的，稳妥的做法是将应用程序放在 /opt 目录下，数据放在 /var 目录下。例如可以将 Verdaccio 相关的文件放在 /opt/verdaccio 目录下，配置文件、存储数据等放在 /var/verdaccio 目录下。这样能够保证安全性

配置文件一览

 1
# 存储所有的包文件路径，这里设置为 /verdaccio/storage。
2
storage: /verdaccio/storage
3
# 插件目录，可在该目录中存放一些 Verdaccio 的扩展插件。
4
plugins: /verdaccio/plugins
5

6
# https://verdaccio.org/docs/webui
7
# 与 Verdaccio 的网页界面有关的设置。
8
web:
9
  title: Abiao
10
# 身份验证配置
11
auth:
12
  htpasswd:
13
    file: /verdaccio/htpasswd
14
    # 0 -1
15
    max_users: 1000
16

17
# uplinks 配置，用于定义其他已知的仓库
18
uplinks:
19
  # 将请求代理到官方的 npmjs 仓库。
20
  npmjs:
21
    url: https://registry.npmjs.org/
22

23
# 包配置
24
# https://verdaccio.org/docs/protect-your-dependencies/
25
# https://verdaccio.org/docs/configuration#packages
26
packages:
27
  '@*/*':
28
    # scoped packages
29
    access: $all
30
    publish: $authenticated
31
    unpublish: $authenticated
32
    proxy: npmjs
33
  # 允许所有用户读取 scoped 包，但只有已验证的用户才能发布和取消发布 scoped 包。
34
  # 请求会通过 npmjs uplink 代理到官方的 npmjs 仓库。
35
  '**':
36
    # 通配符配置，适用于其他所有包
37
    access: $all
38

39
    # Allow all known users to publish/publish packages
40
    # (anyone can register by default, remember?)
41
    publish: $authenticated
42
    unpublish: $authenticated
43

44
    # # 允许所有用户读取和发布其他包，请求会通过 npmjs uplink 代理到官方的 npmjs 仓库。
45
    proxy: npmjs
46

47
server:
48
  # 设置 HTTP 连接的 keep-alive 超时时间为 60 秒。
49
  keepAliveTimeout: 60
50
# https://verdaccio.org/docs/configuration#listen-port
51
listen:
52
- 0.0.0.0:4873              # listen on all addresses (INADDR_ANY)
53

54
middlewares:
55
  audit:
56
    enabled: true
57

58
# log settings
59
log: { type: stdout, format: pretty, level: http }
60
# Translate your registry, api i18n not available yet
61
i18n:
62
# list of the available translations https://github.com/verdaccio/verdaccio/blob/master/packages/plugins/ui-theme/src/i18n/ABOUT_TRANSLATIONS.md
63
  web: en-US

NPM配置

初始化

初始化 verdaccio 时需要设置用户名密码等，然后就可以直接发包了

 1
pnpm adduser --registry http://IP:4873/

依次输入 username 、 password 、 email 就创建成功了，创建成功之后可以在 verdaccio/htpasswd 文件中查看到相关的用户信息。

[!WARNING] 注意，如果本地 npm 版本为 npm9 可能会遇到错误 Web login not supported 这时候需要在命令后面加上 --auth-type=legacy

 1
pnpm adduser --registry http://IP:4873/ --auth-type=legacy

参考:

/-/v1/login not implemented (npm login) > [email protected] · Issue #3413 · verdaccio/verdaccio · GitHub

文件错误问题

一开始执行 npm adduser 之后就挂起了，然后去看了下 docker 日志发现上面的错误，一开始以为是权限问题，各种修改权限，查资料都没解决，最后发现是因为 htpasswd 文件被我创建成了文件夹。

权限问题

 1
Error: EACCES: permission denied, open '/verdaccio/htpasswd'
2
http <-- 500, user: null(117.147.119.178), req: 'PUT /-/user/org.couchdb.user:liyang', error: internal server error
3
info <-- 117.147.119.178 requested 'PUT /-/user/org.couchdb.user:liyang'
4
http <-- 200, user: null(117.147.119.178), req: 'PUT /-/user/org.couchdb.user:liyang', bytes: 157/0
5
error--- the user liyang could not being added. Error: EACCES: permission denied, open '/verdaccio/htpasswd'
6
error--- unexpected error: EACCES: permission denied, open '/verdaccio/htpasswd'

用户在新增 npm 用户的时候会写入 htpasswd 文件，由于该文件是在宿主机中，默认是 root 用户建立的，而 verdaccio 容器中拥有自己的用户名，名字就叫 verdaccio，所以无法写入 root 用户拥有的文件。那么是不是还要在宿主机上新建 verdaccio 用户呢？不用这么麻烦。根据官方文档和文末的最后一篇文章得知，docker 容器中的 uid 和 gid 和宿主机是共享的，只不过没有具体的名称，而容器内 verdaccio 使用的 uid 为 10001 ，gid 为 65533 ，所以我们在宿主机改一下 htpasswd 文件的权限
docker环境下verdaccio容器中用户不是当前系统用户
默认情况下 Verdaccio 容器不具有宿主机目录的操作权限。将容器目录挂载到宿主机后， Verdaccio 执行写入操作时，会返回权限错误。解决这个问题，需要赋予 Verdaccio 容器写入宿主机目录的权限。
- sudo chown -R 10001:65533 /volumes/verdaccio
参考链接

npm 版本问题

 1
pnpm adduser --registry --auth-type=legacy http://xxxx:4873/
2
npm WARN invalid config registry="--auth-type=legacy" set in command line options
3
npm WARN invalid config Must be full url with "http://"
4
npm notice Log in on http://42.194.136.132:4873/
5
npm ERR! code ENYI
6
npm ERR! Web login not supported
7

8
npm ERR! A complete log of this run can be found in:
9
npm ERR!     /Users/liyang/.npm/_logs/2023-05-25T15_02_16_668Z-debug-0.log

npm 9 版本会在登录的时候报错 Web login not supported 。可通过上面的方案解决,

发布包

首先需要登录

 1
pnpm login --registry http://IP:4873/
2

3
or
4

5
pnpm login --registry http://IP:4873/ --auth-type=legacy

进入项目中发布

 1
npm publish

刷新网站查看没问题的话就可以看到刚刚上传的包了。

Yang

Verdaccio部署私有NPM包服务

Thursday, April 25, 2024
0 views
2 mins

前言

安装

启动

CLI 启动参数

PM2启动

使用 Docker

命令启动

docker-compose 启动

配置文件一览

NPM配置

初始化

文件错误问题

权限问题

npm 版本问题

发布包

Verdaccio部署私有NPM包服务

Thursday, April 25, 2024 (()=>{var e=async t=>{await(await t())()};(self.Astro||(self.Astro={})).load=e;window.dispatchEvent(new Event("astro:load"));})();0 views 2 mins

前言

安装

启动

CLI 启动参数

PM2启动

使用 Docker

命令启动

docker-compose 启动

配置文件一览

NPM配置

初始化

文件错误问题

权限问题

npm 版本问题

发布包

Thursday, April 25, 2024
0 views
2 mins