业界主流的私有npm仓库搭建的主流方案有如下几种:
1、付费购买
2、使用 git+ssh 这种方式直接引用到 GitHub 项目地址
3、使用Verdaccio
4、使用cnpmjs.org
第一种,一是考虑到公司可能不会提供经费,二npm在国内访问很慢,就是花钱也买不到好的体验。
第二种,不能更新即npm update,不能使用semver(语义化版本规范)。
那么较好的选择就只剩下第三种和第四种。
下面将分别使用基于Verdaccio和基于cnpmjs.org这两种方案来搭建私有npm仓库并进行总结。
1. Verdaccio方案篇
1.1 服务端部署
安装:npm install -g verdaccio
启动:verdaccio
warn --- config file - C:\Users\Administrator\.config\sinopia\config.yaml
warn --- http address - http://localhost:4873/
此时访问localhost:4873,可获取html文件并且服务端响应正常,表示安装成功。
配置
运行verdaccio,自动生成的工作目录如下(通过第一个warn可以看到具体路径):
C:\Users\Administrator\.config\sinopia\config.yaml
|-- config.yaml //存放所有配置信息
|-- htpasswd //存放所有账户信息
|-- storage //存放私有npm包及缓存公有包
|-- npm_test
config.yaml默认配置
storage: F:\verdaccio\storage //npm包存放的路径
auth:
htpasswd:
file: ./htpasswd //保存用户的账号密码等信息
uplinks:
npmjs:
url: https://registry.npmjs.org/ //拉取公共包的地址源,默认为npm的官网,可以使用淘宝的npm镜像地址
packages: //配置权限管理
'@*/*':
access: $all
publish: $authenticated
'*':
access: $all
publish: $authenticated
proxy: npmjs
logs:
- {type: stdout, format: pretty, level: http}
listen: 0.0.0.0:4873 // 设置可以同域名访问
i18n:
web: zh-CN // 设置管理界面默认中文
1.2 客户端配置
配置npm registry(建议客户端使用nrm 进行npm registry地址管理和切换)
npm install -g nrm // 安装
nrm add verdaccio http://192.168.xx.xx:4873 // 添加verdaccio仓库地址
nrm use verdaccio // 切换私有仓库
nrm ls // 查看所有仓库地址(星标为当前仓库源)
1.3 发包
切换到私有仓库之后,发包的操作跟npm发包基本无差别。
npm login
npm whoami
npm publish
注: 版本号重复的情况再次发布的包不会主动更新,并且发布不会有错误提示,更新包务必更新版本号。发布成功后私有仓库站点会显示包情况,README.md文件会作为详情描述展开。
2.cnpmjs.org方案篇
2.1 服务端部署
官方依赖如下图:
安装:cnpmjs.org
npm i -g cnpmjs.org
cnpmjs.org默认安装路径:D:\Program Files\nodejs\node_global\node_modules\cnpmjs.org
修改 :默认安装路径\config\index.js
/* * server configure //服务器配置 */
registryPort: 7001, //仓库访问端口(执行发布安装)
webPort: 7002, //展示查询站点访问端口
bindingHost: '', //监听绑定的 Host,默认127.0.0.1,外网访问注释掉此项即可
/** * database config //数据库相关设置 */
database: {
db: 'cnpmjs_test', //数据库名称
username: 'root', //数据库访问账号
password: '', //数据库访问密码
dialect: 'sqlite', //使用数据库,默认sqlite
host: '127.0.0.1', //数据库访问IP,通常127.0.0.1
port: 3306, //数据库访问端口,通常3306
// 模块文件存储,默认将发布的私有模块跟缓存公共模块存储在本地文件系统中,路径~/.cnpmjs.org/nfs ,也就是模块文件都存储在这个目录下;或者可以选择三方储存方式比如七牛等,着这里配置插件;也支持接口开发扩展储存;
nfs: require('fs-cnpm')({
dir: path.join(dataDir, 'nfs')
}),
// registry url name //模块注册列表访问域名,默认r.cnpmjs.org,安装模块时会到这个域名下查找,这个默认设置略坑,建议没有外网域名的先清空回头再配
registryHost: '',
// default system admins //默认管理员账号
admins: {
admin: '[email protected]',
},
/* * registry mode config 私有模块发布相关配置*/
//是否开启私有模式,默认为 false; 私有模式下只有管理员能发布模块,其他账号只有同步权限 ;非私有模式,注册用户都可以发布模块
enablePrivate: false,
//若为非私有模式发布则此项必填,非管理员发布模块式命名必须以scopes字段开头,模块命名示例“@cnpm/packagename”
scopes: [ '@cnpm', '@cnpmtest', '@cnpm-test' ],
// 私有模块非scopes白名单,各种非以scope方式发布的老模块的白名单管理,数组形式维护
privatePackages: [],
//npm官方registry地址,不会直接从这个地址同步模块,但有时会从这里获取模块信息,除非必要请勿更改
officialNpmRegistry: 'https://registry.npmjs.com',
officialNpmReplicate: 'https://replicate.npmjs.com',
//同步模块上游registry地址
sourceNpmRegistry: 'https://registry.npm.taobao.org',
/上游registry是否是cnpm,默认true,若要使用npm官方地址作为同步上游,请设置为false
sourceNpmRegistryIsCNpm: true,
//若安装时模块不存在,是否向源registry进行同步,默认true
syncByInstall: true,
// 同步模式选项 : none: 不进行同步,只管理用户上传的私有模块,公共模块直接从上游获取 ; exist: 只同步已经存在于数据库的模块 ; all: 定时同步所有源registry的模块
syncModel: 'exist', // 'none', 'all', 'exist'
// 同步时间间隔,默认10分钟
syncInterval: '10m',
// 是否同步模块中devDependencies,默认false
syncDevDependencies: false,
//用户账号系统接入,可以扩展接入公司的账号系统
userService: null,
数据库准备
安装:npm install -g split3
初始表格:执行 默认安装路径\models\init_script.js
启服务
npm install -g pm2 // 进程管理器
pm2 start dispatch(默认安装路径\dispatch.js)
pm2 stop id
pm2 delete id
访问对应的IP加访问端口即可看到,展示站点如下图
图7 start之后示意图
我们可以搜索我们想要的包,如果没有可以选择sync进行同步。
图8 选择同步
选择同步之后,后有如下同步过程
图9 同步过程
2.2 客户端配置
nrm add localCnpm 192.xxx.x.x:7001
2.3 发布私有模块
同上
如果你是一个想要拥有私人npm仓库的个人开发者或者小团队,Sinopia完全可以满足需求;如果想要对私人npm服务做更多个性化定制方案,那么cnpm的扩展性支持更加友好。