> For the complete documentation index, see [llms.txt](https://ayakaleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ayakaleaf-pro.ayaka.space/on-premises/zh-cn/pei-zhi/overleaf-toolkit/toolkit-settings.md).
# Toolkit 设置
本页面描述在以下内容中支持的环境变量 `config/overleaf.rc` 用于 Toolkit 部署的文件。
该 `config/overleaf.rc` 文件由如下形式的变量定义组成 `NAME=value`。以……开头的行 `#` 开头的行会被视为注释。
{% hint style="info" %}
在更改以下内容后，必须重新创建 Docker 容器 `overleaf.rc` 或 `variables.env` ，方法是运行 `bin/up`.
{% endhint %}
## 容器
### `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，告诉 Toolkit 使用 Server Pro 镜像（quay.io/sharelatex/sharelatex-pro），而不是默认的 Server CE 镜像（sharelatex/sharelatex).
- 默认: false
|
| `GIT_BRIDGE_ENABLED` | 设置为 true 以启用 git-bridge 功能（仅 Server Pro）。更多信息请参见 用户文档。
- 默认： false
|
| `GIT_BRIDGE_IMAGE` | git-bridge 容器使用的 Docker 镜像（仅 Server Pro）。这只是 Docker 镜像名称；Docker 镜像标签取自 config/version.
- 默认： quay.io/sharelatex/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=true
- 默认： true
|
| `SIBLING_CONTAINERS_PULL` | 当设置为 true，告诉 Toolkit 自动拉取使用……设置的所有 TeX Live 镜像 ALL\_TEX\_LIVE\_DOCKER\_IMAGES 设置在 config/variables.env 文件，当使用 bin/up 命令时。
- 默认： true
|
| `DOCKER_SOCKET_PATH` | 设置主机机器（运行 Toolkit 的机器）上的 Docker 套接字路径。当 SIBLING\_CONTAINERS\_ENABLED 为 true时，该套接字将被挂载到容器中，以允许编译服务在主机上启动新的 Docker 容器。
- 需要： SIBLING\_CONTAINERS\_ENABLED=true
- 默认： /var/run/docker.sock
|
| `文件中，或者在` | 设置将被挂载到主 sharelatex 容器中，并用于存储编译数据。这可以是完整路径（以 /），也可以相对于 Toolkit 的基础目录。
- 默认： data/overleaf
|
| `OVERLEAF_LISTEN_IP` | 设置容器将绑定到的主机 IP 地址。例如，如果将其设置为 0.0.0.0，则网页界面将可通过任意主机 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，则网页界面将可在
- 默认： 80
|
| `OVERLEAF_LOG_PATH` | 设置将被挂载到主 sharelatex 容器中，并用于将应用日志提供到 Docker 主机。这可以是完整路径（以 /），也可以相对于 Toolkit 的基础目录。删除配置项即可禁用绑定挂载。未设置时，重新创建容器时日志将被丢弃。
有关日志记录的信息请参见。
- 默认： 未设置
|
***
### `mongo`
| 名称 | 描述 |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `MONGO_ENABLED` | 当设置为 true，告诉 Toolkit 创建一个 MongoDB 容器来托管数据库。当设置为 false时，不会创建此容器，系统将使用由……指定的 MongoDB 数据库 MONGO\_URL 作为替代。
- 默认: true
|
| `MONGO_URL` | 指定在……时要使用的 MongoDB 连接 URL MONGO\_ENABLED 为 false.
- 默认：未设置
|
| `MONGO_DATA_PATH` | 设置将被挂载到……中的目录路径 mongo 容器中，并用于存储 MongoDB 数据库。这可以是完整路径（以 /），也可以相对于 toolkit 的基础目录。此选项只影响本地 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 数据库 REDIS\_HOST 和 REDIS\_PORT 作为替代。
- 默认: true
|
| `REDIS_HOST` | 指定在……时要使用的 Redis 主机 REDIS\_ENABLED 为 false.
- 默认：未设置
|
| `REDIS_PORT` | 指定在……时要使用的 Redis 端口 REDIS\_ENABLED 为 false.
- 默认：未设置
|
| `REDIS_DATA_PATH` | 设置将被挂载到……中的目录路径 redis 容器中，并用于存储 Redis 数据库。这可以是完整路径（以 /），也可以相对于 Toolkit 的基础目录。此选项只影响本地 redis 容器，该容器在……时创建 REDIS\_ENABLED 为 true.
- 默认: data/redis
|
| `REDIS_AOF_PERSISTENCE` | 为 Redis 启用 AOF（仅追加文件）持久化。这是 推荐的 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 则 HTTPS 网页界面将在任意主机 IP 地址上可用。通常应将其设置为主机的外部 IP。
- 默认: 127.0.1.1
|
| `NGINX_HTTP_LISTEN_IP` | 设置 TLS 代理容器用于 HTTP 重定向绑定的主机 IP 地址。例如，如果将其设置为 127.0.1.1 则对……的 HTTP 连接将 127.0.1.1 会被重定向到 HTTPS 网页界面。通常应将其设置为主机的外部 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
|
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://ayakaleaf-pro.ayaka.space/on-premises/zh-cn/pei-zhi/overleaf-toolkit/toolkit-settings.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.