私有化部署Overleaf：解决LaTeX协作与安全难题

1. 为什么我们需要私有化部署Overleaf？

作为一个在学术界摸爬滚打多年的研究者，我深知LaTeX在学术写作中的重要性。但每次新设备配置LaTeX环境时，那种"配置地狱"般的体验——缺失的宏包、版本冲突的编译器、莫名其妙的字体问题——都让我抓狂。直到发现了Overleaf这个在线LaTeX编辑器，才算是找到了救星。

然而，使用公共Overleaf服务也有诸多不便：

• 网络延迟导致编译缓慢
• 免费账户的协作功能受限
• 敏感研究数据的安全隐患
• 无法自定义服务器配置

这就是为什么我决定搭建自己的Overleaf私有化部署。经过多次尝试和优化，终于找到了一套稳定可靠的方案，现在分享给大家。

提示：本文方案基于ShareLaTeX-CE开源版本，这是Overleaf收购ShareLaTeX后开源的社区版，与商业版Overleaf核心功能一致。

2. 部署前的准备工作

2.1 硬件需求评估

根据团队规模和使用场景，硬件需求会有很大差异。以下是我的推荐配置：

用户规模	CPU核心	内存	存储	适用场景
1-5人	2核	4GB	50GB	个人/小型团队
5-20人	4核	8GB	100GB	实验室/研究小组
20+人	8核+	16GB+	200GB+	院系级部署

我实验室有15名常驻研究人员，选择了4核8GB的配置，运行非常流畅。存储方面建议使用SSD，能显著提升编译速度。

2.2 软件环境准备

部署Overleaf需要以下基础环境：

1. Docker 20.10+
2. Docker Compose 1.29+
3. Node.js 14.x
4. Redis 6.x
5. MongoDB 4.4+

在Ubuntu 20.04上的安装命令如下：

# 安装Docker sudo apt-get update sudo apt-get install docker.io sudo systemctl enable --now docker # 安装Docker Compose sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose sudo chmod +x /usr/local/bin/docker-compose # 安装Node.js curl -fsSL https://deb.nodesource.com/setup_14.x | sudo -E bash - sudo apt-get install -y nodejs

2.3 获取ShareLaTeX-CE源码

Overleaf官方维护的ShareLaTeX-CE仓库地址：

git clone https://github.com/overleaf/overleaf-toolkit.git cd overleaf-toolkit

这个仓库包含了部署所需的所有配置文件和脚本。我建议创建一个专门的部署目录，避免与系统其他文件混淆。

3. 详细部署步骤

3.1 基础服务配置

首先配置环境变量文件.env：

SHARELATEX_BASE_URL=http://your-domain.com SHARELATEX_ADMIN_EMAIL=[e-mail] SHARELATEX_APP_NAME="My Private Overleaf" SHARELATEX_NAV_TITLE="Lab LaTeX Server"

然后初始化配置：

bin/init bin/setup-docker

这个过程会下载所有必要的Docker镜像，包括：

• sharelatex/sharelatex
• redis
• mongo
• texlive-full

3.2 数据库配置

MongoDB是Overleaf的主要数据存储。为了提高性能，我建议单独配置MongoDB的持久化存储：

# 在docker-compose.override.yml中添加 services: mongo: volumes: - ./data/mongo:/data/db command: mongod --wiredTigerCacheSizeGB 1

对于Redis，同样建议配置持久化：

services: redis: volumes: - ./data/redis:/data

3.3 TeXLive完整版安装

默认的TeXLive镜像只包含基础包，我们需要安装完整版：

docker exec sharelatex tlmgr install scheme-full

这个过程可能需要1-2小时，取决于网络速度。安装完成后，建议创建一个快照：

docker commit sharelatex sharelatex/with-texlive-full

这样下次部署时可以直接使用这个包含完整TeXLive的镜像。

3.4 中文支持配置

要让Overleaf支持中文编译，需要额外配置：

docker exec sharelatex tlmgr install ctex docker exec sharelatex tlmgr install xeCJK

然后在项目设置中将编译器改为XeLaTeX，并在文档开头添加：

\usepackage[UTF8]{ctex}

4. 高级配置与优化

4.1 性能调优

通过修改config/settings.coffee可以优化性能：

module.exports = clsi: compileGroup: 'your-group-name' compileTimeout: 60 commandRunner: 'docker' docker: image: 'sharelatex/with-texlive-full' memory: 2048m cpuCount: 2

