Overleaf CE Admin Tool

一个用于管理 Overleaf Community Edition 的 Docker 管理工具，主要通过 MongoDB 操作实现各种管理功能。

功能特性

• MongoDB 备份与恢复: 支持完整备份和增量备份
• 用户管理: 创建、删除、修改用户信息
• 项目管理: 查看、备份、恢复项目数据
• 系统维护: 数据库清理、索引优化

快速开始

前置要求

• Docker
• Docker Compose
• 已运行的 Overleaf CE 实例

安装使用

1. 克隆仓库

git clone <your-repo-url>
cd overleaf-admin

2. 配置环境变量

cp .env.example .env
# 编辑 .env 文件，配置 MongoDB 连接信息

3. 构建并运行

docker-compose up -d

4. 执行管理命令

# 备份数据库
docker exec overleaf-admin ./admin.sh backup

# 查看用户列表
docker exec overleaf-admin ./admin.sh list-users

# 创建管理员用户
docker exec overleaf-admin ./admin.sh create-admin email@example.com

配置说明

在 .env 文件中配置以下参数：

MONGO_HOST=mongodb
MONGO_PORT=27017
MONGO_DB=sharelatex
MONGO_USER=root
MONGO_PASSWORD=your_password
BACKUP_DIR=/backups

可用命令

备份相关

• backup - 创建完整备份
• restore <backup_file> - 从备份恢复
• list-backups - 列出所有备份

用户管理

• list-users - 列出所有用户
• create-admin <email> - 创建管理员用户
• delete-user <email> - 删除用户
• reset-password <email> - 重置用户密码

项目管理

• list-projects - 列出所有项目
• export-project <project_id> - 导出项目
• import-project <archive> - 导入项目

系统维护

• cleanup - 清理过期数据
• optimize - 优化数据库索引
• stats - 显示系统统计信息

架构说明

本工具通过 Docker 容器运行，直接连接到 Overleaf CE 使用的 MongoDB 数据库，执行各种管理操作。

安全建议

• 请妥善保管 .env 文件，不要提交到版本控制
• 定期备份数据库
• 限制管理工具的网络访问权限

许可证

MIT License

贡献

欢迎提交 Issue 和 Pull Request