Брендування

Змініть назву сайту, логотип, посилання в заголовку, нижні колонтитули та повідомлення про технічне обслуговування в розгортанні Kubernetes.

Служба web відображає назву, логотип, посилання в заголовку, нижні колонтитули та сторінку технічного обслуговування на основі змінних середовища. Кожен параметр і його формат описано в розділі Брендування; у Kubernetes вони потрапляють у ConfigMap.

Служба	web, у кожному поді Ayakaleaf Pro; зчитується під час запуску 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

Беріть значення JSON в одинарні лапки, як показано вище, щоб YAML зберігав їх як один рядок. Недійсний JSON в OVERLEAF_HEADER_EXTRAS або в нижніх колонтитулах ігнорується й лише записується в журнал під час запуску.

​

Режим технічного обслуговування

Сторінка технічного обслуговування відображається, доки файл /etc/overleaf/site_status у контейнері містить closed. Кожен под має власну копію цього файлу, а новий або перезапущений под запускається відкритим. Щоб закрити сайт, запишіть файл у кожному поді:

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. Поди підхоплюють зміну протягом 5 секунд.

Close Editor в панелі адміністратора працює інакше: він закриває редактор лише в тій репліці, яка обслуговувала запит адміністратора, і ця репліка знову відкриває його після перезапуску. За кількох реплік натомість використовуйте файл, як описано вище.

​

Перевірено в Kubernetes

У Kubernetes 1.37: із наведеними вище налаштуваннями в ConfigMap сторінки показували OVERLEAF_NAV_TITLE, лівий нижній колонтитул і, після входу, посилання з OVERLEAF_HEADER_EXTRAS (сторінки входу приховують посилання в заголовку). Запис closed у /etc/overleaf/site_status одного пода показував сторінку технічного обслуговування з OVERLEAF_MAINTENANCE_MESSAGE лише на цьому поді, а open завершував режим за кілька секунд. З трьома репліками Close Editor у панелі адміністратора закривав редактор лише на репліці, яка обслуговувала адміністратора, тоді як дві інші залишалися відкритими.