npm私有庫服務搭建及規範定製

npm私有庫服務

---

簡介

公司出於自身隱私保護須要,不想把本身的代碼開源到包管理區，可是又急需一套完整包管工具，來管理愈來愈多的組件、模塊和項目。對於前端，最熟悉的莫過於npm，bower等；可是bower的市場兼容性明顯沒有npm強壯，加之commonjs規範的日益成熟。npm應該是前端包管理的不二選擇。

公司對於搭建本地私有npm庫有以下要求：

1. 私有包託管在內部服務器中
2. 項目中使用了公共倉庫上的公共包，也使用了內部服務器上的私有包
3. 但願下載的時候，公共包走公共倉庫，私有包走內部服務器的私有倉庫
4. 服務器硬盤有限，但願只緩存下載過的包，而不是所有同步。
5. 對於下載，發佈npm包有對應的權限管理，安裝方便，配置簡單，依賴少。

---

安裝私有包流程

---

服務搭建

node + npm + verdaccio + pm2 + nrm

Sinopia Verdaccio是一個零配置的私有的帶緩存功能的npm包管理工具

PS: Sinopia多年未更新，Verdaccio是基於Sinopia重構的，注入了更多活力

# config
$ /home/ubuntu/.config/verdaccio/config.yaml
# password
$ /home/ubuntu/web_npm/verdaccio/htpasswd
# storage
$ /home/ubuntu/web_npm/verdaccio/storage
複製代碼

pm2 託管Sinopia進程能夠保證進程永遠存活 nrm 便於查看和切換當前使用的registry verdaccio-delegated-auth 是爲了讓服務支持自定義驗證的插件

---

標準定製

# Sinopia config.yaml
# path to a directory with all packages
storage: /home/ubuntu/web_npm/verdaccio/storage
auth:
  # htpasswd:
    # file: ./htpasswd
    # max_users: -1
    # mix_users: 1000
 delegated-auth:
    url: https://your-account-server/
    user_key: name # username field, default: username
    pwd_key: password # password field, default: password

# a list of other known repositories we can talk to
uplinks:
  npmjs:
    url: http://registry.npm.taobao.org/

packages:
  '@company/*':
    # scoped packages
    access: $authenticated
    publish: $authenticated
  '*':
    # keywords: "$all", "$anonymous", "$authenticated"
    access: $all
    publish: $all
    proxy: npmjs

# log settings
logs:
  - {type: stdout, format: pretty, level: http}
  #- {type: file, path: sinopia.log, level: info}
listen: 0.0.0.0:4873
複製代碼

1. 爲避免客戶端建立虛假用戶、或失誤建立用戶，會關閉註冊用戶功能max_users: -1，採用服務端提供用戶帳戶配置file: ./htpasswd的方式新增用戶。 已經爲verdaccio編寫自定義驗證插件，使用本身的帳戶系統的用戶名和密碼進行登陸驗證verdaccio-delegated-auth
2. 公司內部發布包到私有服務須要加上前綴@company/${app}，例如@company/lodash。前綴包@company/*必須通過帳戶驗證後才能正常執行安裝或發佈。（company指公司名稱）
3. 發佈內部私有包必須有項目自述README，內容必須包含:
   • 基本描述
   • 使用方式
   • 源碼地址

---

客戶端使用

1. 安裝nrm新增私有服務代理，使用本身的帳戶系統帳號登陸使用。

$ nrm add company http://*.*.*.*:4873/
$ nrm use company
$ npm login
複製代碼

2. 瀏覽器訪問私有服務，查看全部內部私有包。

---

安全

網關

更多

• Docker
  • AWS S3 storage plugin for verdaccio
  • npm login in CI

Github: github.com/yansenlei