環境変数
このページでは、に対応している環境変数について説明します config/variables.env Toolkit デプロイのためのファイル。
その config/variables.env ファイルは次の形式の変数定義で構成されています NAME=value；で始まる行は # コメントとして扱われます。
にある何かを変更した後は Docker コンテナを再作成する必要があります overleaf.rc または variables.env を実行して bin/up.
すべてのバージョン
これらの環境変数は Server CE と Server Pro と互換性があり、これら 2 つのオンプレミス版間の簡単な移行経路を提供します。Toolkit と Docker Compose の両方のデプロイでも使用できます。
以前、これらの環境変数はプレフィックスが付けられていました SHARELATEX_ の代わりに OVERLEAF_.
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 インスタンスのホスト名。どちらも必須です（詳細は リリースノート).
OVERLEAF_REDIS_PORT および REDIS_PORT
使用する Redis インスタンスのポート。どちらも必須です（詳細は リリースノート).
OVERLEAF_REDIS_PASS および REDIS_PASSWORD
Redis に接続する際に使用するパスワード（該当する場合）。 両方の 環境変数を設定する必要があります。詳細は パスワード認証を有効にする方法 を参照してください。
OVERLEAF_REDIS_TLS
に設定すると trueTLS を要求する Redis インスタンスへの接続を許可します。
注： mTLS は現在サポートされていません。
OVERLEAF_NAV_TITLE
アプリケーションのタブタイトルを設定します。
OVERLEAF_SESSION_SECRET
トークンを保護するために使用されるランダムな文字列。ロードバランシングを行う場合はボックス間で同じ値に設定する必要があります。インスタンスが 1 台のみの場合、ユーザーが設定する必要はありません。
OVERLEAF_COOKIE_SESSION_LENGTH
既定のセッションクッキー有効期限（5 日）を上書きできます。上書き値はミリ秒単位にしてください。例：セッションを 1 時間にするには、 COOKIE_SESSION_LENGTH=3600000と設定します。（Server Pro 4.2 で追加）
OVERLEAF_TRUSTED_PROXY_IPS
設定されていない場合、既定は ループバックです。手動で設定する場合、信頼する IP に加えて次のいずれかを含める必要があります ループバック, localhost または 127.0.0.1。これはコンテナ内で実行されている nginx インスタンスを信頼します。
のサブネット（Docker ネットワークの既定サブネット）を通常のネットワークに使用している場合は、 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' 新しいプロジェクトが Full Project History で初期化されるのを防ぎます（Server Pro 3.5.0 で追加）。
OVERLEAF_FPH_DISPLAY_NEW_PROJECTS
に設定すると 'false' 新しいプロジェクトが従来の履歴ではなく Full Project History を表示するのを防ぎます（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 の起動チェックが失敗してもデプロイの開始を妨げないようにできます。これは、データベースユーザーが clusterParameterReader ロールを持たない MongoDB を使用している場合に必要になることがあります。
カスタムロールの作成については、を参照してください。 こちら.
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 のログインシステム（ローカルアカウント）を使用している場合、SSO（LDAP など）ではなく、ユーザーに対してパスワード制限を強制することが可能です。SSO アカウントの場合、パスワードポリシーはあなたの ID プロバイダーまたはディレクトリサービスによって強制され、さらに多要素認証のサポートが可能になります。