一、Verdaccio 是什么?
Verdaccio 是一个流行的 Node.js 包管理器的代理工具,它允许您在本地或私有网络上轻松地创建和管理 npm 包仓库。通过 Verdaccio,开发团队可以建立自己的 npm 包仓库,以更好地控制和管理其依赖项,同时还可以提供更快速的包下载速度,减轻 npm 中心服务器的负载。
二、Verdaccio 的工作原理
Verdaccio 的核心原理是代理 npm 注册表。它可以被视为一个本地 npm 注册表的缓存,并提供了一个用户友好的界面,使您能够在其中发布、安装和管理包。其工作原理如下:
1、代理 npm 注册表:Verdaccio 允许您配置它以代理 npm 的官方注册表或其他任何 npm 注册表。当您尝试安装、发布或访问包时,Verdaccio 将首先查看本地缓存,如果找到所需的包,它将立即提供。如果没有找到,它将向上游注册表发送请求,获取包并将其缓存到本地以供将来使用。
2、本地包存储:Verdaccio 提供了本地包存储的功能,这意味着您可以在本地创建和发布自己的 npm 包,无需将其发布到公共 npm 注册表。这对于内部项目、私有库或需要保护知识产权的情况非常有用。
3、安全性:Verdaccio 支持访问控制、身份验证和权限管理,您可以通过配置来限制谁可以发布、访问或管理仓库中的包。这有助于保护您的包和代码免受未经授权的访问和修改。
4、高度可定制性:Verdaccio 可以根据您的需求进行高度定制。您可以配置其插件、主题、中间件和许多其他选项,以满足特定项目或组织的要求。
三、安装和配置Verdaccio
1、安装Verdaccio
这里要求node版本至少18以上,否则后面没法启动
npm install -g verdaccio
2、配置 Verdaccio
安装完成后,会生成一个配置文件(/Users/wave/AppData/Roaming/verdaccio/config.yaml
),你可以编辑这个文件来配置你的npm私服:
我们这里主要就先去修改一个uplinks中的上行地址,可以修改为https://registry.npmmirror.com/
storage: /verdaccio/storage/
#默认使用内置本地文件模式存储,包存储地址,publish时仓库保存包的目录
plugins: /verdaccio/plugins
#插件目录的位置。 对Docker/Kubernetes 基础上的配置非常有用
# UI信息
web:
enable: true
#开启 Web 页面
title: Sinux-Npm-Register
#Web页面标题
# logo: #这里可以给定一个远程连接的图片,注释掉就采用默认的
# comment out to disable gravatar support
gravatar: true
# by default packages are ordercer ascendant (asc|desc)
# sort_packages: asc #包的排序
# darkMode: true #黑暗模式
# scope: "@scope"
# 身份认证设置
auth:
htpasswd:
#默认情况下使用的 htpasswd 插件作为身份认证
file: /verdaccio/storage/htpasswd
#用户信息-账号密码的文件地址存储目录,初始化时不存在,可指定需要手工创建
max_users: -1
#默认1000,为允许用户注册的数量。此配置项为-1时不允许用户通过npm adduser注册,但是,当为-1时,可以通过直接编写htpasswd file内容的方式添加用户(最大用户数量,-1 表示禁用新用户注册)
i18n:
# list of the available translations https://github.com/verdaccio/ui/tree/master/i18n/translations
web: zh-CN #默认是en-US,我们改为默认中文,这个支持多语言
# 上行链路
uplinks:
#上行链路:配置上游的npm服务器,主要用于请求的包仓库不存在时到上游服务器去拉取。
npmjs: #上行名称,随便定义
url: https://registry.npmjs.org/ #上行地址
yarn:
url: https://registry.yarnpkg.com/
timeout: 10s #超时时间
taobao:
url: https://registry.npm.taobao.org/
timeout: 10s
# 包访问设置,可以根据名称对包做不同权限的设置
packages:
#配置模块。access访问下载权限,publish包的发布权限。
"@*/*":
#@/ 表示某下属的某项目,* 匹配项目名称(名称在package.json中有定义)
#三种身份:所有人,匿名用户,认证(登陆)用户
#"$all", "$anonymous", "$authenticated"
access: $authenticated
#access: 访问下载
publish: $authenticated
#publish: 发布
unpublish: $authenticated
#取消发布
proxy: npmjs
#代理上行链路地址
#proxy: 这里的值是对应于uplinks的名称,如果本地不存在,允许去对应的uplinks去取。
#$all 表示所有人(已注册、未注册)都可以执行对应的操作
#$authenticated 已注册账户可操作
#$anonymous 匿名用户可操作(通常无用)
#或者也可以指定对应于之前我们配置的用户表 htpasswd 中的一个或多个用户,这样就明确地指定哪些用户可以执行匹配的操作。
"**":
access: $authenticated
#登录用户才允许访问
publish: $authenticated
#登录用户才允许访问
unpublish: $authenticated
#登录用户才允许访问
proxy: npmjs yarn taobao
#代理上行链路地址
server:
keepAliveTimeout: 60
#服务器保持活动链接的时间,较大的包可能会消耗一定时间,此属性就是设置活动链接时间
middlewares:
audit:
enabled: true
#listen:localhost:4873 #默认,只能本机访问。
listen: 0.0.0.0:4873 #监听的端口:允许所有外网监听。
# 日志设定
logs: { type: stdout, format: pretty, level: http }
#type: stdout --- 控制台输出; file --- 输出到文件
#path: 如果输出到文件类型,需要制定输出路径
#format: 输出格式 [pretty, pretty-timestamped]
#level: 日志级别 [fatal, error, warn, http, info, debug, trace]
四、启动Verdaccio
verdaccio
五、配置npm源地址
// 查看源地址
npm config list
// 切换npm源地址
npm config set registry http://localhost:4873/
六、发布包到npm私服
登录到你的npm私服
npm login --registry http://localhost:4873/
查看当前用户信息
npm who am i
然后,在你的包目录下运行:
npm publish
最后,刷新本地私服看到如下界面,代表已成功上传。
验证:可以新建一个test项目,去安装试试,是否能安装成功
npm i wavetools