Identidade visual

Altere o título do site, o logotipo, os links do cabeçalho, os rodapés e a mensagem de manutenção em uma implantação Kubernetes.

O serviço web renderiza o título, o logotipo, os links do cabeçalho, os rodapés e a página de manutenção a partir de variáveis de ambiente. Cada configuração e seu formato estão descritos em Identidade visual; no Kubernetes, elas vão para o ConfigMap.

Serviço	web, em cada pod do Ayakaleaf Pro; lido quando o web inicia
Rede	nenhuma: os logotipos são URLs que o navegador carrega
Tarefas periódicas	nenhuma (o web verifica o arquivo de manutenção a cada 5 segundos; veja abaixo)

​

Configuração

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

Coloque os valores JSON entre aspas simples, como acima, para que o YAML os mantenha como uma única string. JSON inválido em OVERLEAF_HEADER_EXTRAS ou nos rodapés é ignorado e apenas registrado no log na inicialização.

​

Modo de manutenção

A página de manutenção é exibida enquanto o arquivo /etc/overleaf/site_status no contêiner contém closed. Cada pod tem sua própria cópia desse arquivo, e um pod novo ou reiniciado começa aberto. Para fechar o site, escreva o arquivo em 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

Escreva open da mesma forma para encerrá-lo. Os pods detectam a alteração em até 5 segundos.

O Close Editor do painel de administração funciona de outra forma: ele fecha o editor apenas na réplica que atendeu a requisição do administrador, e essa réplica o abre novamente quando reinicia. Com várias réplicas, use o arquivo como acima.

​

Testado no Kubernetes

No Kubernetes 1.37: com as configurações acima no ConfigMap, as páginas exibiram OVERLEAF_NAV_TITLE, o rodapé esquerdo e, após o login, o link de OVERLEAF_HEADER_EXTRAS (as páginas de login ocultam os links do cabeçalho). Escrever closed em /etc/overleaf/site_status de um pod exibiu a página de manutenção com OVERLEAF_MAINTENANCE_MESSAGE apenas nesse pod, e open a encerrou em segundos. Com três réplicas, o Close Editor do painel de administração fechou o editor apenas na réplica que atendeu o administrador, enquanto as outras duas permaneceram abertas.