我实验室的优化参数：

• 编译超时设为60秒（适合大型文档）
• 每个编译容器分配2GB内存
• 使用2个CPU核心

4.2 备份策略

数据安全至关重要，我设计了这样的备份方案：

# 每日数据库备份 0 3 * * * docker exec mongo mongodump --archive=/data/db/backup/$(date +\%Y-\%m-\%d).archive --gzip # 每周项目文件备份 0 4 * * 0 tar -czvf /backup/projects-$(date +\%Y-\%m-\%d).tar.gz /var/lib/sharelatex/data/project_files

建议将备份文件同步到云存储或其他服务器。

4.3 集成Git版本控制

Overleaf支持Git集成，需要在配置中启用：

gitBridge: enabled: true publicURL: "http://your-domain.com" url: "http://localhost:3042"

然后启动Git桥接服务：

docker-compose up -d git-bridge

用户可以在项目设置中生成Git URL，像普通Git仓库一样操作。

5. 日常维护与问题排查

5.1 常见问题解决方案

问题1：编译失败，显示"Write failed"原因：Docker容器磁盘空间不足 解决：

docker system prune docker volume prune

问题2：中文显示为方框原因：缺少中文字体 解决：

docker exec sharelatex apt-get install fonts-wqy-microhei

问题3：无法上传大文件修改Nginx配置：

client_max_body_size 100M;

5.2 监控系统健康

我使用以下命令监控系统状态：

# 查看容器资源使用 docker stats # 检查服务日志 docker-compose logs -f sharelatex # 监控磁盘空间 df -h /var/lib/docker

建议设置警报，当磁盘使用超过80%或内存使用超过90%时通知管理员。

5.3 升级流程

Overleaf团队会定期发布更新，升级步骤：

git pull origin master docker-compose pull docker-compose up -d

升级前务必：

1. 停止服务
2. 备份数据库
3. 检查更新日志中的破坏性变更

6. 安全加固措施

6.1 HTTPS配置

使用Let's Encrypt获取免费SSL证书：

sudo apt install certbot sudo certbot certonly --standalone -d your-domain.com

然后配置Nginx：

ssl_certificate /etc/letsencrypt/live/your-domain.com/fullchain.pem; ssl_certificate_key /etc/letsencrypt/live/your-domain.com/privkey.pem;

6.2 访问控制

限制注册功能，只允许邀请注册：

security: registerDisabled: true inviteOnly: true

启用双因素认证：

settings: twoFactorAuthentication: enabled: true

6.3 防火墙规则

只开放必要端口：

sudo ufw allow 80/tcp sudo ufw allow 443/tcp sudo ufw enable

7. 与VSCode集成方案

虽然私有化Overleaf已经很好用，但有时我们仍希望在本地VSCode中编辑LaTeX。以下是集成方案：

7.1 配置VSCode插件

安装以下插件：

• LaTeX Workshop
• Overleaf Toolkit

配置settings.json：

{ "latex-workshop.latex.recipes": [ { "name": "xelatex", "tools": ["xelatex", "bibtex", "xelatex"] } ], "overleaf-toolkit.serverUrl": "http://your-domain.com" }

7.2 同步工作流

1. 在Overleaf上创建项目
2. 使用Git集成功能克隆到本地
3. 在VSCode中编辑并本地编译测试
4. 推送更改回Overleaf进行最终编译

这种工作流结合了本地编辑的响应速度和云端协作的便利性。

8. 实际使用体验与建议

经过半年的使用，我们的私有化Overleaf服务器已经成为实验室不可或缺的工具。以下是一些使用心得：

1. 模板管理：我们创建了实验室论文模板项目，新成员可以直接复制使用，确保格式统一。

2. 协作评审：利用Overleaf的评论功能，导师可以直接在文档上批注，比传统的PDF批注方便得多。

3. 版本控制：每次投稿前创建一个版本快照，方便回溯修改。

4. 资源库：建立了常用宏包和代码片段的资源库项目，团队成员可以随时引用。

对于考虑部署私有化Overleaf的团队，我的建议是：

• 从小规模开始，逐步扩展
• 制定清晰的命名规范和组织结构
• 定期培训新成员使用LaTeX和Overleaf
• 建立文档规范和质量检查流程

私有化部署虽然需要一些初始投入，但长期来看能显著提高学术写作效率，让团队专注于内容创作而非工具配置。现在，我们实验室再也没人抱怨"LaTeX配置地狱"了。