Toolkit 设置

本页介绍 Toolkit 部署中 config/overleaf.rc 文件所支持的环境变量。

config/overleaf.rc 文件由 NAME=value 形式的变量定义组成。以 # 开头的行被视为注释。

修改 overleaf.rc 或 variables.env 中的任何内容后，必须运行 bin/up 重新创建 Docker 容器。

​

容器

​

sharelatex

名称	说明
PROJECT_NAME	设置传递给 docker-compose 的 --project-name 标志的值。当在同一台主机上运行多个 Overleaf 实例时，这非常有用，因为每个实例都可以使用不同的项目名称。 - 默认值：overleaf
OVERLEAF_IMAGE_NAME	Server Pro/CE 应用容器所使用的 Docker 镜像。这里只是 Docker 镜像名称；Docker 镜像标签取自 config/version。 - 默认值： - Server Pro：ghcr.io/ayaka-notes/overleaf-pro - Community Edition：sharelatex/sharelatex
SERVER_PRO	设置为 true 时，Toolkit 将使用 Server Pro 镜像（ghcr.io/ayaka-notes/overleaf-pro），而不是默认的 Server CE 镜像（sharelatex/sharelatex）。 - 默认值：false
GIT_BRIDGE_ENABLED	设置为 true 以启用 git-bridge 功能（仅限 Server Pro）。更多信息请参阅 https://www.overleaf.com/learn/how-to/Git_integration 用户文档。 - 默认值： false
GIT_BRIDGE_IMAGE	git-bridge 容器所使用的 Docker 镜像（仅限 Server Pro）。这里只是 Docker 镜像名称；Docker 镜像标签取自 config/version。 - 默认值： ghcr.io/ayaka-notes/overleaf-pro/git-bridge
GIT_BRIDGE_DATA_PATH	设置将挂载到 git-bridge 容器（仅限 Server Pro）中、用于存储 git 仓库的目录路径。可以是完整路径（以 / 开头），也可以是相对于 Toolkit 根目录的路径。
GIT_BRIDGE_LOG_LEVEL	配置 git-bridge 容器的日志级别。可用级别：TRACE、DEBUG、INFO、WARN、ERROR。 - 默认值： INFO
SIBLING_CONTAINERS_ENABLED	设置为 true 时，Toolkit 将使用兄弟容器（Sibling Containers）技术在独立的沙箱中编译项目，为每个项目使用单独的 Docker 容器。更多信息请参阅 <server-pro-only-configuration/sandboxed-compiles> 文档。 - 依赖： SERVER_PRO=true - 默认值： true
SIBLING_CONTAINERS_PULL	设置为 true 时，Toolkit 会在执行 bin/up 命令时自动拉取 config/variables.env 文件中通过 ALL_TEX_LIVE_DOCKER_IMAGES 设置的所有 TeX Live 镜像。 - 默认值： true
DOCKER_SOCKET_PATH	设置宿主机（运行 Toolkit 的机器）上 Docker socket 的路径。当 SIBLING_CONTAINERS_ENABLED 为 true 时，该 socket 会被挂载到容器中，以便编译服务在宿主机上创建新的 Docker 容器。 - 依赖： SIBLING_CONTAINERS_ENABLED=true - 默认值： /var/run/docker.sock
OVERLEAF_DATA_PATH	设置将挂载到主 sharelatex 容器中、用于存储编译数据的目录路径。可以是完整路径（以 / 开头），也可以是相对于 Toolkit 根目录的路径。 - 默认值： data/overleaf
OVERLEAF_LISTEN_IP	设置容器所绑定的主机 IP 地址。例如，如果设置为 0.0.0.0，则可以通过任意主机 IP 地址访问 Web 界面。若要直接访问容器，必须将 OVERLEAF_LISTEN_IP 的值设置为你的公网 IP 地址。将 OVERLEAF_LISTEN_IP 设置为 0.0.0.0 或主机的外部 IP，在与 . 一起使用时通常会导致错误。 - 默认值： 127.0.0.1
OVERLEAF_PORT	设置容器所绑定的主机端口。例如，如果设置为 8099 且 OVERLEAF_LISTEN_IP 设置为 127.0.0.1，则可以通过 http://localhost:8099 访问 Web 界面。 - 默认值： 80
OVERLEAF_LOG_PATH	设置将挂载到主 sharelatex 容器中、用于在 Docker 宿主机上提供应用日志的目录路径。可以是完整路径（以 / 开头），也可以是相对于 Toolkit 根目录的路径。删除此配置项即可禁用绑定挂载。未设置时，重新创建容器会丢弃日志。 有关日志的信息，请参阅 。 - 默认值： 未设置

