ubuntu搭建node私库Verdaccio
Verdaccio 是一个轻量级的私有 npm 代理注册服务器,它是开源的,可以帮助你设置和维护企业内部的 npm 包的存储库。使用 Verdaccio 可以让你完全控制包的发布流程、依赖关系以及访问策略。这篇文章将指导你如何在 Ubuntu 系统上安装和配置 Verdaccio。
关于如何使用Verdaccio(包的构建,推送和拉取),请参阅:Node私库Verdaccio使用记录,包的构建,推送和拉取
以下是关于 Verdaccio 的一些关键特点:
-
简单部署:Verdaccio 可以很容易地使用 npm 安装,并且可以通过一个简单的配置文件进行配置。
-
兼容性:它完全兼容 npm 的客户端,所以你可以直接使用 npm 或 yarn 命令与它交互。
-
私有和代理功能:你可以将 Verdaccio 配置为存储私有包,同时作为公共 npm 注册中心的缓存代理,这样可以提高依赖项安装的速度并减少对外部网络的依赖。
-
轻量级和高效:Verdaccio 非常适合小到中型企业,不需要复杂的硬件支持。
-
安全性:支持通过 htpasswd 或外部插件如 LDAP, OAuth 等进行用户认证。
-
可扩展性:支持插件系统,可以通过插件来扩展其功能,例如增加通知、集成支付接口等。
安装必要的软件
要在 Ubuntu 上成功安装和运行 Verdaccio,需要确保满足以下条件:
-
Node.js 版本: 需要安装 Node.js v14 或更高版本。
-
包管理器: 推荐使用最新版本的 npm、pnpm 或 yarn(包括 classic 和 berry 版本)。不支持 npm@5.x 或更早版本。
在安装 Verdaccio 前,你需要确保你的系统上安装了 Node.js 和 npm。这里将展示如何在 Ubuntu 上安装 Node.js 和 npm。
# 安装 Node.js
sudo apt update
sudo apt install -y nodejs npm
# 检查 Node.js 和 npm 的安装版本
node -v
npm -v
如果已经安装了nodejs,或者误装了nodejs版本不对需要重新安装,参考下面章节的说明
安装 Verdaccio
使用 npm 可以轻松安装 Verdaccio。
# 全局安装 Verdaccio
sudo npm install -g verdaccio
启动 Verdaccio
配置文件设置完成后,可以通过下面的命令来启动 Verdaccio。
verdaccio
设置开机启动
要将 Verdaccio 服务关联到 systemctl
进行管理,你需要创建一个 systemd 服务单元文件。这允许你使用 systemd 的命令来启动、停止、重启以及查看 Verdaccio 服务的状态。以下是创建和配置 Verdaccio systemd 服务的步骤:
1. 创建 systemd 服务文件
首先,你需要在 /etc/systemd/system/
目录下创建一个名为 verdaccio.service
的文件:
sudo vim /etc/systemd/system/verdaccio.service
在这个文件中,填入以下内容:
[Unit]
Description=Verdaccio - Private npm registry
After=network.target
[Service]
Type=simple
User=root # 替换为运行 Verdaccio 的用户,通常可以是 'verdaccio' 或者你的普通用户
Environment=NODE_ENV=production
WorkingDirectory=/root/verdaccio # 根据 Verdaccio 安装的位置可能需要调整
ExecStart=/usr/local/bin/verdaccio # 根据 Verdaccio 安装的位置可能需要调整
Restart=always
RestartSec=10
# 指定日志目录,如果需要的话
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=verdaccio
[Install]
WantedBy=multi-user.target
确保你调整 User
, WorkingDirectory
, 和 ExecStart
字段以匹配你的系统和 Verdaccio 的安装细节。
使用which verdaccio
命令查看verdaccio实际的执行文件路径,用来替换ExecStart
字段值
2. 重新加载 systemd 管理器配置
创建或修改 systemd 文件后,需要重新加载 systemd 配置,以确保 systemd 知道新的或修改的服务:
sudo systemctl daemon-reload
3. 启动 Verdaccio 服务
使用以下命令启动 Verdaccio 服务:
sudo systemctl start verdaccio
4. 设置 Verdaccio 服务开机自启
如果你希望 Verdaccio 在系统启动时自动启动,可以使用 enable
命令:
sudo systemctl enable verdaccio
5. 检查服务状态
要查看 Verdaccio 服务的状态,可以使用:
sudo systemctl status verdaccio
这会显示 Verdaccio 服务的当前状态、日志输出等信息。
6. 查看和管理日志
由于我们设置了日志输出到 syslog,你可以通过 journalctl
来查看 Verdaccio 的日志:
sudo journalctl -u verdaccio
放开verdaccio只能本地链接的host限制
Verdaccio 默认对访问进行一些限制,包括限制访问注册中心的 IP 地址或域名。如果你想让 Verdaccio 服务对所有域名开放,或者不限制特定的域名访问,你可以通过修改 Verdaccio 的配置文件来实现。
Verdaccio 的配置文件通常名为 config.yaml
,位于 Verdaccio 的安装目录下。下面是一些基本步骤来配置 Verdaccio,使其不限制域名:
1. 找到并编辑配置文件
首先,你需要找到 Verdaccio 的配置文件 config.yaml
。这个文件的位置可能因你的安装方式而异。如果你不确定位置,可以从 Verdaccio 启动日志中找到或检查你的服务配置。
2. 配置监听地址
在 config.yaml
文件中,找到 listen
字段。默认情况下,这可能设置为 localhost
或 127.0.0.1
,这意味着 Verdaccio 只能在本地访问。要让它能从任何地方访问,你需要将其改为:
# listen on all IPv4 interfaces
listen: 0.0.0.0:4873
如果你的服务器同时使用 IPv6,你也可以设置:
# listen on all IPv4 and IPv6 interfaces
listen:
- "0.0.0.0:4873"
- "[::]:4873"
3. 关闭访问控制(可选)
如果你的 Verdaccio 配置中包含了针对用户或 IP 的访问控制,你可能还需要修改这部分设置。通常这涉及到 packages
配置块中的 access
和 publish
权限设置。例如,要允许任何人访问和发布包,你可以设置:
packages:
'@*/*':
access: $all
publish: $all
unpublish: $all
'**':
access: $all
publish: $all
unpublish: $all
4. 重新启动 Verdaccio
修改配置后,你需要重启 Verdaccio 服务使改动生效。这可以通过直接重启 Verdaccio 进程或使用你的系统管理工具(如 systemd)来完成。
# 如果你是直接运行 Verdaccio,可以先停止然后重新启动
# Ctrl+C 停止 Verdaccio
verdaccio
或者,如果你使用的是如 systemd 的服务管理工具:
sudo systemctl restart verdaccio
重装nodejs到最新稳定版本
使用apt install npm
可能导致默认的node版本过低,verdaccio有版本限制。如果误装了不合适的版本,可以参考这里进行重新安装。
NodeSource 提供了一个很方便的脚本来安装最新版本的 Node.js。你可以根据需要选择最新的 LTS 版本或最新的当前版本。
-
移除旧版本的 Node.js(如果已安装):
sudo apt-get remove nodejs npm
-
使用 NodeSource 安装脚本:
你可以从 NodeSource 选择你需要的 Node.js 版本。例如,要安装最新的 LTS 版本,使用以下命令:curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
或者,如果你想安装最新的当前版本(可能不是 LTS):
curl -fsSL https://deb.nodesource.com/setup_current.x | sudo -E bash -
-
安装 Node.js:
sudo apt-get install -y nodejs
通过以下命令验证 Node.js 的安装和版本:
node -v
安装报错记录
上面步骤在执行到sudo apt-get install -y nodejs报错了,内容如下:
Get:1 https://deb.nodesource.com/node_20.x nodistro/main amd64 nodejs amd64 20.12.2-1nodesource1 [31.6 MB]
Fetched 31.6 MB in 5s (6,933 kB/s)
(Reading database ... 174177 files and directories currently installed.)
Removing nodejs-doc (12.22.9~dfsg-1ubuntu3.5) ...
Selecting previously unselected package nodejs.
(Reading database ... 173997 files and directories currently installed.)
Preparing to unpack .../nodejs_20.12.2-1nodesource1_amd64.deb ...
Unpacking nodejs (20.12.2-1nodesource1) ...
dpkg: error processing archive /var/cache/apt/archives/nodejs_20.12.2-1nodesource1_amd64.deb (--unpack):
trying to overwrite '/usr/include/node/common.gypi', which is also in package libnode-dev 12.22.9~dfsg-1ubuntu3.5
dpkg-deb: error: paste subprocess was killed by signal (Broken pipe)
Errors were encountered while processing:
/var/cache/apt/archives/nodejs_20.12.2-1nodesource1_amd64.deb
E: Sub-process /usr/bin/dpkg returned an error code (1)
出现这个错误是因为新版本的 Node.js 试图覆盖由旧版本的 libnode-dev 包占用的文件。这种情况通常发生在升级 Node.js 时,旧的库文件未被完全清除。你可以通过以下步骤解决这个问题:
1. 解决包冲突
首先,你需要删除与 Node.js 相关的旧库文件,这样新版本的安装就不会与它们冲突。
-
移除冲突的包:
sudo apt-get remove libnode-dev
-
清理和更新你的包管理器:
sudo apt-get clean sudo apt-get update
-
尝试重新安装 Node.js:
sudo apt-get install -y nodejs
如果直接移除 libnode-dev
并不能解决问题,或者你需要这个包的其他依赖性,可以考虑使用 dpkg
来强制覆盖冲突文件:
2. 使用 dpkg
强制安装
这个方法将会忽略文件冲突的问题并强制安装新的包。请注意,这种方法可能会打破依赖关系,所以应当谨慎使用。
sudo dpkg -i --force-overwrite /var/cache/apt/archives/nodejs_20.12.2-1nodesource1_amd64.deb
完成后,确保系统的依赖关系和包的完整性:
sudo apt-get -f install
总结
安装和配置 Verdaccio 在 Ubuntu 上相对简单,通过以上步骤,你可以快速搭建起自己的 npm 私库。Verdaccio 不仅能帮你管理私有包,还可以缓存公有 npm 包,极大提升内部开发效率。
参考链接
- Verdaccio 官网:https://verdaccio.org/docs/installation
- npm 官网:https://www.npmjs.com/
- Node.js 官网:https://nodejs.org/