Branding

Ubah judul situs, logo, tautan header, footer, dan pesan pemeliharaan pada deployment Kubernetes.

Layanan web merender judul, logo, tautan header, footer, dan halaman pemeliharaan dari variabel lingkungan. Setiap pengaturan dan formatnya dijelaskan di Branding; di Kubernetes, pengaturan tersebut masuk ke ConfigMap.

Layanan	web, di setiap pod Ayakaleaf Pro; dibaca saat web dimulai
Jaringan	tidak ada: logo adalah URL yang dimuat oleh browser
Job berkala	tidak ada (web memeriksa file pemeliharaan setiap 5 detik, lihat di bawah)

​

Konfigurasi

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

Letakkan nilai JSON dalam tanda kutip tunggal, seperti di atas, agar YAML mempertahankannya sebagai satu string. JSON yang tidak valid di OVERLEAF_HEADER_EXTRAS atau di footer diabaikan dan hanya dicatat di log saat startup.

​

Mode pemeliharaan

Halaman pemeliharaan ditampilkan selama file /etc/overleaf/site_status di dalam kontainer berisi closed. Setiap pod memiliki salinan file ini sendiri, dan pod baru atau yang di-restart dimulai dalam keadaan terbuka. Untuk menutup situs, tulis file tersebut di setiap 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

Tulis open dengan cara yang sama untuk mengakhirinya. Pod menerapkan perubahan dalam 5 detik.

Close Editor di panel admin bekerja secara berbeda: fitur ini menutup editor hanya di replika yang melayani permintaan admin, dan replika tersebut membukanya kembali saat di-restart. Dengan beberapa replika, gunakan file seperti di atas sebagai gantinya.

​

Diuji di Kubernetes

Di Kubernetes 1.37: dengan pengaturan di atas di ConfigMap, halaman menampilkan OVERLEAF_NAV_TITLE, footer kiri, dan, setelah login, tautan dari OVERLEAF_HEADER_EXTRAS (halaman login menyembunyikan tautan header). Menulis closed ke /etc/overleaf/site_status di satu pod menampilkan halaman pemeliharaan dengan OVERLEAF_MAINTENANCE_MESSAGE hanya di pod tersebut, dan open mengakhirinya dalam hitungan detik. Dengan tiga replika, Close Editor di panel admin menutup editor hanya di replika yang melayani admin, sementara dua lainnya tetap terbuka.