Overleaf Import API

Ermöglichen Sie anderen Websites, LaTeX-Snippets und -Projekte in einem Kubernetes-Deployment zu öffnen.

Die Import API (/docs und die Schaltflächen “Open in Ayakaleaf”, das Modul open-in-overleaf) läuft im web-Dienst jedes Ayakaleaf Pro-Pods und ist standardmäßig aktiviert. Per URL angegebene Dateien werden über linked-url-proxy im selben Pod heruntergeladen. Wie sie aufgerufen wird, ist unter Overleaf Import API beschrieben.

Dienst	web (Modul open-in-overleaf); Downloads über linked-url-proxy
Außen → Overleaf	Browser senden GET oder POST ${OVERLEAF_SITE_URL}/docs von beliebigen Websites
Pod → außen	Downloads von snip_uri und zip_uri, eingeschränkt wie unter Externe URL beschrieben
Zustand	die Anfrage eines abgemeldeten Besuchers, 10 Minuten lang in Redis gehalten, bis er sich anmeldet
Periodische Jobs	keine

​

Konfiguration

Zum Aktivieren ist nichts erforderlich. Zugehörige Einstellungen in der ConfigMap:

Einstellung
OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"	Abgemeldete Besucher können /devs öffnen, und eine von ihnen gesendete Anfrage wird aufbewahrt, bis sie sich anmelden, siehe Öffentlicher Zugriff.
MAX_UPLOAD_SIZE	Größtes ZIP, das eine Anfrage enthalten darf, in MB (Standard 50). Ihr Ingress oder Load Balancer muss Anfragekörper dieser Größe ebenfalls akzeptieren.
OVERLEAF_LINKED_URL_*	Auf welche Adressen snip_uri und zip_uri verweisen dürfen, siehe Externe URL.

​

Mehrere Replikate

Nichts weiter. Die Anfrage eines abgemeldeten Besuchers wird in Redis gehalten und daher auf dem Replikat fortgesetzt, das der Besucher nach der Anmeldung erreicht.

​

Auf Kubernetes getestet

Auf Kubernetes 1.37 mit einem Replikat bestehen unsere End-to-End-Tests für die Import API (14 Fälle): die Seite /devs und ihr Beispielprojekt, Snippets, vollständige Dokumente, URL-codierte Links und Dateien aus Data-URLs, die in Projekte umgewandelt werden, Ablehnung von Einsendungen, die kein Projekt werden können, Ablehnung von Downloads von internen Adressen, über die Anmeldung hinweg aufbewahrte Posts und Links abgemeldeter Besucher sowie, mit OVERLEAF_ALLOW_PUBLIC_ACCESS, /devs für abgemeldete Besucher und ein gesendetes Snippet, das nach der Anmeldung einmalig fortgesetzt wird; der letzte Fall besteht auch mit drei Replikaten hinter HAProxy.