Dostęp publiczny

Umożliwienie gościom, niezalogowanym odwiedzającym i nowym użytkownikom dostępu do wdrożenia Kubernetes.

Dostęp gości do udostępnionych projektów, strony publiczne i samodzielną rejestrację włącza się za pomocą zmiennych środowiskowych odczytywanych przez usługę web; usługa real-time obsługuje następnie gości poprzez ich sesję. Co otwiera każdy z przełączników, opisano w Dostęp publiczny.

Usługa	web (oraz real-time dla gości w edytorze), w każdym podzie Ayakaleaf Pro; odczytywane przy starcie web
Pod → na zewnątrz	serwer SMTP, gdy rejestracja wysyła e-maile aktywacyjne
Stan	tokeny dostępu gości w sesji, limity rejestracji w Redis
Zadania okresowe	brak

​

Konfiguracja

Dodaj potrzebne przełączniki do 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

Ujmij każdą wartość w cudzysłów. Wartości zaczynające się od @ muszą być w YAML ujęte w cudzysłów, w przeciwnym razie kubectl apply odrzuci plik.

Rejestracja ograniczona do domen wysyła e-mail aktywacyjny, więc Dostarczanie e-maili musi działać z podów: umieść hosta SMTP w ConfigMap, a OVERLEAF_EMAIL_SMTP_PASS w Secret.

​

Kilka replik

Nic dodatkowego. Dostęp gościa do projektu jest przechowywany w sesji w Redis, więc edytor działa na dowolnej replice wybranej przez load balancer.

​

Przetestowano na Kubernetes

Na Kubernetes 1.37 nasze testy end-to-end dla dostępu publicznego przechodzą pomyślnie: na jednej replice samodzielna rejestracja z OVERLEAF_ALLOW_PUBLIC_REGISTRATION ustawionym na true, na jedną domenę, na kilka domen z symbolem wieloznacznym dla subdomen oraz na @*, z e-mailem aktywacyjnym w trybach domenowych (43 przypadki); niezalogowani odwiedzający na /devs oraz wysłany fragment kodu zachowany po zalogowaniu przy OVERLEAF_ALLOW_PUBLIC_ACCESS (2 przypadki); niezalogowany gość w projekcie udostępnionym przez link przy obu włączonych przełącznikach (3 przypadki); a na trzech replikach za HAProxy OIDC razem z dostępem publicznym (1 przypadek).