Öffentlicher Zugriff

Gästen, nicht angemeldeten Besuchern und neuen Benutzern den Zugriff auf ein Kubernetes-Deployment ermöglichen.

Gastzugriff auf geteilte Projekte, öffentliche Seiten und Selbstregistrierung werden mit Umgebungsvariablen aktiviert, die der web-Dienst liest; der Echtzeitdienst bedient Gäste dann über deren Sitzung. Was jeder Schalter freigibt, ist unter Öffentlicher Zugriff beschrieben.

Dienst	web (und real-time für Gäste im Editor), in jedem Ayakaleaf-Pro-Pod; beim Start von web gelesen
Pod → außen	der SMTP-Server, wenn die Registrierung Aktivierungs-E-Mails sendet
Zustand	Gast-Zugriffstokens in der Sitzung, Ratenbegrenzungen für die Registrierung in Redis
Periodische Jobs	keine

​

Konfiguration

Fügen Sie die benötigten Schalter zur ConfigMap overleaf-env hinzu:

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

Setzen Sie jeden Wert in Anführungszeichen. Werte, die mit @ beginnen, müssen in YAML in Anführungszeichen stehen, andernfalls lehnt kubectl apply die Datei ab.

Eine auf Domains beschränkte Registrierung sendet eine Aktivierungs-E-Mail, daher muss die E-Mail-Zustellung aus den Pods heraus funktionieren: Tragen Sie den SMTP-Host in die ConfigMap und OVERLEAF_EMAIL_SMTP_PASS in das Secret ein.

​

Mehrere Replikate

Nichts weiter. Der Zugriff eines Gastes auf ein Projekt wird in der Sitzung in Redis gespeichert, sodass der Editor auf dem Replikat funktioniert, das der Load Balancer auswählt.

​

Getestet auf Kubernetes

Auf Kubernetes 1.37 bestehen unsere End-to-End-Tests für den öffentlichen Zugriff: auf einem Replikat die Selbstregistrierung mit OVERLEAF_ALLOW_PUBLIC_REGISTRATION gesetzt auf true, auf eine Domain, auf mehrere Domains mit einem Subdomain-Platzhalter und auf @*, mit der Aktivierungs-E-Mail für die Domain-Modi (43 Fälle); nicht angemeldete Besucher auf /devs und ein gesendetes Snippet, das über die Anmeldung hinweg erhalten bleibt, mit OVERLEAF_ALLOW_PUBLIC_ACCESS (2 Fälle); ein nicht angemeldeter Gast in einem per Link geteilten Projekt mit beiden aktivierten Schaltern (3 Fälle); und auf drei Replikaten hinter HAProxy OIDC zusammen mit öffentlichem Zugriff (1 Fall).