私人 npm 儲存庫

以下是有關如何設定私人 npm 儲存庫的深入指南，包括各種替代方案和實用的程式碼片段，可協助您入門。無論您是獨立開發人員還是大型團隊的一員，私下託管您自己的 npm 套件都可以為您提供控制力、靈活性和更高的安全性。

---

為什麼要使用私有 npm 儲存庫？

1. 安全與控制：將您的套件和程式碼保留在內部。
2. 更快的建置：減少外部依賴和網路延遲。
3. 存取管理：控制誰可以存取或發布某些套件。
4. 版本控制與存檔：維護內部包的多個版本，而不會造成混亂或外部中斷。

---

託管私有 npm 儲存庫的常見方法

1. 自架解決方案

   • Verdaccio：流行的開源輕量級 npm 代理註冊表。
   • Sonatype Nexus：用於託管多種儲存庫格式（npm、Maven 等）的綜合平台。
   • JFrog Artifactory：廣泛使用的二進位儲存庫管理器。

2. 由 Git 主機管理

   • GitHub 套件：在 GitHub 組織內託管私有 npm 套件。
   • GitLab Packages：提供內建的 npm 註冊表作為 GitLab DevOps 平台的一部分。
   • Bitbucket（透過第三方整合或自訂解決方案）。

3. npm 企業版

   • 如果您擁有大型團隊並需要企業級功能（進階存取控制、安全審核等），npm Enterprise 可能是個選項。

---

1. 使用 Verdaccio 設定私有 npm 註冊表

Verdaccio 是一個開源 npm 註冊表代理，易於設定和使用。它允許您託管私有包並快取官方 npm 註冊表中的公用包。

1.1 安裝維達西奧

假設 Node.js 已安裝在您的電腦上：

# Install Verdaccio globally
npm install --global verdaccio

1.2 啟動維達喬

verdaccio

預設情況下，Verdaccio 在連接埠 4873 上啟動。您可以開啟瀏覽器造訪 http://localhost:4873 以查看 Verdaccio UI。

1.3 配置Verdaccio

Verdaccio 在第一次執行時建立預設設定檔。您可以透過編輯來自訂它（檔案路徑可能會根據您的系統而有所不同）。典型的設定 (~/.config/verdaccio/config.yaml) 如下圖所示：

# Install Verdaccio globally
npm install --global verdaccio

• storage：Verdaccio 儲存包的目錄。
• uplinks：指向官方 npm 註冊表。
• packages：定義存取、發布和代理的規則。

1.4 建立使用者並登入

verdaccio

這會提示輸入使用者名稱、密碼和電子郵件。完成後，您將登入您的私人註冊表。

1.5 發布包

在具有有效 package.json 的套件目錄中：

storage: ./storage
auth:
  htpasswd:
    file: ./htpasswd
    max_users: 100

uplinks:
  npmjs:
    url: https://registry.npmjs.org/

packages:
  '@*/*':
    access: $all
    publish: $authenticated
    proxy: npmjs

  '**':
    access: $all
    publish: $authenticated
    proxy: npmjs

middlewares:
  audit:
    enabled: true

logs:
  - { type: stdout, format: pretty, level: http }

就是這樣！您的套件現已發佈到您本地的 Verdaccio 註冊表。

1.6 從您的私人註冊表安裝

要從此登錄安裝軟體包，您可以：

• 使用 --registry 標誌：

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

• 或將您的 .npmrc 設定為全域或特定項目中指向此登錄：

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

---

2. 使用 GitHub 套件

如果您已經在 GitHub 上託管程式碼，那麼使用 GitHub Packages 可以是一種將所有內容都集中在一個屋簷下的便捷方法。

2.1 為您的儲存庫啟用 GitHub 套件

1. 前往 GitHub 上的儲存庫。
2. 點選設定 -> 套餐。
3. 確保為您的組織/帳戶啟用 GitHub Packages。

2.2 對 GitHub 套件進行身份驗證

使用 read:packages 和 write:packages 範圍建立個人存取權杖 (PAT)。您可以從 開發者設定 -> 下的 GitHub 設定產生此令牌。 個人存取權令牌。

將您的令牌加入 .npmrc：

  npm install <package-name> --registry http://localhost:4873
</package-name>

將 YOUR_GITHUB_USERNAME 替換為您的實際使用者名稱或 GitHub 組織名稱。

2.3 將套件發佈到 GitHub Packages

