使用 Verdaccio 搭建私有 NPM 库

NPM 介绍

npm 为你和你的团队打开了连接整个 JavaScript 天才世界的一扇大门。它是世界上最大的软件注册表,每星期大约有 30 亿次的下载量,包含超过 600000 个 包(package) (即,代码模块)。来自各大洲的开源软件开发者使用 npm 互相分享和借鉴。包的结构使您能够轻松跟踪依赖项和版本。

私有 NPM

需求背景

平时在项目工作中可能会用到很多通用性的代码,比如,框架类、工具类以及公用的业务逻辑代码等等,通过打包发布到 npm 中央仓库或者私有仓库,来进行维护和托管代码,方便公用代码的使用,如果涉及到不方便公开的代码组件可以发布到私有仓库。

私有 npm 组件库的优势

  • 私有 npm 包只对公司内部局域网开放
  • 速度比直接在 npm 下载包更快,也比使用淘宝镜像快,毕竟是在公司内部局域网
  • 对于发布和下载 npm 包可以配置权限管理

同类产品对比

在研究搭建 npm 私有组件仓库时,查阅了很多相关方面的资料,有使用 maven 包管理的私服工具 nexus 搭建私有仓库的,也有使用阿里的 cnpm 搭建私有仓库的,还有使用 sinopia 和 verdaccio 搭建私有仓库的,下面介绍一下它们的主要区别:

Verdaccio

简介

Verdaccio - 轻量级私有 npm 代理注册表

安装与部署

系统与环境

  • 系统 CentOS 7.7
  • 环境 node v12.13.0
  • 部署 PM2 (一个带有负载均衡功能的 Node 应用的进程管理器。)
安装

npm install --global verdaccio --unsafe-perm,因为我们使用的是 root 用户,所以需要加上--unsafe-perm参数

启动

终端运行 verdaccio

[root@svrcnyapi ~]# verdaccio
*** WARNING: Verdaccio doesn't need superuser privileges. Don't run it under root! ***
 warn --- config file  - /root/.config/verdaccio/config.yaml
 warn --- Verdaccio started
 warn --- Plugin successfully loaded: verdaccio-htpasswd
 warn --- Plugin successfully loaded: verdaccio-audit
 warn --- http address - http://localhost:4873/ - verdaccio/4.3.4

此时,verdaccio 服务已经启动,但是此时只能通过 http://localhost:4873 访问,为此,我们需要对配置进行修改:

vi /root/.config/verdaccio/config.yaml

在配置末尾添加:

listen:
  0.0.0.0:4873

终端重新运行 verdaccio

[root@svrcnyapi ~]# verdaccio
*** WARNING: Verdaccio doesn't need superuser privileges. Don't run it under root! ***
 warn --- config file  - /root/.config/verdaccio/config.yaml
 warn --- Verdaccio started
 warn --- Plugin successfully loaded: verdaccio-htpasswd
 warn --- Plugin successfully loaded: verdaccio-audit
 warn --- http address - http://0.0.0.0:4873/ - verdaccio/4.3.4

此时,我们可以通过对应部署的服务器 ip,访问其网站,例如:http://ip:4873

202001191132.png

上述启动方式过于简单,并且不能做到一直启动、开机自启动等功能,所以这是我们采用 pm2 来管理:

部署

安装

npm install -g pm2

执行

pm2 start verdaccio

┌────┬─────────────────────────┬─────────┬─────────┬──────────┬────────┬──────┬──────────┬──────────┬──────────┬──────────┬──────────┐
│ id │ name                    │ version │ mode    │ pid      │ uptime │ ↺    │ status   │ cpu      │ mem      │ user     │ watching │
├────┼─────────────────────────┼─────────┼─────────┼──────────┼────────┼──────┼──────────┼──────────┼──────────┼──────────┼──────────┤
│ 1  │ verdaccio               │ N/A     │ fork    │ 13439    │ 0s     │ 0    │ online   │ 0%       │ 8.9mb    │ root     │ disabled │
│ 0  │ yapi_v1.8.5             │ 1.8.5   │ fork    │ 2436     │ 2D     │ 0    │ online   │ 0%       │ 70.6mb   │ root     │ disabled │
└────┴─────────────────────────┴─────────┴─────────┴──────────┴────────┴──────┴──────────┴──────────┴──────────┴──────────┴──────────┘

保证一直运行、开机自启,依次执行以下命令

pm2 save 获取当前运行的 Node 应用程序的快照

pm2 startup 产生 init 脚本 保持进程活着

至此,我们就拥有了一个稳定的私有 NPM 注册中心。

NPM 发布相关操作命令,详见 npm 发布包教程

设置 npm 源

npm set registry http://ip:4873

设置当前 npm 源为私有 npm 库

注册

npm adduser --registry http://ip:4873

依次输入 npm 账号用户名、密码和邮箱

登录

npm login

Username: gac
Password:
Email: (this IS public) gac@xxx.com
Logged in as gac on http://ip:4873/.

发布

进入将要发布的项目根目录,输入命令:

npm publish --registry http://ip:4873

npm notice === Tarball Details ===
npm notice name:          @demo/test
npm notice version:       1.0.0
npm notice package size:  5.7 MB
npm notice unpacked size: 8.7 MB
npm notice shasum:        33d09bf57d034a09dffd982bb9b5811063cf73e9
npm notice integrity:     sha512-cJOnKk639iNmR[...]E84CkzJUtkfOw==
npm notice total files:   598
npm notice
+ @demo/test@1.0.0

提示成功后,在浏览器中刷新 http://ip:4873 页面,将会看到已发布的 npm 包

202001191325.png

下载

之后使用私有仓库中的 npm 包,就和平时 npm 操作一样了。会优先私有 npm 库中查找,如若找不到,再去其他源查找(可配置多个外部链 uplink ,默认 npmjs 官方源)

npm 多源管理

nrm - 一个 NPM 源管理器,帮助你在不同 NPM 源中切换。

一般为了保证下载顺利,我们需要切换不同的 npm 源,这里推荐 nrm 进行管理。

安装

npm install -g nrm

使用

nrm ls - 查看当前注册的 NPM 源列表

nrm ls

  npm -------- https://registry.npmjs.org/
  yarn ------- https://registry.yarnpkg.com/
  cnpm ------- http://r.cnpmjs.org/
* taobao ----- https://registry.npm.taobao.org/
  nj --------- https://registry.nodejitsu.com/
  npmMirror -- https://skimdb.npmjs.com/registry/
  edunpm ----- http://registry.enpmjs.org/

nrm add demo http://ip:4873/ -将我们之前部署的私有库加入 nrm,取名“demo”

再次查看 nrm ls,显示多出一条


  npm -------- https://registry.npmjs.org/
  yarn ------- https://registry.yarnpkg.com/
  cnpm ------- http://r.cnpmjs.org/
* taobao ----- https://registry.npm.taobao.org/
  nj --------- https://registry.nodejitsu.com/
  npmMirror -- https://skimdb.npmjs.com/registry/
  edunpm ----- http://registry.enpmjs.org/
  demo -------- http://ip:4873/

nrm use demo - 设置当前 npm 源

nrm use demo


   Registry has been set to: http://ip:4873/

有了 nrm,我们就可以随时切换我们需要的 npm 源了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,117评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,963评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,897评论 0 240
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,805评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,208评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,535评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,797评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,493评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,215评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,477评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,988评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,325评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,971评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,807评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,544评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,455评论 2 266