Wombat Dressing Room 开源项目教程

1. 项目介绍

Wombat Dressing Room 是由 GoogleCloudPlatform 开发的一个 npm 注册表中间服务。该服务旨在通过实施额外的安全规则来减少 npm 发布的攻击面。在将软件包发布到官方 npm 注册表之前，它会对发布操作进行验证。

2. 项目快速启动

环境准备

• Google Cloud Platform 账户
• npm 账户（启用双因素认证）
• GitHub OAuth 应用

配置环境变量

首先，你需要在项目的 config 目录中创建环境配置文件。

开发环境（config/local.env）:

NPM_OTP_SECRET={你的 OTP 密钥}
NPM_TOKEN={你的 npm 访问令牌}
GITHUB_CLIENT_ID={GitHub 应用的客户端 ID}
GITHUB_CLIENT_SECRET={GitHub 应用的客户端密钥}
DATASTORE_PROJECT_ID={你的 Google Cloud 数据存储项目 ID}
LOGIN_ENABLED=yes-this-is-a-login-server
LOGIN_URL=http://127.0.0.1:8080
REGISTRY_URL=http://127.0.0.1:8080

外部环境（config/external.env）:

NPM_OTP_SECRET={你的 OTP 密钥}
NPM_TOKEN={你的 npm 访问令牌}
GITHUB_CLIENT_ID={GitHub 应用的客户端 ID}
GITHUB_CLIENT_SECRET={GitHub 应用的客户端密钥}
DATASTORE_PROJECT_ID={你的 Google Cloud 数据存储项目 ID}
LOGIN_ENABLED=this-is-not-enabled
LOGIN_URL=https://project.appspot.com
REGISTRY_URL=https://external-project.appspot.com

内部环境（config/internal.env）:

NPM_OTP_SECRET={你的 OTP 密钥}
NPM_TOKEN={你的 npm 访问令牌}
GITHUB_CLIENT_ID={GitHub 应用的客户端 ID}
GITHUB_CLIENT_SECRET={GitHub 应用的客户端密钥}
DATASTORE_PROJECT_ID={你的 Google Cloud 数据存储项目 ID}
LOGIN_ENABLED=yes-this-is-a-login-server
LOGIN_URL=https://project.appspot.com
REGISTRY_URL=https://external-project.appspot.com

部署应用

• 安装 gcloud 命令行工具并登录到你的 Google Cloud 账户。
• 使用以下命令进行初始部署：

GCLOUD_PROJECT=my-project npm run deploy

其中 my-project 是你的 Google Cloud 项目 ID。

创建数据存储表

在第一次访问应用之前，运行以下命令创建数据存储索引：

GCLOUD_PROJECT=my-project npm run create-indexes

3. 应用案例和最佳实践

• 安全发布：通过使用单独的 npm 账户和双因素认证，确保发布的软件包安全性。
• 环境隔离：开发、测试和生产环境应使用不同的配置，以确保安全和稳定。
• 访问控制：通过配置 IAP（身份验证代理），限制对内部服务的访问。

4. 典型生态项目

• CI/CD 集成：将 Wombat Dressing Room 集成到你的持续集成/持续部署流程中，自动化发布流程。
• 多因素认证集成：与现有的身份验证系统集成，提供更安全的登录机制。
• 日志和监控：集成日志收集和监控系统，以便跟踪和审计发布活动。