使用與您的 GitHub 使用者名稱或組織相符的範圍更新您的 package.json：

  registry=http://localhost:4873

然後發佈：

//npm.pkg.github.com/:_authToken=YOUR_PERSONAL_ACCESS_TOKEN
@YOUR_GITHUB_USERNAME:registry=https://npm.pkg.github.com

2.4 從 GitHub 套件安裝

確保 .npmrc 指向 GitHub Packages，然後：

{
  "name": "@YOUR_GITHUB_USERNAME/my-private-package",
  "version": "1.0.0",
  "publishConfig": {
    "registry": "https://npm.pkg.github.com"
  }
}

---

3. 使用 GitLab 套件

GitLab也提供了內建的套件註冊表。

3.1 設定 GitLab 套件註冊表

1. 導航到您的 GitLab 專案。
2. 前往設定 -> 套件和登錄 -> 包裝登錄。

3.2 配置.npmrc

使用您的 GitLab 憑證建立或更新本機/全域 .npmrc 檔案：

npm publish

3.3 發佈到GitLab

更新您的 package.json 範圍以符合 GitLab 群組或使用者命名空間：

npm install @YOUR_GITHUB_USERNAME/my-private-package

然後發佈：

# Install Verdaccio globally
npm install --global verdaccio

3.4 從 GitLab 套件安裝

verdaccio

---

4. 使用 Sonatype Nexus 或 JFrog Artifactory 自架

如果您正在尋找支援多種儲存庫類型的強大的本機解決方案，Sonatype Nexus 或 JFrog Artifactory 可能是您的最佳選擇。

4.1 Nexus 儲存庫

1. 在您的伺服器或開發電腦上安裝 Nexus Repository Manager。
2. 登入 Nexus UI：http://your-nexus-server:8081。
3. 從儲存庫設定建立一個新的npm（託管）儲存庫。
4. 設定身份驗證（如果需要）並記下 URL。

使用類似的 .npmrc 設定將您的 npm 用戶端指向新的 Nexus npm 儲存庫：

storage: ./storage
auth:
  htpasswd:
    file: ./htpasswd
    max_users: 100

uplinks:
  npmjs:
    url: https://registry.npmjs.org/

packages:
  '@*/*':
    access: $all
    publish: $authenticated
    proxy: npmjs

  '**':
    access: $all
    publish: $authenticated
    proxy: npmjs

middlewares:
  audit:
    enabled: true

logs:
  - { type: stdout, format: pretty, level: http }

照常發佈您的包包：

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

4.2 JFrog 人工工廠

1. 安裝並啟動 Artifactory。
2. 在 Artifactory UI 中，為 npm 建立一個 本機儲存庫。
3. 類似地配置 .npmrc：

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

發布使用：

  npm install <package-name> --registry http://localhost:4873
</package-name>

---

5.npm 企業版

對於需要完全控制、審核和進階安全性的大型組織，npm Enterprise 是一個選擇。它提供：

• 單一登入 (SSO) 整合。
• 增強的安全掃描和審核。
• 細粒度存取控制。

請參閱 npm Enterprise 文件以取得設定說明。

---

最佳實踐和技巧

1. 使用範圍：確定私有套件（@company/your-package）的範圍有助於將它們與公用套件區分開來。
2. .npmrc 管理：
   • 使用每個項目 .npmrc 檔案以避免混淆。
   • 使憑證不受版本控制。
3. 使用 CI/CD 自動化：將發布步驟整合到 CI/CD 管道中以確保一致性。
4. 設定代理：大多數自架註冊表可以代理公共 npm 註冊表，因此您無需在註冊表之間切換來安裝常見依賴項。
5. 監控與審核：追蹤登錄中的下載、版本和活動。

---

結論

設定私人 npm 儲存庫讓您可以自由地安全地管理和託管自己的套件。無論您是使用 Verdaccio 等自架解決方案、利用 GitHub Packages 或 GitLab Packages 等託管解決方案，還是選擇 Nexus、Artifactory 或 npm Enterprise 等企業解決方案，基本原理都是一樣的：

1. 設定註冊表。
2. 設定身份驗證。
3. 發布並使用您的包。

選擇最適合您組織在安全性、可擴充性和維護方面的要求的方法。透過上面的範例和程式碼片段，您應該擁有堅實的基礎來開始託管您自己的私人 npm 套件。快樂編碼！

以上是私人 npm 儲存庫的詳細內容。更多資訊請關注PHP中文網其他相關文章！