---

​

mongo

名称	说明
MONGO_ENABLED	设置为 true 时，Toolkit 将创建一个 MongoDB 容器来托管数据库。设置为 false 时，不会创建该容器，系统将改用 MONGO_URL 指定的 MongoDB 数据库。 - 默认值：true
MONGO_URL	指定当 MONGO_ENABLED 为 false 时使用的 MongoDB 连接 URL。 - 默认值：未设置
MONGO_DATA_PATH	设置将挂载到 mongo 容器中、用于存储 MongoDB 数据库的目录路径。可以是完整路径（以 / 开头），也可以是相对于 Toolkit 根目录的路径。此选项仅影响 MONGO_ENABLED 为 true 时创建的本地 mongo 容器。 - 默认值：data/mongo
MONGO_IMAGE	MongoDB 容器所使用的 Docker 镜像。这里只是 Docker 镜像名称；Docker 镜像标签应填写在 MONGO_VERSION 中（见下文）。 - 默认值： mongo
MONGO_VERSION	MongoDB 容器所使用的 MongoDB 版本。该值必须以 MongoDB 主版本号加一个点开头，例如 6.0 或 6.0-with-suffix。 - 默认值： 6.0

---

​

redis

名称	说明
REDIS_ENABLED	设置为 true 时，Toolkit 将创建一个 Redis 容器来托管 Redis 数据库。设置为 false 时，不会创建该容器，系统将改用 REDIS_HOST 和 REDIS_PORT 指定的 Redis 数据库。 - 默认值：true
REDIS_HOST	指定当 REDIS_ENABLED 为 false 时使用的 Redis 主机。 - 默认值：未设置
REDIS_PORT	指定当 REDIS_ENABLED 为 false 时使用的 Redis 端口。 - 默认值：未设置
REDIS_DATA_PATH	设置将挂载到 redis 容器中、用于存储 Redis 数据库的目录路径。可以是完整路径（以 / 开头），也可以是相对于 Toolkit 根目录的路径。此选项仅影响 REDIS_ENABLED 为 true 时创建的本地 redis 容器。 - 默认值：data/redis
REDIS_AOF_PERSISTENCE	为 Redis 开启 AOF（Append Only File）持久化。这是 Redis 持久化的推荐配置。 更多详情，请参阅 <../../maintenance/data-and-backups> 中的 <../../../maintenance/data-and-backups#aof-append-only-file> 部分。 - 默认值： true

---

​

nginx

名称	说明
NGINX_ENABLED	设置为 true 时，Toolkit 将创建一个 NGINX 容器作为 TLS 代理。 - 默认值：false
NGINX_CONFIG_PATH	TLS 代理所使用的 NGINX 配置文件路径。 - 默认值：config/nginx/nginx.conf
NGINX_TLS_LISTEN_IP	设置 TLS 代理容器为 HTTPS 绑定的主机 IP 地址。例如，如果设置为 0.0.0.0，则可以通过任意主机 IP 地址访问 HTTPS Web 界面。通常应将其设置为主机的外部 IP。 - 默认值：127.0.1.1
NGINX_HTTP_LISTEN_IP	设置 TLS 代理容器为 HTTP 重定向绑定的主机 IP 地址。例如，如果设置为 127.0.1.1，则对 127.0.1.1 的 HTTP 连接将被重定向到 HTTPS Web 界面。通常应将其设置为主机的外部 IP。不要将其设置为 0.0.0.0，因为这通常会与 OVERLEAF_LISTEN_IP 发生冲突。 - 默认值：127.0.1.1
NGINX_HTTP_PORT	设置 TLS 代理容器为 HTTP 绑定的主机端口。 - 默认值：80
TLS_PORT	设置 TLS 代理容器为 HTTPS 绑定的主机端口。 - 默认值：443
TLS_PRIVATE_KEY_PATH	TLS 代理所使用的私钥路径。 - 默认值：config/nginx/certs/overleaf_key.pem
TLS_CERTIFICATE_PATH	TLS 代理所使用的公共证书路径。 - 默认值：config/nginx/certs/overleaf_certificate.pem