monkeytype/monkeytype-backend

Monkeytype 自托管

目录

• Monkeytype 自托管
  • 目录
  • 前提条件
  • 快速开始
  • 账户系统
    • 设置 Firebase
    • 更新后端配置
    • 设置 Recaptcha
    • 设置邮件（可选）
  • 启用日常排行榜
  • 配置文件
    • env 文件
    • serviceAccountKey.json
    • backend-configuration.json

前提条件

• 需安装 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 项目设置，若项目中无应用，创建新 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%E3%80%82

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