wombat-dressing-room 的安装和配置教程

项目基础介绍

wombat-dressing-room 是由 Google Cloud Platform 开发的一个开源项目，其主要功能是作为 npm 发布的代理，用于减少 npm 包的攻击面。这个项目可以帮助开发者在发布包之前，通过额外的安全规则进行检查，确保发布过程的安全性。

该项目主要使用的编程语言是 TypeScript。

项目使用的关键技术和框架

• Google Cloud Platform: 项目部署在 Google Cloud Platform 上，利用其服务和基础设施。
• npm: 作为包管理工具，用于管理和发布包。
• GitHub OAuth: 用于用户认证和授权。
• TypeScript: 用于编写项目的主要逻辑。

安装和配置准备工作

在开始安装和配置 wombat-dressing-room 之前，需要做一些准备工作：

1. Google Cloud Platform 账户: 需要一个 Google Cloud Platform 账户来部署项目。
2. npm 账户: 创建一个 npm 账户，该账户将用于发布包，并确保启用了双因素认证（2FA）。
3. GitHub OAuth 应用: 创建一个 GitHub OAuth 应用，用于认证。
4. 环境变量文件: 在 config/ 目录下创建本地、外部和内部环境变量文件。

安装步骤

以下是详细的安装步骤：

1. 安装 gcloud 命令行工具: 你需要安装 gcloud 命令行工具，并使用它来登录你的 Google Cloud 账户。

   gcloud auth login
   

2. 设置环境变量: 在 config/ 目录下，根据你的环境创建和编辑环境变量文件。例如，本地开发环境的 local.env 文件可能如下所示：

   NPM_OTP_SECRET={你的 otp 秘钥}
   NPM_TOKEN={你的 npm 令牌}
   GITHUB_CLIENT_ID={你的 GitHub 应用客户端 ID}
   GITHUB_CLIENT_SECRET={你的 GitHub 应用客户端密钥}
   DATASTORE_PROJECT_ID={你的项目 Datastore 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
   

3. 部署应用到 Google Cloud Platform: 使用以下命令部署应用：

   GCLOUD_PROJECT=你的项目ID npm run deploy
   

4. 创建数据存储表: 在访问应用之前，你需要运行以下命令来创建数据存储模式：

   GCLOUD_PROJECT=你的项目ID npm run create-indexes
   

5. 保护应用: 为了限制对内部应用的访问，你可以使用 IAP（Identity-Aware Proxy）来配置访问控制。

6. 本地开发: 在本地开发时，确保 config/local.env 文件已正确设置，然后运行以下命令启动开发服务：

   npm run develop
   

7. 部署更新: 在完成开发后，更新 config/external.env 和 config/internal.env 文件，然后运行以下命令来部署更新：

   npm run deploy
   

按照以上步骤操作，你就可以成功安装和配置 wombat-dressing-room 项目了。如果在过程中遇到任何问题，请参考项目的官方文档或向社区寻求帮助。