Overleaf Import API

Laat andere websites LaTeX-fragmenten en projecten openen in een Kubernetes-deployment.

De Import API (/docs en de knoppen “Open in Ayakaleaf”, de module open-in-overleaf) draait in de web-service van elke Ayakaleaf Pro-pod en staat standaard aan. Bestanden die via een URL worden opgegeven, worden gedownload via linked-url-proxy in dezelfde pod. Hoe je de API aanroept, staat beschreven in Overleaf Import API.

Service	web (module open-in-overleaf); downloads via linked-url-proxy
Buiten → Overleaf	browsers GET of POST ${OVERLEAF_SITE_URL}/docs vanaf elke website
Pod → buiten	downloads van snip_uri en zip_uri, beperkt zoals beschreven in Externe URL
Status	het verzoek van een niet-ingelogde bezoeker, 10 minuten bewaard in Redis totdat die inlogt
Periodieke taken	geen

​

Configuratie

Er is niets nodig om het in te schakelen. Gerelateerde instellingen in de ConfigMap:

Instelling
OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"	Niet-ingelogde bezoekers kunnen /devs openen, en een verzoek dat ze sturen wordt bewaard totdat ze inloggen, zie Openbare toegang.
MAX_UPLOAD_SIZE	Grootste ZIP die een verzoek mag bevatten, in MB (standaard 50). Je ingress of load balancer moet ook request bodies van die grootte accepteren.
OVERLEAF_LINKED_URL_*	Naar welke adressen snip_uri en zip_uri mogen verwijzen, zie Externe URL.

​

Meerdere replica’s

Niets extra’s. Het verzoek van een niet-ingelogde bezoeker wordt bewaard in Redis, dus het wordt hervat op welke replica de bezoeker ook bereikt na het inloggen.

​

Getest op Kubernetes

Op Kubernetes 1.37 met één replica slagen onze end-to-endtests voor de Import API (14 gevallen): de pagina /devs en het voorbeeldproject ervan, fragmenten, volledige documenten, URL-gecodeerde links en bestanden uit data-URL’s die worden omgezet in projecten, inzendingen die geen project kunnen worden geweigerd, downloads van interne adressen geweigerd, posts en links van niet-ingelogde bezoekers bewaard tijdens het inloggen, en, met OVERLEAF_ALLOW_PUBLIC_ACCESS, /devs voor niet-ingelogde bezoekers en een gepost fragment dat na het inloggen één keer wordt hervat; het laatste geval slaagt ook op drie replica’s achter HAProxy.