Personalización de marca

Cambia el título del sitio, el logotipo, los enlaces de la cabecera, los pies de página y el mensaje de mantenimiento en un despliegue de Kubernetes.

El servicio web genera el título, el logotipo, los enlaces de la cabecera, los pies de página y la página de mantenimiento a partir de variables de entorno. Cada ajuste y su formato se describen en Personalización de marca; en Kubernetes van en el ConfigMap.

Servicio	web, en cada pod de Ayakaleaf Pro; se lee cuando web arranca
Red	ninguna: los logotipos son URL que carga el navegador
Tareas periódicas	ninguna (web comprueba el archivo de mantenimiento cada 5 segundos; consulta más abajo)

​

Configuración

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

Pon los valores JSON entre comillas simples, como arriba, para que YAML los mantenga como una sola cadena. El JSON no válido en OVERLEAF_HEADER_EXTRAS o en los pies de página se ignora y solo se registra al arrancar.

​

Modo de mantenimiento

La página de mantenimiento se muestra mientras el archivo /etc/overleaf/site_status del contenedor contenga closed. Cada pod tiene su propia copia de este archivo, y un pod nuevo o reiniciado arranca abierto. Para cerrar el sitio, escribe el archivo en cada 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

Escribe open de la misma forma para terminarlo. Los pods detectan el cambio en un plazo de 5 segundos.

La opción Close Editor del panel de administración funciona de otra manera: cierra el editor solo en la réplica que atendió la petición del administrador, y esa réplica lo vuelve a abrir cuando se reinicia. Con varias réplicas, usa en su lugar el archivo como se indica arriba.

​

Probado en Kubernetes

En Kubernetes 1.37: con los ajustes anteriores en el ConfigMap, las páginas mostraron OVERLEAF_NAV_TITLE, el pie de página izquierdo y, tras iniciar sesión, el enlace de OVERLEAF_HEADER_EXTRAS (las páginas de inicio de sesión ocultan los enlaces de la cabecera). Escribir closed en /etc/overleaf/site_status de un pod mostró la página de mantenimiento con OVERLEAF_MAINTENANCE_MESSAGE solo en ese pod, y open la terminó en cuestión de segundos. Con tres réplicas, la opción Close Editor del panel de administración cerró el editor solo en la réplica que atendió al administrador, mientras que las otras dos siguieron abiertas.