Overleaf Import API

Consenti ad altri siti web di aprire snippet e progetti LaTeX in un deployment Kubernetes.

La Import API (/docs e i pulsanti “Open in Ayakaleaf”, il modulo open-in-overleaf) viene eseguita nel servizio web di ogni pod di Ayakaleaf Pro ed è attiva per impostazione predefinita. I file indicati tramite URL vengono scaricati tramite linked-url-proxy nello stesso pod. Come richiamarla è descritto in Overleaf Import API.

Servizio	web (modulo open-in-overleaf); download tramite linked-url-proxy
Esterno → Overleaf	i browser eseguono GET o POST ${OVERLEAF_SITE_URL}/docs da qualsiasi sito web
Pod → esterno	download di snip_uri e zip_uri, limitati come descritto in URL esterno
Stato	la richiesta di un visitatore non autenticato, conservata in Redis per 10 minuti finché non effettua l’accesso
Job periodici	nessuno

​

Configurazione

Non serve nulla per attivarla. Impostazioni correlate nella ConfigMap:

Impostazione
OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"	I visitatori non autenticati possono aprire /devs, e una richiesta che inviano viene conservata finché non effettuano l’accesso, vedi Accesso pubblico.
MAX_UPLOAD_SIZE	Dimensione massima dello ZIP che una richiesta può contenere, in MB (predefinito 50). Anche il tuo ingress o load balancer deve accettare corpi di richiesta di tale dimensione.
OVERLEAF_LINKED_URL_*	A quali indirizzi possono puntare snip_uri e zip_uri, vedi URL esterno.

​

Più repliche

Nulla di aggiuntivo. La richiesta di un visitatore non autenticato è conservata in Redis, quindi viene ripresa su qualunque replica il visitatore raggiunga dopo aver effettuato l’accesso.

​

Testato su Kubernetes

Su Kubernetes 1.37 con una replica, i nostri test end-to-end per la Import API vengono superati (14 casi): la pagina /devs e il suo progetto di esempio, snippet, documenti completi, link codificati come URL e file da data URL trasformati in progetti, invii che non possono diventare un progetto rifiutati, download da indirizzi interni rifiutati, invii e link di utenti non autenticati conservati attraverso il login e, con OVERLEAF_ALLOW_PUBLIC_ACCESS, /devs per i visitatori non autenticati e uno snippet inviato ripreso una volta dopo l’accesso; l’ultimo caso viene superato anche su tre repliche dietro HAProxy.