Skip to main content
本页介绍 Toolkit 用于配置 Overleaf 本地部署的配置文件。

持久化数据

Overleaf Toolkit 需要存储持久化数据,例如编译 LaTeX 项目所需的文件以及 MongoDB 数据库的内容。这是通过将宿主机上的若干目录挂载到 Docker 容器中,并将数据写入这些目录来实现的。

数据目录

sharelatex 容器需要一个目录来存储与 LaTeX 编译相关的数据。该目录通过 config/overleaf.rc 中的 OVERLEAF_DATA_PATH 变量设置。 如果启用了 mongo 容器,它需要一个目录来存储其数据库文件,redis 容器同理。这些目录同样可以在 config/overleaf.rc 中配置。

文件权限

由于 Docker 以 root 身份运行,即使 Toolkit 由非 root 用户使用,数据目录最终也会归 root 用户所有。这不是问题,但如果你打算在容器外部修改持久化数据,则需要注意这一点。

配置文件位置

所有用户所有的配置文件都位于 config/ 目录中。 该目录不受 git 版本控制系统管理,因此更新 Toolkit 代码不会更改它。未经你的许可,Toolkit 不会更改 config/ 目录中的任何数据。
对配置文件的更改不会自动应用到现有容器,即使停止并重新启动容器(使用 bin/stop 和 bin/start)也不会。要应用更改,请运行 bin/up,docker compose 会在后台自动将配置更改应用到新容器。(如果不想附加到 Docker 日志,也可以运行 bin/up -d。)

overleaf.rc 文件

config/overleaf.rc 文件包含 Toolkit 使用的最重要的顶层配置设置。它包含以 VARIABLE_NAME=value 格式设置变量的语句。 要查看所有可用配置选项的详细说明,请参阅我们的设置部分。

variables.env 文件

config/variables.env 文件包含加载到 sharelatex 容器中的环境变量,用于配置 Overleaf 的各个微服务。其中包括显示在 Web 界面页眉中的应用名称、发送邮件的设置,以及其他高级设置,例如用于 Server Pro 的 SSO。 要查看所有可用环境变量的详细说明,请参阅环境变量部分。

version 文件

config/version 文件包含用于创建 Overleaf 服务器运行实例的 Docker 镜像版本号。
对这些配置文件的更改不会自动应用到现有容器,即使停止并重新启动容器(使用 bin/stop 和 bin/start)也不会。要应用更改,请运行 bin/up,Toolkit 会自动为你创建一个应用了配置更改的新容器。

docker-compose.override.yml 文件

如果存在 config/docker-compose.override.yml 文件,它会被包含在 docker compose 的调用中。这对于覆盖 Docker Compose 特有的配置非常有用。 更多详情请参阅 docker-compose 文档。
最后修改于 2026年10月5日