环境变量

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

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

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

所有版本

这些环境变量与 Server CE 和 Server Pro 兼容，并提供了在这两种本地部署版本之间轻松迁移的路径。它们也可用于 Toolkit 和 Docker Compose 部署。

以前，这些环境变量前缀为 SHARELATEX_ 而不是 OVERLEAF_.

名称	“
OVERLEAF_SITE_URL	您的 Overleaf 实例对外可访问的地址。此地址用于公共链接以及通过 websockets 连接，因此必须正确配置！
OVERLEAF_ADMIN_EMAIL	用户可用于联系站点运行者的电子邮件地址。
OVERLEAF_APP_NAME	用于显示运行中的应用程序名称。默认值为“Overleaf (Community Edition)”。
OVERLEAF_MONGO_URL 和 MONGO_URL	要使用的 Mongo 数据库的 URL。
OVERLEAF_REDIS_HOST 和 REDIS_HOST	要使用的 Redis 实例的主机名。两者都需要（参见 发行说明).
OVERLEAF_REDIS_PORT 和 REDIS_PORT	要使用的 Redis 实例的端口。两者都需要（参见 发行说明).
OVERLEAF_REDIS_PASS 和 REDIS_PASSWORD	连接到 Redis 时使用的密码（如果适用）。 两者 环境变量需要被设置。参见 启用密码认证 以获取更多信息。
OVERLEAF_REDIS_TLS	如果设置为 true，允许连接到需要 TLS 的 Redis 实例。 注意： 目前不支持 mTLS。
OVERLEAF_NAV_TITLE	设置应用程序的标签页标题。
OVERLEAF_SESSION_SECRET	用于保护令牌的随机字符串；如果做负载均衡，需要在各台机器上设置相同的值。如果只运行一个实例，用户无需设置。
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 （Docker 网络的默认子网）的子网，请设置 172.16.0.0/12 OVERLEAF_TRUSTED_PROXY_IPS=loopback,<network> 在您的 中。 config/variables.env其中 <network> 是 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,<ip-of-your-tls-proxy>中的值，例如 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，将允许匿名用户查看和编辑通过 链接共享 功能共享的项目。
OVERLEAF_DISABLE_LINK_SHARING	禁用 链接共享 功能共享的项目。
EMAIL_CONFIRMATION_DISABLED	当设置为 true 时，请求电子邮件确认的横幅将不会显示。
ADDITIONAL_TEXT_EXTENSIONS	一个字符串数组，用于为可编辑文件配置额外的扩展名。
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 天
COMPILE_SIZE_LIMIT	控制请求正文的最大大小（以字节为单位）。这是项目中所有文档文件大小的总和（main.tex, references.bib （如果未链接）等），需要在向 CLSI 服务发送初始编译请求时一并发送。
COMPILE_TIMEOUT	允许编译完成的时间（以秒为单位）。有关更多信息，请参见 更新项目编译超时.
MAX_RECONNECT_GRACEFULLY_INTERVAL_MS	编辑器优雅重连、数据刷新与容器关闭之间的可配置延迟，以降低数据丢失风险。
SECCOMP_PROFILE	将此环境变量设置为 Docker 主机上的一个路径，指向 SECCOMP 配置文件。您可以在这里下载配置文件的副本 主机 。 这里。 在使用 Sandboxed Compiles 时，目前对于 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.

在使用 Overleaf 登录系统（本地帐户）时，可以强制对用户设置密码限制，而不能用于诸如 LDAP 的 SSO 选项。对于 SSO 帐户，密码策略将由您的身份提供者或目录服务强制执行，并另外支持多因素认证。