브랜딩

Kubernetes 배포에서 사이트 제목, 로고, 헤더 링크, 푸터 및 유지 관리 메시지를 변경합니다.

web 서비스는 환경 변수를 바탕으로 제목, 로고, 헤더 링크, 푸터 및 유지 관리 페이지를 렌더링합니다. 모든 설정과 그 형식은 브랜딩에 설명되어 있으며, Kubernetes에서는 이를 ConfigMap에 넣습니다.

서비스	web, 모든 Ayakaleaf Pro 파드에서 실행. web이 시작될 때 읽음
네트워크	없음: 로고는 브라우저가 불러오는 URL임
주기적 작업	없음(web은 5초마다 유지 관리 파일을 확인함, 아래 참고)

​

구성

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

위와 같이 JSON 값은 작은따옴표로 감싸서 YAML이 하나의 문자열로 유지하도록 하세요. OVERLEAF_HEADER_EXTRAS나 푸터의 잘못된 JSON은 무시되며 시작 시 로그에만 기록됩니다.

​

유지 관리 모드

유지 관리 페이지는 컨테이너의 /etc/overleaf/site_status 파일에 closed가 들어 있는 동안 표시됩니다. 각 파드는 이 파일의 자체 사본을 가지며, 새로 만들어지거나 재시작된 파드는 열린 상태로 시작합니다. 사이트를 닫으려면 모든 파드에서 파일을 작성하세요.

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

종료하려면 같은 방법으로 open을 작성하세요. 파드는 5초 이내에 변경 사항을 반영합니다.

관리자 패널의 Close Editor는 다르게 동작합니다. 관리자의 요청을 처리한 레플리카에서만 에디터를 닫으며, 해당 레플리카가 재시작되면 다시 열립니다. 레플리카가 여러 개인 경우 대신 위와 같이 파일을 사용하세요.

​

Kubernetes에서의 테스트

Kubernetes 1.37 환경에서 위 설정을 ConfigMap에 넣었을 때, 페이지에 OVERLEAF_NAV_TITLE과 왼쪽 푸터가 표시되었고, 로그인한 후에는 OVERLEAF_HEADER_EXTRAS의 링크가 표시되었습니다(로그인 페이지에서는 헤더 링크가 숨겨집니다). 한 파드의 /etc/overleaf/site_status에 closed를 작성하자 해당 파드에서만 OVERLEAF_MAINTENANCE_MESSAGE가 포함된 유지 관리 페이지가 표시되었고, open을 작성하자 몇 초 내에 종료되었습니다. 레플리카가 세 개인 경우, 관리자 패널의 Close Editor는 관리자를 처리한 레플리카에서만 에디터를 닫았고 나머지 두 레플리카는 열린 상태로 유지되었습니다.