本文深入探讨如何设置私有 npm 仓库，涵盖多种方案及实用代码示例，助您快速上手。无论您是个人开发者还是大型团队成员，私有化托管 npm 包都能提升安全性、灵活性及控制力。
为何选择私有 npm 仓库？
- 安全与控制: 代码和包安全保存在内部。
- 构建提速: 减少外部依赖及网络延迟。
- 访问权限管理: 精确控制包的访问和发布权限。
- 版本控制与存档: 维护内部包的多个版本，避免混乱和外部中断。
私有 npm 仓库托管方案
-
自托管方案
- verdaccio: 轻量级、流行的开源 npm 代理注册表。
- Sonatype Nexus: 功能强大的平台，支持多种仓库格式（npm、Maven 等）。
- JFrog Artifactory: 广泛使用的二进制仓库管理器。
-
Git 托管平台
- GitHub Packages: 在 GitHub 组织内托管私有 npm 包。
- GitLab Packages: GitLab DevOps 平台的内置 npm 注册表。
- Bitbucket: 需借助第三方集成或自定义方案。
-
npm 企业版
- 适用于大型团队，提供企业级功能（高级访问控制、安全审计等）。
1. 使用 verdaccio 设置私有 npm 注册表
verdaccio 是易于配置和使用的开源 npm 注册表代理，支持托管私有包并缓存公共包。
1.1 安装 verdaccio (假设已安装 Node.js)
<code class="bash">npm install --global verdaccio</code>
1.2 启动 verdaccio
<code class="bash">verdaccio</code>
verdaccio 默认端口为 4873。访问 http://localhost:4873 查看其 UI。
1.3 配置 verdaccio
verdaccio 首次运行时会创建默认配置文件 (路径可能因系统而异，例如 ~/.config/verdaccio/config.yaml)，可自定义配置：
<code class="yaml">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 }</code>
-
storage: verdaccio 存储包的目录。 -
uplinks: 指向官方 npm 注册表。 -
packages: 定义访问、发布和代理规则。
1.4 创建用户并登录
<code class="bash">npm adduser --registry http://localhost:4873</code>
系统将提示您输入用户名、密码和邮箱。
1.5 发布包
在包含有效 package.json 的包目录下：
<code class="bash">npm publish --registry http://localhost:4873</code>
1.6 从私有注册表安装
- 使用
--registry标志：
<code class="bash">npm install <package-name> --registry http://localhost:4873</code>
- 或在
.npmrc中全局或针对特定项目设置注册表地址：
<code>registry=http://localhost:4873</code>
2. 使用 GitHub Packages (略，与原文类似，只是调整措辞)
3. 使用 GitLab Packages (略，与原文类似，只是调整措辞)
4. 使用 Sonatype Nexus 或 JFrog Artifactory 自托管 (略，与原文类似，只是调整措辞)
5. npm 企业版 (略，与原文类似，只是调整措辞)
最佳实践与技巧
-
使用作用域: 为私有包定义作用域（例如
@company/your-package）, 以区分公共包。 -
.npmrc 管理: 使用每个项目
.npmrc文件，避免冲突，并确保凭据不纳入版本控制。 - CI/CD 自动化: 将发布步骤集成到 CI/CD 管道中。
- 设置代理: 大多数自托管注册表可代理公共 npm 注册表。
- 监控和审计: 跟踪注册表的下载、版本和活动。
总结
设置私有 npm 仓库能安全地管理和托管您的包。 选择合适的方案取决于您的组织对安全性、可扩展性和维护性的需求。 希望本文提供的示例和代码片段能帮助您开始托管自己的私有 npm 包。
