Personnalisation de la marque

Modifier le titre du site, le logo, les liens d’en-tête, les pieds de page et le message de maintenance sur un déploiement Kubernetes.

Le service web affiche le titre, le logo, les liens d’en-tête, les pieds de page et la page de maintenance à partir de variables d’environnement. Chaque paramètre et son format sont décrits dans Personnalisation de la marque ; sur Kubernetes, ils vont dans la ConfigMap.

Service	web, dans chaque pod Ayakaleaf Pro ; lu au démarrage de web
Réseau	aucun : les logos sont des URL chargées par le navigateur
Tâches périodiques	aucune (web vérifie le fichier de maintenance toutes les 5 secondes, voir ci-dessous)

​

Configuration

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

Mettez les valeurs JSON entre guillemets simples, comme ci-dessus, afin que YAML les conserve sous forme d’une seule chaîne. Un JSON invalide dans OVERLEAF_HEADER_EXTRAS ou dans les pieds de page est ignoré et seulement consigné au démarrage.

​

Mode maintenance

La page de maintenance s’affiche tant que le fichier /etc/overleaf/site_status du conteneur contient closed. Chaque pod possède sa propre copie de ce fichier, et un pod nouveau ou redémarré démarre en mode ouvert. Pour fermer le site, écrivez le fichier dans chaque 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

Écrivez open de la même manière pour y mettre fin. Les pods prennent en compte la modification en moins de 5 secondes.

L’option Close Editor du panneau d’administration fonctionne différemment : elle ferme l’éditeur uniquement sur le réplica qui a traité la requête de l’administrateur, et ce réplica le rouvre lorsqu’il redémarre. Avec plusieurs réplicas, utilisez plutôt le fichier comme ci-dessus.

​

Testé sur Kubernetes

Sur Kubernetes 1.37 : avec les paramètres ci-dessus dans la ConfigMap, les pages ont affiché OVERLEAF_NAV_TITLE, le pied de page gauche et, après connexion, le lien issu de OVERLEAF_HEADER_EXTRAS (les pages de connexion masquent les liens d’en-tête). L’écriture de closed dans /etc/overleaf/site_status d’un pod a affiché la page de maintenance avec OVERLEAF_MAINTENANCE_MESSAGE sur ce pod uniquement, et open y a mis fin en quelques secondes. Avec trois réplicas, l’option Close Editor du panneau d’administration n’a fermé l’éditeur que sur le réplica qui a servi l’administrateur, tandis que les deux autres sont restés ouverts.