️ 深度解析我的 Overleaf 私有化部署：一份稳定、高兼容性的 `docker-compose.yaml`

大家好，我是 XuHe。在上一篇博客告别 LaTeX 配置地狱：我的 Overleaf (ShareLaTeX-CE) 完整版私有化部署方案，我想详细解析一下我为 Overleaf Community Edition (ShareLaTeX CE) 项目所配置的 docker-compose.yaml 文件。
一个稳定、可维护的 Overleaf 私有部署，其灵魂就在于如何配置好三个核心服务：ShareLaTeX 应用、MongoDB 数据库和 Redis 缓存。
我这份配置不仅解决了AVX 兼容性问题，还通过一系列环境变量优化了使用体验和编译稳定性。

1. services:
2.     sharelatex:
3.         restart: always
4.         # image: sharelatex/sharelatex:4.2.3
5.         image: xuhe-sharelatex-ce:latest # custom image(include new texlive)
6.         container_name: leaf-sharelatex
7.         depends_on:
8.             mongo:
9.                 condition: service_healthy
10.             redis:
11.                 condition: service_started
12.         ports:
13.             - 8008:80
14.         links:
15.             - mongo
16.             - redis
17.         stop_grace_period: 60s
18.         volumes:
19.             - ./sharelatex:/var/lib/sharelatex
20.         environment:
21.             SHARELATEX_APP_NAME: XuHe's Overleaf
23.             SHARELATEX_MONGO_URL: mongodb://mongo/sharelatex
25.             # Same property, unfortunately with different names in
26.             # different locations
27.             SHARELATEX_REDIS_HOST: redis
28.             REDIS_HOST: redis
30.             ENABLED_LINKED_FILE_TYPES: "project_file,project_output_file"
32.             # Enables Thumbnail generation using ImageMagick
33.             ENABLE_CONVERSIONS: "true"
35.             # Disables email confirmation requirement
36.             EMAIL_CONFIRMATION_DISABLED: "true"
38.             # temporary fix for LuaLaTex compiles
39.             # see https://github.com/overleaf/overleaf/issues/695
40.             TEXMFVAR: /var/lib/sharelatex/tmp/texmf-var
42.     mongo:
43.         restart: always
44.         image: mongo:4.4
45.         container_name: leaf-mongo
46.         command: "--replSet overleaf"
47.         expose:
48.             - 27017
49.         volumes:
50.             - ./mongo:/data/db
51.         healthcheck:
52.             test: echo 'db.stats().ok' | mongo localhost:27017/test --quiet
53.             interval: 10s
54.             timeout: 10s
55.             retries: 5
57.     redis:
58.         restart: always
59.         image: redis:6.2
60.         container_name: leaf-redis
61.         expose:
62.             - 6379
63.         volumes:
64.             - ./redis:/data

复制代码

一、核心服务总览

我的部署方案中包含以下三个服务：
服务名称角色关键版本（兼容性考量）sharelatex主应用服务自定义镜像 (xuhe-sharelatex-ce:latest)mongo数据存储服务mongo:4.4 (为兼容无 AVX 指令集 CPU)redis缓存与实时数据服务redis:6.2二、ShareLaTeX 应用配置详解 (sharelatex Service)

sharelatex 服务是整个部署的核心。这里我们不仅指定了自定义镜像，还通过环境变量进行了大量功能定制。
1. 启动与依赖

配置项值核心作用imagexuhe-sharelatex-ce:latest使用我们自定义的完整 TeX Live 镜像。restartalways保证服务崩溃或重启后自动恢复运行。depends_onmongo (healthy), redis (started)确保 ShareLaTeX 只有在数据库和缓存服务准备就绪后才启动。2. 核心环境变量 (environment)

以下环境变量是定制 Overleaf 行为的关键，我重点介绍了几个提高用户体验和稳定性的配置：
环境变量值目的与说明SHARELATEX_APP_NAMEXuHe's Overleaf应用名称。自定义浏览器 Tab 和登录页面的名称，增强私有化标识。SHARELATEX_MONGO_URLmongodb://mongo/sharelatexMongoDB 连接。使用 Docker Compose 内部服务名 mongo 进行连接。EMAIL_CONFIRMATION_DISABLED"true"跳过邮件验证。默认情况下，新用户注册需要邮件验证。将其设置为 true 可直接登录使用，非常适合内部或私有部署。ENABLE_CONVERSIONS"true"启用图片/缩略图转换。允许 Overleaf 使用 ImageMagick 进行图片处理和生成 PDF 缩略图。TEXMFVAR/var/lib/sharelatex/tmp/texmf-varLuaLaTeX 兼容性修复。这是一个针对特定版本 LuaLaTeX 编译问题的临时修复，提升编译稳定性。ENABLED_LINKED_FILE_TYPES"project_file,..."启用外部文件类型链接（高级）。用于控制哪些文件类型可以被链接或引用。3. 数据持久化与网络

• 端口映射 (ports): 我将容器内部的 80 端口映射到宿主机的 8008 端口 (8008:80)，方便通过浏览器访问。您可以根据需要修改 8008。
  
• 数据卷 (volumes): ./sharelatex:/var/lib/sharelatex。这是至关重要的配置，它将容器内的项目数据目录持久化映射到宿主机上的 ./sharelatex 文件夹，确保项目文件不会丢失。
  

三、数据库和缓存服务配置

1. MongoDB (mongo Service)

• 版本 (image): 选择了 mongo:4.4。这是为了规避最新版 MongoDB 对 AVX 指令集的强制依赖，以确保在旧硬件上顺利运行。
  
• 副本集 (command): "--replSet overleaf"。这是 Overleaf 运行所必需的配置，用于启用 MongoDB 的副本集功能。启动后，还需要执行一次 docker exec 命令进行初始化（详见我的 README）。
  
• 健康检查 (healthcheck): 保证 ShareLaTeX 服务只在 MongoDB 确认可以连接并工作正常时才启动，提升启动可靠性。
  
• 数据卷 (volumes): ./mongo:/data/db，确保数据库数据持久化。
  

2. Redis (redis Service)

• 版本 (image): redis:6.2，一个稳定且功能完整的 Redis 版本。
  
• 作用: Redis 主要用于 Overleaf 的实时数据、会话管理和缓存，是实现协同编辑功能的基础。
  
• 数据卷 (volumes): ./redis:/data，用于持久化 Redis 的持久化数据。
  

四、结语

这份 docker-compose.yaml 文件是我在保证最大硬件兼容性的前提下，对 Overleaf 部署进行定制和优化的成果。通过精准的环境变量配置，我们不仅解决了常见的部署难题，还让 Overleaf 的使用体验更加贴合私有化需求。
欢迎访问我的 GitHub 仓库 xuhe2/sharelatex-ce 获取完整的配置文件和部署指南。

<strong>
来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！