> 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/environment-variables.md). # 环境变量 本页面描述在以下内容中支持的环境变量 `config/variables.env` 用于 Toolkit 部署的文件。 该 `config/variables.env` 文件由如下形式的变量定义组成 `NAME=value`；以 `#` 开头的行会被视为注释。 {% hint style="info" %} 在更改以下内容后，必须重新创建 Docker 容器 `overleaf.rc` 或 `variables.env` ，方法是运行 `bin/up`. {% endhint %} ### 所有版本 这些环境变量与 Server CE 和 Server Pro 兼容，并在这两个本地部署版本之间提供了一条简单的迁移路径。它们也可用于 Toolkit 和 Docker Compose 部署。 {% hint style="info" %} 此前，这些环境变量以前缀 `SHARELATEX_` 而不是 `OVERLEAF_`. {% endhint %} | 名称 | 描述 | | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `OVERLEAF_SITE_URL` | 你的 Overleaf 实例可公开访问的位置。此项用于公开链接以及通过 WebSocket 连接，因此必须正确配置！ | | `OVERLEAF_ADMIN_EMAIL` | 用户可以通过此电子邮件地址联系站点管理员。 | | `OVERLEAF_APP_NAME` | 在描述正在运行的应用程序时显示的名称。默认为 'Overleaf (Community Edition)'。 | | `OVERLEAF_MONGO_URL` 和 `MONGO_URL` | 要使用的 Mongo 数据库 URL。 | | `OVERLEAF_REDIS_HOST` 和 `REDIS_HOST` | 要使用的 Redis 实例主机名。两者都必需（参见 [发行说明](broken://pages/3d8261083752d28330f754a0b01aef430bf53084#changes-to-the-docker-compose-file-format)). | | `OVERLEAF_REDIS_PORT` 和 `REDIS_PORT` | 要使用的 Redis 实例端口。两者都必需（参见 [发行说明](broken://pages/3d8261083752d28330f754a0b01aef430bf53084#changes-to-the-docker-compose-file-format)). | | `OVERLEAF_REDIS_PASS` 和 `REDIS_PASSWORD` | 连接 Redis 时使用的密码（如果适用）。 **两者** 环境变量都需要设置。参见 [启用密码身份验证](broken://pages/3386b4bdced793783358089c66e8d0ce4f47badb) 了解更多信息。 | | `OVERLEAF_REDIS_TLS` |

如果设置为 true，则允许连接到需要 TLS 的 Redis 实例。

注意： 当前不支持 mTLS。

| | `OVERLEAF_NAV_TITLE` | 设置应用程序的标签页标题。 | | `OVERLEAF_INVITE_TOKEN_SECRET` |

必需。用于保护项目共享令牌的随机字符串（已在 Server Pro 6.2.0 中添加）。

最少字符数： 16

| | `OVERLEAF_SESSION_SECRET` | 用于保护令牌的随机字符串；如果进行负载均衡，则需要在各节点上设置为相同的令牌。如果只运行 1 个实例，则用户无需设置。 | | `OVERLEAF_COOKIE_SESSION_LENGTH` | 允许你覆盖默认的会话 Cookie 过期时间 5 天。覆盖值应以毫秒为单位。例如：要让会话持续 1 小时，请设置 `COOKIE_SESSION_LENGTH=3600000`。（已在 Server Pro 4.2 中添加） | | `OVERLEAF_TRUSTED_PROXY_IPS` |

如果未设置，默认为 loopback。如果手动设置，除了你的受信任 IP 之外，还必须包含以下之一 loopback, localhost 或 127.0.0.1，该项信任运行在以下容器内的 nginx 实例 sharelatex 容器。

如果使用来自 172.16.0.0/12 （Docker 网络的默认子网）作为你的常规网络，请设置 OVERLEAF\_TRUSTED\_PROXY\_IPS=loopback,\ 在你的 config/variables.env。其中 \ 是 IPAM -> Config -> Subnet 在以下位置的值： docker inspect overleaf\_default，例如 OVERLEAF\_TRUSTED\_PROXY\_IPS=loopback,172.19.0.0/16。这是为了防止伪造 X-Forwarded 标头。

如果你使用的是外部 TLS 代理（即不由 Overleaf Toolkit 管理），请确保 OVERLEAF\_TRUSTED\_PROXY\_IPS=loopback,\，例如 OVERLEAF\_TRUSTED\_PROXY\_IPS=loopback,192.168.13.37.

