monkeytype/monkeytype-frontend

Monkeytype 自托管

前提条件

• 需要安装 docker 和 docker-compose-plugin。请按照 Docker 文档 进行安装。

快速启动

1. 创建新目录，例如 monkeytype 并进入该目录。
2. 下载 https://github.com/monkeytypegame/monkeytype/tree/master/docker/docker-compose.yml%E3%80%82
3. 创建 .env 文件，可复制 https://github.com/monkeytypegame/monkeytype/tree/master/docker/example.env 中的内容。
4. 下载 https://github.com/monkeytypegame/monkeytype/tree/master/docker/backend-configuration.json%E3%80%82
5. 运行 docker compose up -d。
6. 命令成功执行后，可访问 http://localhost:8080。

账户系统

默认禁用用户注册/登录功能。如需允许用户注册，需设置 Firebase 项目。修改配置前，使用 docker compose down 停止运行中的容器。

设置 Firebase

1. 创建 Firebase 账户。

2. 创建 新 Firebase 项目：

   • 名称："monkeytype"
   • 取消勾选"启用 Google Analytics"

3. 启用认证：

   • 打开 Firebase 控制台 并选择项目
   • 进入 Authentication > Sign-in method
   • 启用 Email/Password 并保存

4. 生成服务账户：

   • 点击侧边栏的 ⚙ 图标，选择 Project settings 打开项目设置
   • 进入 Service accounts 选项卡
   • 点击 Generate new private key，下载 .json 文件
   • 将该文件保存为 serviceAccountKey.json
   • 更新 docker-compose.yml 文件，取消 monkeytype-backend 容器的第一个卷注释：

     yaml
     # 取消注释以启用账户系统，请查看SELF_HOSTING.md文件
     - type: bind
       source: ./serviceAccountKey.json
       target: /app/backend/src/credentials/serviceAccountKey.json
       read_only: true
     

5. 更新 .env 文件：

   • 打开 Firebase 控制台 并选择项目
   • 点击侧边栏的 ⚙ 图标，选择 Project settings 打开项目设置
   • 如项目中无应用，创建新 Web 应用 </>：
     • 昵称："monkeytype"
     • 取消勾选"设置 Firebase Hosting"
     • 点击"Register app"
   • 选择应用，在"SDK setup and configuration"中选择"Config"
   • 会显示类似以下内容：

     const firebaseConfig = {
     apiKey: "AAAAAAAA",
     authDomain: "monkeytype-00000.firebaseapp.com",
     projectId: "monkeytype-00000",
     storageBucket: "monkeytype-00000.appspot.com",
     messagingSenderId: "90000000000",
     appId: "1:90000000000:web:000000000000"
     };
     

   • 使用上述值更新 .env 文件：

     FIREBASE_APIKEY=AAAAAAAA
     FIREBASE_AUTHDOMAIN=monkeytype-00000.firebaseapp.com
     FIREBASE_PROJECTID=monkeytype-00000
     FIREBASE_STORAGEBUCKET=monkeytype-00000.appspot.com
     FIREBASE_MESSAGINGSENDERID=90000000000
     FIREBASE_APPID=1:90000000000:web:000000000000
     

更新后端配置

• 更新 backend-configuration.json 文件，添加或修改：

  json
  {
      "users": {
          "signUp": true,
          "profiles": {
              "enabled": true
          }
      }
  }
  

设置 Recaptcha

1. 创建 新的 reCAPTCHA 令牌：
   • 标签：monkeytype
   • 类型：v2
   • 域名：前端所在域名
2. 使用上一步的站点密钥更新 .env 文件：

   RECAPTCHA_SITE_KEY="你的站点密钥"
   RECAPTCHA_SECRET="你的密钥"
   

如私有部署，可使用默认值：

RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI
RECAPTCHA_SECRET=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe

设置邮件（可选）

如需启用密码重置和***验证邮件，更新 .env 文件中的以下配置：

# 邮件服务器配置
# 如需发送邮件（如密码重置），取消下方注释
EMAIL_HOST=mail.myserver   # 你的邮件服务器域名
EMAIL_USER=mailuser        # 用于认证的用户名
EMAIL_PASS=mailpass        # 用户密码
EMAIL_PORT=465             # 端口，通常为 465 或 578
EMAIL_FROM="支持 <noreply@myserver>"

启用每日排行榜

如需启用每日排行榜，更新 backend-configuration.json 文件，添加或修改：

json
{
    "dailyLeaderboards": {
        "enabled": true,
        "maxResults": 250,
        "leaderboardExpirationTimeInDays": 1,
        "validModeRules": [
            {
                "language": "english",
                "mode": "time",
                "mode2": "15"
            },
            {
                "language": "english",
                "mode": "time",
                "mode2": "60"
            }
        ]
    }
}

• language：支持的语言之一
• mode：可选 time 或 words
• mode2：若 mode 为 time，可选 15、30、60 或 120；若 mode 为 words，可选 10、25、50 或 100

配置文件

env 文件

所有设置在 https://github.com/monkeytypegame/monkeytype/tree/master/docker/example.env 文件中有详细说明。

serviceAccountKey.json

包含 Firebase 配置，仅在允许用户注册时需要。

backend-configuration.json

后端配置文件。可查看 https://github.com/monkeytypegame/monkeytype/blob/master/backend/src/constants/base-configuration.ts#L8 了解所有可能的配置值。

[!NOTE] 配置仅在容器启动时应用。修改配置后需重启容器使更改生效。