Overleaf Import API

Umožněte jiným webům otevírat úryvky LaTeXu a projekty v nasazení na Kubernetes.

Import API (/docs a tlačítka „Open in Ayakaleaf“, modul open-in-overleaf) běží ve službě web každého podu Ayakaleaf Pro a je ve výchozím nastavení zapnuté. Soubory zadané pomocí URL se stahují přes linked-url-proxy ve stejném podu. Jak jej volat, je popsáno v části Overleaf Import API.

Služba	web (modul open-in-overleaf); stahování přes linked-url-proxy
Venku → Overleaf	prohlížeče volají GET nebo POST ${OVERLEAF_SITE_URL}/docs z libovolného webu
Pod → venku	stahování snip_uri a zip_uri, omezené podle popisu v části Externí URL
Stav	požadavek nepřihlášeného návštěvníka, uchovaný v Redisu po dobu 10 minut, dokud se nepřihlásí
Periodické úlohy	žádné

​

Konfigurace

Pro zapnutí není potřeba nic. Související nastavení v ConfigMapu:

Nastavení
OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"	Nepřihlášení návštěvníci mohou otevřít /devs a požadavek, který odešlou, se uchová, dokud se nepřihlásí, viz Veřejný přístup.
MAX_UPLOAD_SIZE	Největší ZIP, který může požadavek obsahovat, v MB (výchozí 50). Váš ingress nebo load balancer musí také přijímat těla požadavků této velikosti.
OVERLEAF_LINKED_URL_*	Na které adresy mohou snip_uri a zip_uri odkazovat, viz Externí URL.

​

Více replik

Nic dalšího. Požadavek nepřihlášeného návštěvníka se uchovává v Redisu, takže se obnoví na kterékoli replice, na kterou se návštěvník po přihlášení dostane.

​

Testováno na Kubernetes

Na Kubernetes 1.37 s jednou replikou procházejí naše end-to-end testy Import API (14 případů): stránka /devs a její ukázkový projekt, úryvky, kompletní dokumenty, odkazy kódované v URL a soubory z data URL převedené na projekty, odmítnutí odeslání, z nichž nelze vytvořit projekt, odmítnutí stahování z interních adres, příspěvky a odkazy nepřihlášených uživatelů zachované přes přihlášení a s OVERLEAF_ALLOW_PUBLIC_ACCESS stránka /devs pro nepřihlášené návštěvníky a odeslaný úryvek obnovený jednou po přihlášení; poslední případ prochází také na třech replikách za HAProxy.