Monkeytype自托管部署指南：从零搭建专属打字测试平台

前言

Monkeytype作为一款现代化的打字速度测试工具，其开源特性允许用户进行自托管部署。本文将详细介绍如何将Monkeytype部署到自己的服务器环境，打造专属的打字测试平台。

环境准备

在开始部署前，请确保已满足以下基础条件：

1. Docker环境：需要安装Docker引擎及Docker Compose插件
2. 系统资源：建议至少2GB内存的服务器环境
3. 网络条件：服务器需具备稳定的网络连接

快速部署流程

1. 初始化项目目录

mkdir monkeytype && cd monkeytype

2. 获取核心配置文件

获取docker-compose.yml文件，这是容器编排的核心配置文件

3. 环境变量配置

创建.env文件，建议从示例文件复制基础配置：

cp example.env .env

4. 后端配置

下载backend-configuration.json文件，这是后端服务的关键配置文件

5. 启动服务

docker compose up -d

服务启动后，可通过http://localhost:8080访问Monkeytype前端界面

账户系统配置

默认情况下，用户注册/登录功能是禁用的。如需启用，需配置Firebase服务。

Firebase项目设置

1. 创建新Firebase项目
2. 项目命名建议使用"monkeytype"
3. 禁用Google Analytics功能

认证服务配置

1. 在Firebase控制台中启用Email/Password认证方式
2. 生成服务账户密钥文件(serviceAccountKey.json)
3. 更新docker-compose.yml文件，解除相关volume的注释

环境变量更新

从Firebase控制台获取以下关键配置信息，并更新到.env文件：

FIREBASE_APIKEY=your_api_key
FIREBASE_AUTHDOMAIN=your_auth_domain
FIREBASE_PROJECTID=your_project_id
FIREBASE_STORAGEBUCKET=your_storage_bucket
FIREBASE_MESSAGINGSENDERID=your_sender_id
FIREBASE_APPID=your_app_id

后端配置更新

修改backend-configuration.json文件，启用用户功能：

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

reCAPTCHA配置

1. 申请reCAPTCHA v2密钥
2. 将获得的站点密钥和密钥更新到.env文件

每日排行榜功能

如需启用每日排行榜功能，需在backend-configuration.json中添加配置：

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

配置说明：

• language：支持的语言代码
• mode：测试模式(time或words)
• mode2：测试时长或单词数

配置文件详解

.env文件

包含所有环境变量设置，主要配置项包括：

• 服务端口
• Firebase配置
• reCAPTCHA密钥
• 其他功能开关

serviceAccountKey.json

Firebase服务账户凭证文件，仅在启用用户系统时需要

backend-configuration.json

后端服务核心配置文件，可通过以下方式管理：

1. 通过Web界面配置(http://localhost:5005/configure/)
2. 直接编辑JSON文件
3. 使用curl命令获取当前配置

配置更新后，需要重启容器使更改生效：

docker compose restart

最佳实践建议

1. 安全防护：建议配置HTTPS访问，确保数据传输安全
2. 定期备份：定期备份serviceAccountKey.json等重要文件
3. 性能监控：对容器资源使用情况进行监控
4. 日志管理：配置日志轮转，避免日志文件过大

通过以上步骤，您已成功搭建了专属的Monkeytype打字测试平台。根据实际需求，可进一步定制界面样式、测试模式等参数，打造个性化的打字练习环境。