ブランディング

Kubernetes デプロイで、サイトタイトル、ロゴ、ヘッダーリンク、フッター、メンテナンスメッセージを変更します。

web サービスは、タイトル、ロゴ、ヘッダーリンク、フッター、メンテナンスページを環境変数に基づいて表示します。各設定とその形式は ブランディング で説明しています。Kubernetes では、これらを ConfigMap に設定します。

サービス	web、すべての Ayakaleaf Pro Pod 内。web の起動時に読み込まれます
ネットワーク	なし：ロゴはブラウザが読み込む URL です
定期ジョブ	なし（web は 5 秒ごとにメンテナンスファイルを確認します。下記を参照）

​

設定

30-config.yaml (additions)

  OVERLEAF_NAV_TITLE: Our Overleaf Instance
  OVERLEAF_HEADER_IMAGE_URL: https://example.com/img/logo.png
  OVERLEAF_HEADER_EXTRAS: '[{"text":"Help","url":"https://example.com/help","class":"subdued"}]'
  OVERLEAF_LEFT_FOOTER: '[{"text":"Run by the IT department"}]'
  OVERLEAF_RIGHT_FOOTER: '[{"text":"Imprint","url":"https://example.com/imprint"}]'
  OVERLEAF_MAINTENANCE_MESSAGE: Our Overleaf Instance is down for maintenance and will be back shortly.

kubectl apply -f 30-config.yaml
kubectl -n overleaf rollout restart deployment/overleaf     # or statefulset/overleaf

YAML が 1 つの文字列として扱うように、JSON 値は上記のようにシングルクォートで囲んでください。OVERLEAF_HEADER_EXTRAS やフッターの JSON が無効な場合は無視され、起動時にログに記録されるだけです。

​

メンテナンスモード

コンテナ内のファイル /etc/overleaf/site_status に closed が含まれている間、メンテナンスページが表示されます。このファイルは Pod ごとに個別に存在し、新しい Pod や再起動した Pod は開いた状態で起動します。サイトを閉じるには、すべての Pod でファイルを書き込みます。

for p in $(kubectl -n overleaf get pod -l app=overleaf -o name); do   # app=overleaf-ha for several replicas
  kubectl -n overleaf exec "$p" -- sh -c 'echo closed > /etc/overleaf/site_status'
done

終了するには、同じ方法で open を書き込みます。Pod は 5 秒以内に変更を反映します。

管理パネルの Close Editor は動作が異なります。管理者のリクエストを処理したレプリカでのみエディターを閉じ、そのレプリカは再起動時に再びエディターを開きます。複数のレプリカがある場合は、代わりに上記のファイルを使用してください。

​

Kubernetes でのテスト結果

Kubernetes 1.37 上で、上記の設定を ConfigMap に入れたところ、ページには OVERLEAF_NAV_TITLE、左フッター、そしてログイン後には OVERLEAF_HEADER_EXTRAS のリンクが表示されました（ログインページではヘッダーリンクは非表示になります）。1 つの Pod の /etc/overleaf/site_status に closed を書き込むと、その Pod でのみ OVERLEAF_MAINTENANCE_MESSAGE を含むメンテナンスページが表示され、open を書き込むと数秒以内に終了しました。3 つのレプリカでは、管理パネルの Close Editor は管理者のリクエストを処理したレプリカでのみエディターを閉じ、他の 2 つは開いたままでした。