handbook
handbook
handbook
下面通过三种方法来搭建公司私有npm仓库，每种方式都有自己的优势。
Node.js >= 6.11.3，我的Node版本：node v8.2.1
Linux or OSX，我的系统版本：CentOS Linux release 7.2.1511 (Core)
注意 ⚠️： 现在 Gitlab v13.7.x 自带私有仓库，只需要开启 Container Registry
npm install -g --build-from-source cnpmjs.org cnpm sqlite3
# 如果报错或者警告通过下面方式安装
npm install -g --unsafe-perm --verbose --build-from-source cnpmjs.org cnpm sqlite3
如果安装不流畅通过下面形式安装：
npm install -g --build-from-source \
--registry=https://registry.npm.taobao.org \
--disturl=https://npm.taobao.org/mirrors/node \
cnpmjs.org cnpm sqlite3
如果报警告或者安装错误，请添加参数--unsafe-perm --verbose
管理员：
myname,othername
范围：my-company-name,other-name
默认端口：7001-registry, 7002-web
启动服务
$ nohup cnpmjs.org start --admins='myname,othername' \
--scopes='@my-company-name,@other-name' &
将cnpm默认注册地址更改为私有注册地址
cnpm set registry http://localhost:7001
$ cnpm login
Username: myname
Password: ***
Email: (this IS public) test@test.com
新建项目
$ cd /tmp
$ mkdir helloworld && cd helloworld
$ cnpm init
name: (helloworld) @my-company-name/helloworld
version: (1.0.0)
{
"name": "@my-company-name/helloworld",
"version": "1.0.0",
"description": "my first scoped package",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
上传到私有仓库
$ cnpm publish
+ @my-company-name/helloworld@1.0.0
浏览器中预览
open http://localhost:7002/@my-company-name/helloworld
使用cnpm预览
cnpm info
所有公共包都可直接使用cnpm安装
cnpm install hotkeys-js
verdaccio 是一个轻量级的私有npm代理注册。（sinopia fork）
# 使用 npm 安装
npm install -g npm
# 使用 yarn 安装
yarn global add verdaccio
verdaccio -l 192.168.188.224:4873 >> verdaccio.log 2>&1 &
verdaccio >> verdaccio.log 2>&1 & # 后台启动并写入日志
# Verdaccio doesn't need superuser privileges. Don't run it under root.
# warn --- config file - /root/.config/verdaccio/config.yaml
# warn --- http address - http://localhost:4873/ - verdaccio/2.3.6
verdaccio --listen 4000 --config ./config.yaml # 指定配置启动
npm adduser --registry http://localhost:4873
npm publish --registry http://localhost:4873
npm config list -l # 查看默认配置
# 将默认地址 https://registry.npmjs.org/ 改成私有地址
npm set registry http://localhost:4873
# 如果您使用HTTPS，请添加适当的CA信息
#（“null”表示从操作系统获取CA列表）
$ npm set ca null
这个方法得益于，npm提供的的丰富安装方法。通过下面方法安装：
npm i -S git+ssh://git@git.showgold.cn:npm/hello.git
npm install -S git+ssh://git@github.com:npm/npm.git#v1.0.27
npm install -S git+ssh://git@github.com:npm/npm#semver:^5.0
npm install -S git+https://isaacs@github.com/npm/npm.git
npm install -S git://github.com/npm/npm.git#v1.0.27
⚠️ 上面安装需要注意：你的工程一定是在某一个组下面建立，方便管理，在生成你的包的时候package.json中的name一定要带上范围
# 假设你建立了一个Git仓库，先克隆下来
git clone http://git.your-inc.com/companyfe/hello-private.git
# 生成 `package.json` 配置, 注意限定 `@scope` 范围
npm init --scope=companyfe
# 提交到仓库
git push origin master
⚠️ 将得到如下依赖，注意：
name字段必须限定范围，一般为 GitLab group 的名字, 例如@companyfe, 那么name为:@companyfe/hello-private。private设为true防止将私有模块上传到公网上去，需要手动设置一下。
{
"name": "@companyfe/hello-private",
"version": "1.0.1",
"description": "",
"main": "index.js",
"private":true,
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "kenny wang <wowohoo@qq.com> (http://wangchujiang.com)",
"license": "ISC"
}
跟安装开源的模块一样, 使用 npm install 安装依赖即可. 私有模块会安装在 @scope 的子文件夹中, 例如: node_modules/@companyfe/hello-private.
# 基础安装
npm i -S git+ssh://git@git.your-inc.com/companyfe/hello-private.git
# 带版本信息的，必须通过 git 打 tag
npm i -S git+ssh://git@git.your-inc.com/companyfe/hello-private.git#v1.2.0
将得到如下依赖
{
"name": "helloworld",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"dependencies": {
"@companyfe/hello-private": "git+ssh://git@git.your-inc.com/companyfe/hello-private.git#v1.2.0"
},
"author": "kenny wang <wowohoo@qq.com> (http://wangchujiang.com)",
"license": "ISC"
}
使用私有模块
var hello = require('@companyfe/hello-private');
不好的地方是，使用 npm update 是无法更新私有模块，想更新只能重新安装一次。好处是不用搭建服务。