Varumärkesanpassning

Ändra webbplatsens titel, logotyp, länkar i sidhuvudet, sidfötter och underhållsmeddelande i en Kubernetes-driftsättning.

Tjänsten web återger titeln, logotypen, länkarna i sidhuvudet, sidfötterna och underhållssidan utifrån miljövariabler. Varje inställning och dess format beskrivs i Varumärkesanpassning; på Kubernetes läggs de i ConfigMap.

Tjänst	web, i varje Ayakaleaf Pro-pod; läses när web startar
Nätverk	inget: logotyper är URL:er som webbläsaren laddar
Periodiska jobb	inga (web kontrollerar underhållsfilen var 5:e sekund, se nedan)

​

Konfiguration

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

Sätt JSON-värden inom enkla citattecken, som ovan, så att YAML behåller dem som en enda sträng. Ogiltig JSON i OVERLEAF_HEADER_EXTRAS eller i sidfötterna ignoreras och loggas bara vid start.

​

Underhållsläge

Underhållssidan visas medan filen /etc/overleaf/site_status i containern innehåller closed. Varje pod har sin egen kopia av filen, och en ny eller omstartad pod startar som öppen. För att stänga webbplatsen skriver du filen i varje 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

Skriv open på samma sätt för att avsluta det. Poddarna uppfattar ändringen inom 5 sekunder.

Administratörspanelens Close Editor fungerar annorlunda: den stänger redigeraren bara i den replik som hanterade administratörens förfrågan, och den repliken öppnar den igen när den startas om. Med flera repliker använder du i stället filen enligt ovan.

​

Testat på Kubernetes

På Kubernetes 1.37: med inställningarna ovan i ConfigMap visade sidorna OVERLEAF_NAV_TITLE, den vänstra sidfoten och, efter inloggning, länken från OVERLEAF_HEADER_EXTRAS (inloggningssidorna döljer länkarna i sidhuvudet). När closed skrevs till /etc/overleaf/site_status i en pod visades underhållssidan med OVERLEAF_MAINTENANCE_MESSAGE endast på den podden, och open avslutade det inom några sekunder. Med tre repliker stängde administratörspanelens Close Editor redigeraren bara på den replik som hanterade administratören, medan de andra två förblev öppna.