文件和位置

本页描述了 Toolkit 用于配置您本地部署的 Overleaf 的配置文件。

持久化数据

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

数据目录

该 sharelatex container 需要一个目录来存储与 LaTeX 编译相关的数据。该目录由 OVERLEAF_DATA_PATH 变量在 config/overleaf.rc.

该 mongo container（如果启用）需要一个目录来存储其数据库文件，另一个 redis container 也是如此。这些目录也可以在 config/overleaf.rc.

文件权限

因为 Docker 以 root身份运行，所以数据目录最终将被 root 用户拥有，即使 Toolkit 由非 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 等其他高级设置。

要查看所有可用环境变量的详细说明，请参阅 环境变量 部分。

该 版本 文件

该 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 文档 以获取更多详细信息。