Toolkit 設定
このページでは、に対応している環境変数について説明します config/overleaf.rc Toolkit デプロイのためのファイル。
その config/overleaf.rc ファイルは次の形式の変数定義で構成されています NAME=value. で始まる行 # コメントとして扱われます。
にある何かを変更した後は Docker コンテナを再作成する必要があります overleaf.rc または variables.env を実行して bin/up.
コンテナ
sharelatex
sharelatexPROJECT_NAME
の値を設定します --project-name に渡されるフラグ docker-compose. これは、1台のホスト上で複数の Overleaf インスタンスを実行する場合に便利です。各インスタンスは異なるプロジェクト名を持つことができます。
- デフォルト: overleaf
OVERLEAF_IMAGE_NAME
Server Pro/CE アプリケーションコンテナで使用される Docker イメージ。これは Docker イメージ名のみで、Docker イメージのタグはから取得されます config/version.
- デフォルト:
- Server Pro: quay.io/sharelatex/sharelatex-pro
- Community Edition: sharelatex/sharelatex
SERVER_PRO
に設定すると true、Toolkit に Server Pro イメージ(quay.io/sharelatex/sharelatex-pro)を使用させ、デフォルトの Server CE イメージ(sharelatex/sharelatex).
- デフォルト: false
Server Proコンテナの設定:
に設定すると true )の代わりに使用するよう指示します。git-bridge 機能を有効にするには(Server Pro のみ)。詳細は https://www.overleaf.com/learn/how-to/Git_integration のユーザードキュメントを参照してください。
- デフォルト: false
GIT_BRIDGE_IMAGE
git-bridge コンテナ(Server Pro のみ)で使用される Docker イメージ。これは Docker イメージ名のみで、Docker イメージのタグはから取得されます config/version.
- デフォルト: quay.io/sharelatex/git-bridge
GIT_BRIDGE_DATA_PATH
(Server Pro のみ)コンテナにマウントされ、git リポジトリを保存するために使用されるディレクトリへのパスを設定します。これはフルパス(で始まる)か、Toolkit のベースディレクトリからの相対パスのいずれかにできます。 git-bridge コンテナ(Server Pro のみ)にマウントされ、git リポジトリを保存するために使用されるディレクトリへのパスを設定します。これはフルパス(で始まる)、または Toolkit のベースディレクトリからの相対パスのいずれかにできます。 /)、または Toolkit のベースディレクトリからの相対パスにできます。
GIT_BRIDGE_LOG_LEVEL
コンテナのログレベルを設定します git-bridge 。利用可能なレベル: TRACE, DEBUG, INFO, WARN, ERROR.
- デフォルト: INFO
SIBLING_CONTAINERS_ENABLED
に設定すると true、Toolkit に Sibling Containers 手法を使用して、各プロジェクトごとに別々の Docker コンテナを使ったサンドボックスでプロジェクトをコンパイルするよう指示します。詳細は <server-pro-only-configuration/sandboxed-compiles> ドキュメントを参照してください。
- 必要条件: SERVER_PRO=true
- デフォルト: true
SIBLING_CONTAINERS_PULL
に設定すると true、Toolkit に、コマンド使用時にで設定されたすべての TeX Live イメージを自動的にプルするよう指示します ALL_TEX_LIVE_DOCKER_IMAGES Toolkit で使用される config/variables.env ファイルを使用するときに bin/up コマンド。
- デフォルト: true
DOCKER_SOCKET_PATH
Toolkit を実行しているホストマシン上の Docker ソケットへのパスを設定します。が設定されていると、ソケットはコンテナにマウントされ、コンパイラサービスがホスト上で新しい Docker コンテナを起動できるようになります。
- SIBLING_CONTAINERS_ENABLED に設定されていると trueが設定されていると、ソケットはコンテナにマウントされ、コンパイラサービスがホスト上で新しい Docker コンテナを起動できるようになります。
- 必要条件: overleaf-toolkit/config/overleaf.rc
- デフォルト: /var/run/docker.sock
OVERLEAF_DATA_PATH
メインのコンテナにマウントされ、コンパイルデータを保存するために使用されるディレクトリへのパスを設定します。これはフルパス(で始まる)、または Toolkit のベースディレクトリからの相対パスのいずれかにできます。
- sharelatex メインの /コンテナにマウントされ、コンパイルデータを保存するために使用されるディレクトリへのパスを設定します。これはフルパス(で始まる)、または Toolkit のベースディレクトリからの相対パスのいずれかにできます。
- デフォルト: data/overleaf
外部アクセスを許可するには、
コンテナがバインドするホストの IP アドレスを設定します。例えば、これがに設定されている場合、Web インターフェースは任意のホスト IP アドレスで利用可能になります。コンテナに直接アクセスするには、の値をあなたのパブリック IP アドレスに設定する必要があります。にを設定すると、通常外部 IP と一緒に使用するとエラーになります。
- 0.0.0.0、その場合 Web インターフェースは任意のホスト IP アドレスで利用可能になります。コンテナに直接アクセスするには、の値をあなたのパブリック IP アドレスに設定する必要があります。にを設定すると、通常外部 IP と一緒に使用するとエラーになります。
- 外部アクセスを許可するには、 はあなたのパブリック IP アドレスに設定する必要があります。にを設定すると、通常外部 IP と一緒に使用するとエラーになります。
- 外部アクセスを許可するには、 にどちらかを設定すると 0.0.0.0 またはホストの外部 IP は、通常 と併用するとエラーを引き起こします。
- デフォルト: 127.0.0.1
OVERLEAF_LISTEN_IP
コンテナがバインドするホストのポートを設定します。例えば、これがに設定され、がに設定されていると、 8099 および 外部アクセスを許可するには、 がに設定されていると、 127.0.0.1その場合、Web インターフェースは http://localhost:8099.
- デフォルト: 80
OVERLEAF_LOG_PATH
メインのコンテナにマウントされ、コンパイルデータを保存するために使用されるディレクトリへのパスを設定します。これはフルパス(で始まる)、または Toolkit のベースディレクトリからの相対パスのいずれかにできます。
- sharelatex コンテナにマウントされ、Docker ホスト上でアプリケーションログを利用可能にするために使用されます。これはフルパス(で始まる)か、Toolkit のベースディレクトリからの相対パスのいずれかにできます。バインドマウントを無効にするには設定エントリを削除してください。未設定の場合、コンテナを再作成するとログは破棄されます。
ログに関する情報は を参照してください。
- /これを設定しない デフォルト: 未設定
mongo
mongoMONGO_ENABLED
に設定すると true、Toolkit にデータベースをホストする MongoDB コンテナを作成するよう指示します。がに設定されている場合、このコンテナは作成されず、代わりにで指定された MongoDB データベースが使用されます。
- falseがに設定されている場合、このコンテナは作成されず、代わりにで指定された MongoDB データベースが使用されます。
- MONGO_URL 代わりに使用されます。
- デフォルト: true
MONGO_URL
が設定されているときに使用する MongoDB 接続 URL を指定します MONGO_ENABLED に設定されていると false.
- デフォルト:未設定
ShareLaTeX
(Server Pro のみ)コンテナにマウントされ、git リポジトリを保存するために使用されるディレクトリへのパスを設定します。これはフルパス(で始まる)か、Toolkit のベースディレクトリからの相対パスのいずれかにできます。 mongo コンテナにマウントされ、MongoDB データベースを保存するために使用されるディレクトリへのパスを設定します。これはフルパス(で始まる)か、ツールキットのベースディレクトリからの相対パスのいずれかにできます。このオプションは、が設定されてローカルのコンテナが作成される場合にのみ影響します。 /)、またはツールキットのベースディレクトリからの相対パスのいずれかにできます。このオプションは、が設定されてローカルのコンテナが作成される場合にのみ影響します。 mongo コンテナが作成されるときにのみ影響します MONGO_ENABLED に設定されていると true.
- デフォルト: data/mongo
MONGO_IMAGE
MongoDB コンテナで使用される Docker イメージ。これは Docker イメージ名のみで、Docker イメージのタグは(下記参照)に入れるべきです。
- MONGO_VERSION MongoDB コンテナで使用される MongoDB バージョン。値はメジャー MongoDB バージョンとドットで始まる必要があります。例えば デフォルト: mongo
MONGO_VERSION
MongoDB バージョン。値はメジャー MongoDB バージョンとドットで始まる必要があります。例: 6.0 または 6.0-with-suffix.
- デフォルト: 6.0
redis
redisREDIS_ENABLED
に設定すると true、Toolkit に Redis データベースをホストする Redis コンテナを作成するよう指示します。がに設定されている場合、このコンテナは作成されず、システムはで指定された Redis データベースを使用します。 falseがに設定されている場合、このコンテナは作成されず、システムはで指定された Redis データベースを使用します。 REDIS_HOST および REDIS_PORT 代わりに使用されます。
- デフォルト: true
REDIS_HOST
が設定されているときに使用する Redis ホストを指定します REDIS_ENABLED に設定されていると false.
- デフォルト:未設定
REDIS_PORT
が設定されているときに使用する Redis ポートを指定します REDIS_ENABLED に設定されていると false.
- デフォルト:未設定
に設定します(
(Server Pro のみ)コンテナにマウントされ、git リポジトリを保存するために使用されるディレクトリへのパスを設定します。これはフルパス(で始まる)か、Toolkit のベースディレクトリからの相対パスのいずれかにできます。 redis コンテナにマウントされ、Redis データベースを保存するために使用されるディレクトリへのパスを設定します。これはフルパス(で始まる)か、Toolkit のベースディレクトリからの相対パスのいずれかにできます。このオプションはローカルのみに影響します /。このオプションはローカルの redis コンテナが作成されるときにのみ影響します REDIS_ENABLED に設定されていると true.
- デフォルト: data/redis
REDIS_AOF_PERSISTENCE
Redis の AOF(Append Only File)永続化をオンにします。これは Redis 永続化の 推奨 構成です。
詳細については、<../../maintenance/data-and-backups> の <../../../maintenance/data-and-backups#aof-append-only-file> セクションを参照してください。
- デフォルト: true
nginx
nginxNGINX_ENABLED
に設定すると true、Toolkit に TLS プロキシとして機能する NGINX コンテナを作成するよう指示します。
- デフォルト: false
NGINX_CONFIG_PATH
TLS プロキシで使用する NGINX 設定ファイルへのパス。
- デフォルト: config/nginx/nginx.conf
NGINX_TLS_LISTEN_IP
TLS プロキシコンテナが HTTPS 用にバインドするホストの IP アドレスを設定します。例えば、これがに設定されている場合、HTTPS の Web インターフェースは任意のホスト IP アドレスで利用可能になります。通常、これはホストの外部 IP に設定するべきです。
- 0.0.0.0 その場合、HTTPS の Web インターフェースは任意のホスト IP アドレスで利用可能になります。通常はホストの外部 IP に設定します。
- デフォルト: 127.0.1.1
NGINX_HTTP_LISTEN_IP
TLS プロキシコンテナが HTTP リダイレクト用にバインドするホストの IP アドレスを設定します。例えば、これがに設定されている場合、 127.0.1.1 への HTTP 接続は HTTPS の Web インターフェースにリダイレクトされます。通常はホストの外部 IP に設定するべきです。に設定しないでください。これをに設定すると、通常 と競合を引き起こします。 127.0.1.1 への HTTP 接続は HTTPS の Web インターフェースにリダイレクトされます。通常はホストの外部 IP に設定するべきです。に設定しないでください。これをに設定すると、通常 と競合を引き起こします。 0.0.0.0 と競合を引き起こしますので、に設定しないでください。 外部アクセスを許可するには、.
- デフォルト: 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