Overleaf Import API

Anna muiden verkkosivustojen avata LaTeX-katkelmia ja -projekteja Kubernetes-käyttöönotossa.

Import API (/docs ja ”Open in Ayakaleaf” -painikkeet, open-in-overleaf-moduuli) toimii jokaisen Ayakaleaf Pro -podin web-palvelussa ja on oletuksena käytössä. URL-osoitteella annetut tiedostot ladataan saman podin linked-url-proxyn kautta. Sen kutsuminen on kuvattu sivulla Overleaf Import API.

Palvelu	web (open-in-overleaf-moduuli); lataukset linked-url-proxyn kautta
Ulkopuoli → Overleaf	selaimet lähettävät GET- tai POST ${OVERLEAF_SITE_URL}/docs -pyynnön miltä tahansa verkkosivustolta
Pod → ulkopuoli	snip_uri- ja zip_uri-lataukset, rajoitettuina sivulla Ulkoinen URL-osoite kuvatulla tavalla
Tila	uloskirjautuneen vierailijan pyyntö, joka säilytetään Redisissä 10 minuuttia, kunnes hän kirjautuu sisään
Ajastetut tehtävät	ei mitään

​

Konfigurointi

Käyttöönotto ei vaadi mitään. Aiheeseen liittyvät ConfigMap-asetukset:

Asetus
OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"	Uloskirjautuneet vierailijat voivat avata sivun /devs, ja heidän lähettämänsä pyyntö säilytetään, kunnes he kirjautuvat sisään, katso Julkinen käyttö.
MAX_UPLOAD_SIZE	Suurin ZIP-tiedosto, jonka pyyntö voi sisältää, megatavuina (oletus 50). Myös ingressin tai kuormantasaajan on hyväksyttävä tämän kokoiset pyyntörungot.
OVERLEAF_LINKED_URL_*	Mihin osoitteisiin snip_uri ja zip_uri voivat osoittaa, katso Ulkoinen URL-osoite.

​

Useita replikoita

Mitään ylimääräistä ei tarvita. Uloskirjautuneen vierailijan pyyntö säilytetään Redisissä, joten se jatkuu sillä replikalla, jolle vierailija päätyy sisäänkirjautumisen jälkeen.

​

Testattu Kubernetesissa

Kubernetes 1.37:ssä yhdellä replikalla Import API:n päästä päähän -testimme menevät läpi (14 tapausta): /devs-sivu ja sen esimerkkiprojekti, katkelmat, kokonaiset dokumentit, URL-koodatut linkit ja data-URL-osoitteista tulevat tiedostot muutettuina projekteiksi, projektiksi kelpaamattomien lähetysten hylkääminen, sisäisistä osoitteista tulevien latausten hylkääminen, uloskirjautuneena lähetettyjen viestien ja linkkien säilyminen kirjautumisen yli sekä OVERLEAF_ALLOW_PUBLIC_ACCESS-asetuksella /devs uloskirjautuneille vierailijoille ja lähetetyn katkelman jatkaminen kerran sisäänkirjautumisen jälkeen; viimeinen tapaus menee läpi myös kolmella replikalla HAProxyn takana.