Branding

Změna názvu webu, loga, odkazů v záhlaví, patiček a zprávy o údržbě v nasazení na Kubernetes.

Služba web vykresluje název, logo, odkazy v záhlaví, patičky a stránku údržby podle proměnných prostředí. Všechna nastavení a jejich formát popisuje stránka Branding; na Kubernetes patří do ConfigMapy.

Služba	web, v každém podu Ayakaleaf Pro; načítá se při spuštění služby web
Síť	žádná: loga jsou URL, které načítá prohlížeč
Periodické úlohy	žádné (web kontroluje soubor údržby každých 5 sekund, viz níže)

​

Konfigurace

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

Hodnoty JSON dejte do jednoduchých uvozovek, jako výše, aby je YAML zachoval jako jeden řetězec. Neplatný JSON v OVERLEAF_HEADER_EXTRAS nebo v patičkách se ignoruje a pouze se zaznamená do logu při spuštění.

​

Režim údržby

Stránka údržby se zobrazuje, dokud soubor /etc/overleaf/site_status v kontejneru obsahuje closed. Každý pod má vlastní kopii tohoto souboru a nový nebo restartovaný pod startuje otevřený. Chcete-li web uzavřít, zapište soubor v každém podu:

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

Údržbu ukončíte stejným způsobem zapsáním open. Pody změnu převezmou do 5 sekund.

Tlačítko Close Editor v administračním panelu funguje jinak: uzavře editor pouze v replice, která obsloužila požadavek administrátora, a tato replika ho po restartu znovu otevře. Při více replikách místo toho použijte soubor, jak je uvedeno výše.

​

Otestováno na Kubernetes

Na Kubernetes 1.37: s výše uvedeným nastavením v ConfigMapě stránky zobrazovaly OVERLEAF_NAV_TITLE, levou patičku a po přihlášení odkaz z OVERLEAF_HEADER_EXTRAS (přihlašovací stránky odkazy v záhlaví skrývají). Zapsání closed do /etc/overleaf/site_status jednoho podu zobrazilo stránku údržby s OVERLEAF_MAINTENANCE_MESSAGE pouze na tomto podu a open ji během několika sekund ukončilo. Se třemi replikami uzavřelo Close Editor v administračním panelu editor pouze na replice, která obsloužila administrátora, zatímco zbylé dvě zůstaly otevřené.