Thương hiệu

Thay đổi tiêu đề trang, logo, liên kết trên thanh tiêu đề, chân trang và thông báo bảo trì trên triển khai Kubernetes.

Dịch vụ web hiển thị tiêu đề, logo, liên kết trên thanh tiêu đề, chân trang và trang bảo trì từ các biến môi trường. Mọi thiết lập và định dạng của chúng được mô tả trong Thương hiệu; trên Kubernetes, chúng được đặt trong ConfigMap.

Dịch vụ	web, trong mọi pod Ayakaleaf Pro; được đọc khi web khởi động
Mạng	không có: logo là các URL mà trình duyệt tải
Tác vụ định kỳ	không có (web kiểm tra tệp bảo trì mỗi 5 giây, xem bên dưới)

​

Cấu hình

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

Hãy đặt các giá trị JSON trong dấu nháy đơn, như trên, để YAML giữ chúng thành một chuỗi duy nhất. JSON không hợp lệ trong OVERLEAF_HEADER_EXTRAS hoặc các chân trang sẽ bị bỏ qua và chỉ được ghi log khi khởi động.

​

Chế độ bảo trì

Trang bảo trì được hiển thị khi tệp /etc/overleaf/site_status trong container chứa closed. Mỗi pod có bản sao riêng của tệp này, và một pod mới hoặc vừa khởi động lại sẽ bắt đầu ở trạng thái mở. Để đóng trang, hãy ghi tệp này trong mọi 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

Ghi open theo cách tương tự để kết thúc. Các pod nhận thay đổi trong vòng 5 giây.

Close Editor trong bảng quản trị hoạt động khác: nó chỉ đóng trình soạn thảo trên replica đã phục vụ yêu cầu của quản trị viên, và replica đó sẽ mở lại trình soạn thảo khi khởi động lại. Khi có nhiều replica, hãy dùng tệp như trên.

​

Đã kiểm thử trên Kubernetes

Trên Kubernetes 1.37: với các thiết lập trên trong ConfigMap, các trang hiển thị OVERLEAF_NAV_TITLE, chân trang bên trái và, sau khi đăng nhập, liên kết từ OVERLEAF_HEADER_EXTRAS (các trang đăng nhập ẩn liên kết trên thanh tiêu đề). Ghi closed vào /etc/overleaf/site_status của một pod đã hiển thị trang bảo trì với OVERLEAF_MAINTENANCE_MESSAGE chỉ trên pod đó, và open đã kết thúc nó trong vài giây. Với ba replica, Close Editor trong bảng quản trị chỉ đóng trình soạn thảo trên replica đã phục vụ quản trị viên, trong khi hai replica còn lại vẫn mở.