工具包设置

本页描述了在以下文件中受支持的环境变量 config/overleaf.rc Toolkit 部署的文件。

该 config/overleaf.rc 文件由形如的变量定义组成 NAME=value. 以以下内容开始的行 # （注释行）

在更改任何 overleaf.rc 或 variables.env 之后，需要通过运行来重新创建 Docker 容器。 bin/up.

容器

sharelatex

名称	“
PROJECT_NAME	设置以下的值 --project-name 提供给 docker-compose标志。这在在一台主机上运行多个 Overleaf 实例时很有用，因为每个实例可以有不同的项目名称。 - 默认: overleaf
OVERLEAF_IMAGE_NAME	由 Server Pro/CE 应用容器使用的 Docker 映像。这只是 Docker 映像名称；Docker 映像标签来自 config/version. - 默认： - Server Pro： quay.io/sharelatex/sharelatex-pro - 社区版： sharelatex/sharelatex
SERVER_PRO	当设置为 true，告诉工具包使用 Server Pro 映像（quay.io/sharelatex/sharelatex-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 容器（仅限 Server Pro）使用的 Docker 映像。这只是 Docker 映像名称；Docker 映像标签来自 config/version. - 默认： quay.io/sharelatex/git-bridge
GIT_BRIDGE_DATA_PATH	设置将挂载到 git-bridge 容器（仅限 Server Pro）并用于存储 git 仓库的目录路径。这可以是完整路径（以 /开头），也可以是相对于工具包基目录的相对路径。
GIT_BRIDGE_LOG_LEVEL	配置 git-bridge 容器的日志级别。可用级别： 跟踪（TRACE）, 调试（DEBUG）, 信息（INFO）, 警告（WARN）, 错误（ERROR）. - 默认： 信息（INFO）
SIBLING_CONTAINERS_ENABLED	当设置为 true，告诉工具包使用 兄弟容器（Sibling Containers） 技术，在单独的沙箱中编译项目，为每个项目使用单独的 Docker 容器。有关更多信息，请参见 <server-pro-only-configuration/sandboxed-compiles> 文档。 - 要求： SERVER_PRO=true - 默认： true
SIBLING_CONTAINERS_PULL	当设置为 true，告诉工具包在使用 ALL_TEX_LIVE_DOCKER_IMAGES 在 config/variables.env 文件时自动拉取所有使用该文件设置的 TeX Live 映像，当使用 bin/up 命令。 - 默认： true
DOCKER_SOCKET_PATH	设置主机（运行工具包的机器）上 Docker 套接字的路径。当 SIBLING_CONTAINERS_ENABLED 为 true时，套接字将被挂载到容器中，以允许编译服务在主机上生成新的 Docker 容器。 - 要求： overleaf-toolkit/config/overleaf.rc - 默认： /var/run/docker.sock
OVERLEAF_DATA_PATH	设置将挂载到主 sharelatex 容器并用于存储编译数据的目录路径。这可以是完整路径（以 /开头），也可以是相对于工具包基目录的相对路径。 - 默认： data/overleaf
OVERLEAF_LISTEN_IP	设置容器将绑定到的主机 IP 地址。例如，如果设置为 0.0.0.0，则 Web 界面将在任何主机 IP 地址上可用。要直接访问容器，必须将 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，则 Web 界面将在 http://localhost:8099. - 默认： 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 数据库。这可以是完整路径（以 /开头），或相对于工具包的基础目录。此选项仅影响在 mongo 创建时创建的本地 MONGO_ENABLED 为 true. - 默认: 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 指定的 MongoDB 数据库。 - 默认: true
REDIS_HOST	指定的 Redis 主机。 - REDIS_ENABLED 为 false. - 默认时要使用的 MongoDB 连接 URL：未设置
REDIS_PORT	指定在 REDIS_ENABLED 为 false. - 默认时要使用的 MongoDB 连接 URL：未设置
REDIS_DATA_PATH	设置将挂载到 redis 时要使用的 Redis 端口。 - /容器，并用于存储 Redis 数据库。这可以是完整路径（以 redis 创建时创建的本地 REDIS_ENABLED 为 true. - 默认: 开头），或相对于 Toolkit 的基础目录。此选项仅影响本地
REDIS_AOF_PERSISTENCE	data/redis 为 Redis 打开 AOF（仅追加文件）持久化。这是 推荐的 默认： true

---

nginx

名称	“
为了运行代理，请更改	当设置为 trueRedis 持久化配置。 有关详细信息，请参见 <../../../maintenance/data-and-backups#aof-append-only-file> 中的 <../../maintenance/data-and-backups> 部分。 - 默认: false
NGINX_CONFIG_PATH	，告诉 Toolkit 创建一个 NGINX 容器以充当 TLS 代理。 - 默认: config/nginx/nginx.conf
NGINX_HTTP_LISTEN_IP	用于 TLS 代理的 NGINX 配置文件路径。 - 0.0.0.0 设置 TLS 代理容器将为 HTTPS 绑定的主机 IP 地址。例如，如果设置为 默认: 127.0.1.1
。要更改 NGINX 监听的 IP 地址，请设置	，则 HTTPS Web 界面将在任何主机 IP 地址上可用。通常应将此设置为主机的外部 IP。 - 127.0.1.1 设置 TLS 代理容器将为 HTTP 重定向绑定的主机 IP 地址。例如，如果设置为 127.0.1.1 ，则对 0.0.0.0 的 HTTP 连接将被重定向到 HTTPS Web 界面。通常应将此设置为主机的外部 IP。不要将其设置为 OVERLEAF_LISTEN_IP. - 默认: 127.0.1.1
变量。端口可以通过	，因为这通常会与 默认: 80
NGINX_HTTP_PORT	冲突。 - 默认: 443
TLS_PRIVATE_KEY_PATH	设置 TLS 代理容器将为 HTTP 绑定的主机端口。 - 默认: config/nginx/certs/overleaf_key.pem
TLS_CERTIFICATE_PATH	设置 TLS 代理容器将为 HTTPS 绑定的主机端口。 - 默认: config/nginx/certs/overleaf_certificate.pem