Публичный доступ

Доступ гостей, посетителей без входа и новых пользователей к развёртыванию на Kubernetes.

Гостевой доступ к общим проектам, публичные страницы и самостоятельная регистрация включаются переменными окружения, которые считывает сервис web; затем сервис real-time обслуживает гостей через их сессию. Что именно открывает каждый переключатель, описано в разделе Публичный доступ.

Сервис	web (и real-time для гостей в редакторе) в каждом поде Ayakaleaf Pro; считывается при запуске web
Под → внешняя сеть	сервер SMTP, когда при регистрации отправляются письма активации
Состояние	гостевые токены доступа в сессии, ограничения частоты регистраций в Redis
Периодические задания	нет

​

Настройка

Добавьте нужные переключатели в ConfigMap overleaf-env:

30-config.yaml (additions)

  # Guests open link-shared projects without an account
  OVERLEAF_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING: "true"
  # Signed-out visitors may open /learn, /templates, /devs and view links
  OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"
  # Self-registration: "true", or only some domains
  OVERLEAF_ALLOW_PUBLIC_REGISTRATION: "@example.com, @*.uni.example"

kubectl apply -f 30-config.yaml
kubectl -n overleaf rollout restart deployment/overleaf     # or statefulset/overleaf

Заключайте каждое значение в кавычки. Значения, начинающиеся с @, в YAML обязательно должны быть в кавычках, иначе kubectl apply отклонит файл.

При регистрации, ограниченной доменами, отправляется письмо активации, поэтому доставка электронной почты должна работать из подов: укажите хост SMTP в ConfigMap, а OVERLEAF_EMAIL_SMTP_PASS — в Secret.

​

Несколько реплик

Ничего дополнительного не требуется. Доступ гостя к проекту хранится в сессии в Redis, поэтому редактор работает на любой реплике, которую выберет балансировщик нагрузки.

​

Проверено на Kubernetes

На Kubernetes 1.37 наши сквозные тесты публичного доступа проходят: на одной реплике — самостоятельная регистрация с OVERLEAF_ALLOW_PUBLIC_REGISTRATION, установленным в true, в один домен, в несколько доменов с подстановочным знаком для поддоменов и в @*, с письмом активации для режимов с доменами (43 сценария); посетители без входа на /devs и отправленный фрагмент кода, сохраняющийся после входа, с OVERLEAF_ALLOW_PUBLIC_ACCESS (2 сценария); гость без входа в проекте, к которому открыт доступ по ссылке, с обоими включёнными переключателями (3 сценария); а также на трёх репликах за HAProxy — OIDC вместе с публичным доступом (1 сценарий).