| | `OVERLEAF_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS` | 如果设置为 `true`，将把项目邀请限制为与现有用户账户对应的电子邮件地址。 | | `OVERLEAF_ALLOW_PUBLIC_ACCESS` | 如果设置为 `true`，将允许未认证用户查看该站点。默认值为 `false`，这意味着未认证用户在尝试查看站点任何部分时都会无条件重定向到登录页面。注意，设置此选项不会以任何方式禁用认证或安全性。如果你的用户打算将其项目公开并让未认证用户查看这些项目，则此选项是必需的。 | | `OVERLEAF_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING` | 如果设置为 `true`，将允许匿名用户查看和编辑通过以下方式共享的项目： [链接共享](https://www.overleaf.com/blog/integration-update-link-sharing-2017-11-27) 功能。 | | `OVERLEAF_DISABLE_LINK_SHARING` | 禁用 [链接共享](https://www.overleaf.com/blog/integration-update-link-sharing-2017-11-27) 功能。 | | `EMAIL_CONFIRMATION_DISABLED` | 当设置为 `true` 时，请求电子邮件确认的横幅将不会显示。 | | `ADDITIONAL_TEXT_EXTENSIONS` | 用于配置可编辑文件附加扩展名的字符串数组。 | | `DEFAULT_LATEX_COMPILER` |

用于设置以下对象使用的默认编译器： 新 项目。（已在 Server Pro 6.2.0 中添加）。

选项： pdflatex, latex, xelatex 或 lualatex

| | `OVERLEAF_STATUS_PAGE_URL` | 自定义状态页面 URL（已在 Server Pro 3.4.0 中添加），例如 `status.example.com`. | | `OVERLEAF_FPH_INITIALIZE_NEW_PROJECTS` | 设置为 `'false'` 以防止新项目在初始化时启用完整项目历史记录（已在 Server Pro 3.5.0 中添加）。 | | `OVERLEAF_FPH_DISPLAY_NEW_PROJECTS` | 设置为 `'false'` 以防止新项目显示完整项目历史记录而不是旧版历史记录（已在 Server Pro 3.5.0 中添加）。 | | `ENABLE_CRON_RESOURCE_DELETION` | 将此环境变量设置为 `true` 以启用对已删除项目和用户在 90 天后的自动清理。 | | `OVERLEAF_USER_HARD_DELETION_DELAY` |

用于修改已删除用户的过期延迟。以毫秒为单位配置。

默认值： 90 天

| | `OVERLEAF_PROJECT_HARD_DELETION_DELAY` |

用于修改已删除项目的过期延迟。以毫秒为单位配置。

默认值： 90 天

| | `MAX_UPLOAD_SIZE` |

控制单次上传的最大大小，单位为兆字节。默认为 50.

注意：此变量只是一个原始数字，没有单位（MB）或包装。

| | `COMPILE_SIZE_LIMIT` | 控制请求体的最大大小，单位为字节。这是项目中所有文档文件大小之和（`main.tex`, `references.bib` （如果未链接）等），需要在初始编译请求中发送到 CLSI 服务。 | | `COMPILE_TIMEOUT` | 允许编译完成的时间（秒）。更多信息请参见 [更新项目编译超时](broken://pages/9159976838d0854f2374f43c671db318ea4d7de8#updating-project-compile-timeout). | | `MAX_RECONNECT_GRACEFULLY_INTERVAL_MS` | 可配置的延迟，用于在编辑器优雅重连、数据刷新和容器关闭之间进行缓冲，以降低数据丢失风险。 | | `SECCOMP_PROFILE` |

将此环境变量设置为 Docker 上的路径 主机 机器上的一个路径，该路径指向 SECCOMP 配置文件。你可以下载该配置文件的副本 此处。

当前在使用沙盒编译时，Podman 部署需要此项。

| | `OVERLEAF_DISABLE_CHAT` | 如果设置为 `true`，禁用项目内聊天功能。 | | `OVERLEAF_LOGIN_SUPPORT_TEXT` | 设置后，可用于在登录按钮下方显示支持信息。该文本将显示在登录界面，可用于引导用户联系内部支持或提供与登录、创建账户等相关的说明。 | | `ALLOW_MONGO_ADMIN_CHECK_FAILURES` |

如果设置为 true，允许 MongoDB 启动检查失败而不阻止部署启动。如果你使用的 MongoDB 数据库中数据库用户没有以下权限，这可能是必需的 clusterParameterReader 角色。

有关创建自定义角色的帮助，请参见 此处.

| | `V1_HISTORY_URL_FOR_GIT_BRIDGE` | 允许将以下内容分离： **history-v1** 内部流量的端点（`web` 服务 → `history-v1` 服务，两者都在 `sharelatex` 容器中）与外部流量（`git-bridge` → `history-v1`，在独立容器中运行）。 | | `OVERLEAF_MAINTENANCE_MESSAGE` 和 `OVERLEAF_MAINTENANCE_MESSAGE_HTML` | 用于自定义维护页面的标题和内容。不能与以下项一起使用： `OVERLEAF_STATUS_PAGE_URL`. | {% hint style="info" %} 在使用 Overleaf 登录系统（本地账户）时，可以对用户强制执行密码限制，而不是 SSO 选项（如 LDAP）。对于 SSO 账户，密码策略将由你的身份提供方或目录服务强制执行，同时还支持多因素身份验证。 {% endhint %} --- # 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/environment-variables.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.