> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 环境变量

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

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

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

### 所有版本

这些环境变量同时兼容 Server CE 和 Server Pro，为这两种本地部署版本之间的迁移提供了便捷途径。它们也可同时用于 Toolkit 和 Docker Compose 部署。

<Info>
  以前，这些环境变量使用 `SHARELATEX_` 前缀，而不是 `OVERLEAF_`。
</Info>

| 名称 | 描述 |
| - | - |
| `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 实例的主机名。两者都是必需的（参见[发布说明](/zh-CN/on-premises/release-notes)）。 |
| `OVERLEAF_REDIS_PORT` 和 `REDIS_PORT` | 要使用的 Redis 实例的端口。两者都是必需的（参见[发布说明](/zh-CN/on-premises/release-notes)）。 |
| `OVERLEAF_REDIS_PASS` 和 `REDIS_PASSWORD` | 连接 Redis 时使用的密码（如适用）。**两个**环境变量都需要设置。更多信息请参阅[启用密码认证](/zh-CN/on-premises/configuration/overleaf-toolkit/redis#enabling-password-authentication)。 |
| `OVERLEAF_REDIS_TLS` | <p>如果设置为 `true`，则允许连接到需要 TLS 的 Redis 实例。<br /><br /><strong>注意：</strong>目前不支持 mTLS。</p> |
| `OVERLEAF_NAV_TITLE` | 设置应用的标签页标题。 |
| `OVERLEAF_HEADER_IMAGE_URL_LIGHT` 和 `OVERLEAF_HEADER_IMAGE_URL_DARK` | 浅色和深色主题下自定义页眉 Logo 的 URL（6.3.0 中新增）。当某个主题对应的变量未设置时，会回退到 `OVERLEAF_HEADER_IMAGE_URL`。参见[品牌定制](/zh-CN/on-premises/configuration/overleaf-toolkit/branding "mention")。 |
| `OVERLEAF_LINKED_URL_OUTBOUND_PROXY` | HTTP(S) 代理的 URL，用于获取外部链接文件，以及通过 Open in Overleaf API 获取外部 ZIP 或 TeX 资源。自重新发布的 Ayakaleaf Pro `6.3.0`（2026 年 10 月 3 日）起可用。不设置则直接连接。示例：`OVERLEAF_LINKED_URL_OUTBOUND_PROXY=http://proxy.internal:3128`。有关配置和网络访问限制，请参阅[出站代理](/zh-CN/on-premises/configuration/overleaf-toolkit/external-url#outbound-proxy "mention")。 |
| `OVERLEAF_INVITE_TOKEN_SECRET` | <p><strong>必需</strong>。用于保护项目共享令牌的随机字符串（Server Pro 6.2.0 中新增）。</p><p><strong>最少字符数：</strong>16</p> |
| `OVERLEAF_SESSION_SECRET` | 用于保护令牌的随机字符串；如果使用负载均衡，需要在所有机器上设置为相同的值。如果只运行 1 个实例，则无需用户设置。 |
| `OVERLEAF_COOKIE_SESSION_LENGTH` | 允许你覆盖默认 5 天的会话 Cookie 过期时间。覆盖值以毫秒为单位。示例：要使会话持续 1 小时，请设置 `COOKIE_SESSION_LENGTH=3600000`。（Server Pro 4.2 中新增） |
| `OVERLEAF_TRUSTED_PROXY_IPS` | <p>如果未设置，默认为 `loopback`。如果手动设置，除了你信任的 IP 之外，还必须包含 `loopback`（或 `127.0.0.1`），以信任在 <strong>sharelatex</strong> 容器内运行的 nginx 实例。仅接受 IP 地址和 CIDR 范围：不要添加 `localhost` 等主机名，否则 Overleaf 将无法启动并返回 `502 Bad Gateway`。<br /><br />如果你的常规网络使用了 `172.16.0.0/12`（Docker 网络的默认子网）中的子网，请在 `config/variables.env` 中设置 `OVERLEAF_TRUSTED_PROXY_IPS=loopback,<network>`。其中 `<network>` 是 `docker inspect overleaf_default` 中 `IPAM -> Config -> Subnet` 的值，例如 `OVERLEAF_TRUSTED_PROXY_IPS=loopback,172.19.0.0/16`。这样可以防止 `X-Forwarded` 请求头被伪造。<br /><br />如果你使用外部 TLS 代理（即不由 Overleaf Toolkit 管理），请确保设置 `OVERLEAF_TRUSTED_PROXY_IPS=loopback,<ip-of-your-tls-proxy>`，例如 `OVERLEAF_TRUSTED_PROXY_IPS=loopback,192.168.13.37`。</p> |
| `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` | <p>用于设置<strong>新</strong>项目默认使用的编译器。（Server Pro 6.2.0 中新增）。</p><p><strong>可选值：</strong>`pdflatex`、`latex`、`xelatex` 或 `lualatex`</p> |
| `OVERLEAF_STATUS_PAGE_URL` | 自定义状态页 URL（Server Pro 3.4.0 中新增），例如 `status.example.com`。 |
| `OVERLEAF_FPH_INITIALIZE_NEW_PROJECTS` | 设置为 `'false'` 可阻止新项目使用完整项目历史（Full Project History）进行初始化（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` | <p>用于修改已删除用户的过期延迟。以毫秒为单位配置。<br /><br /><strong>默认值：</strong>90 天</p> |
| `OVERLEAF_PROJECT_HARD_DELETION_DELAY` | <p>用于修改已删除项目的过期延迟。以毫秒为单位配置。<br /><br /><strong>默认值：</strong>90 天</p> |
| `MAX_UPLOAD_SIZE` | <p>控制单次上传的最大大小，单位为 MB。默认为 `50`。<br /><br /><strong>注意</strong>：此变量只是一个纯数字，不带单位（MB）或任何包装。<br /><br />上传的 `.zip` 文件解压后的总大小限制为该值的 6 倍（默认为 300 MB）。</p> |
| `COMPILE_SIZE_LIMIT` | 控制请求体的最大大小，单位为字节。这是项目中所有文档文件大小的总和（`main.tex`、`references.bib`（如果未链接）等），这些文件需要在初始编译请求中发送到 CLSI 服务。 |
| `COMPILE_TIMEOUT` | 允许编译完成的时间，单位为秒。更多信息请参阅[更新项目编译超时](/zh-CN/on-premises/user-and-project-management/project-management#updating-project-compile-timeout)。 |
| `MAX_RECONNECT_GRACEFULLY_INTERVAL_MS` | 编辑器平滑重连、数据刷新与容器关闭之间的可配置延迟，用于降低数据丢失的风险。 |
| `SECCOMP_PROFILE` | <p>将此环境变量设置为 Docker <strong>主机</strong>上指向 SECCOMP 配置文件的路径。你可以在<a href="https://raw.githubusercontent.com/overleaf/overleaf/365af778b68a7940e08282119dc4ef473e2f0044/services/clsi/seccomp/clsi-profile.json">这里</a>下载该配置文件的副本。<br /><br />目前在 Podman 部署中使用沙盒编译时需要此设置。</p> |
| `OVERLEAF_DISABLE_CHAT` | 如果设置为 `true`，则禁用项目内聊天功能。 |
| `OVERLEAF_LOGIN_SUPPORT_TEXT` | 设置后，可在登录按钮下方显示支持信息。文本会显示在登录界面上，可用于引导用户前往内部支持渠道，或提供与登录、创建账户等相关的指导。 |
| `ALLOW_MONGO_ADMIN_CHECK_FAILURES` | <p>如果设置为 `true`，则允许 MongoDB 启动检查失败而不阻止部署启动。如果你使用的 MongoDB 数据库中，数据库用户不具备 `clusterParameterReader` 角色，则可能需要此设置。<br /><br />有关创建自定义角色的帮助，请参阅<a href="/zh-CN/on-premises/maintenance/updating-mongodb#creating-a-custom-role">这里</a>。</p> |
| `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` 同时使用。 |

<Info>
  使用 Overleaf 登录系统（本地账户）而非 LDAP 等 SSO 方式时，可以对用户强制执行密码限制。对于 SSO 账户，密码策略将由你的身份提供商或目录服务执行，并且还可以支持多因素身份验证。
</Info>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.