API d'import Overleaf

Permettez à d’autres sites web d’ouvrir des extraits et des projets LaTeX dans un déploiement Kubernetes.

L’API d’import (/docs et les boutons « Open in Ayakaleaf », le module open-in-overleaf) s’exécute dans le service web de chaque pod Ayakaleaf Pro et est activée par défaut. Les fichiers fournis par URL sont téléchargés via linked-url-proxy dans le même pod. Son utilisation est décrite dans API d’import Overleaf.

Service	web (module open-in-overleaf) ; téléchargements via linked-url-proxy
Extérieur → Overleaf	les navigateurs envoient GET ou POST ${OVERLEAF_SITE_URL}/docs depuis n’importe quel site web
Pod → extérieur	téléchargements snip_uri et zip_uri, limités comme décrit dans URL externe
État	la requête d’un visiteur non connecté, conservée dans Redis pendant 10 minutes jusqu’à ce qu’il se connecte
Tâches périodiques	aucune

​

Configuration

Rien n’est nécessaire pour l’activer. Paramètres associés dans le ConfigMap :

Paramètre
OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"	Les visiteurs non connectés peuvent ouvrir /devs, et une requête qu’ils envoient est conservée jusqu’à ce qu’ils se connectent, voir Accès public.
MAX_UPLOAD_SIZE	Taille maximale d’un ZIP qu’une requête peut transporter, en Mo (par défaut 50). Votre ingress ou votre équilibreur de charge doit également accepter des corps de requête de cette taille.
OVERLEAF_LINKED_URL_*	Les adresses vers lesquelles snip_uri et zip_uri peuvent pointer, voir URL externe.

​

Plusieurs répliques

Rien de plus. La requête d’un visiteur non connecté est conservée dans Redis ; elle reprend donc sur la réplique que le visiteur atteint après s’être connecté, quelle qu’elle soit.

​

Testé sur Kubernetes

Sur Kubernetes 1.37 avec une réplique, nos tests de bout en bout de l’API d’import réussissent (14 cas) : la page /devs et son projet d’exemple, extraits, documents complets, liens encodés en URL et fichiers issus d’URL de données transformés en projets, soumissions ne pouvant pas devenir un projet refusées, téléchargements depuis des adresses internes refusés, envois et liens de visiteurs non connectés conservés pendant la connexion, et, avec OVERLEAF_ALLOW_PUBLIC_ACCESS, /devs pour les visiteurs non connectés et un extrait envoyé repris une seule fois après la connexion ; ce dernier cas réussit également sur trois répliques derrière HAProxy.