Overleaf Import API

Pozwól innym stronom internetowym otwierać fragmenty kodu LaTeX i projekty we wdrożeniu Kubernetes.

Import API (/docs i przyciski „Open in Ayakaleaf”, moduł open-in-overleaf) działa w usłudze web każdego poda Ayakaleaf Pro i jest domyślnie włączone. Pliki podane przez URL są pobierane przez linked-url-proxy w tym samym podzie. Sposób wywoływania opisano na stronie Overleaf Import API.

Usługa	web (moduł open-in-overleaf); pobieranie przez linked-url-proxy
Z zewnątrz → Overleaf	przeglądarki wysyłają GET lub POST ${OVERLEAF_SITE_URL}/docs z dowolnej strony internetowej
Pod → na zewnątrz	pobieranie snip_uri i zip_uri, z ograniczeniami opisanymi na stronie Zewnętrzny URL
Stan	żądanie niezalogowanego odwiedzającego, przechowywane w Redis przez 10 minut, dopóki się nie zaloguje
Zadania okresowe	brak

​

Konfiguracja

Włączenie nie wymaga żadnych działań. Powiązane ustawienia w ConfigMap:

Ustawienie
OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"	Niezalogowani odwiedzający mogą otworzyć /devs, a wysłane przez nich żądanie jest przechowywane do momentu zalogowania, zobacz Dostęp publiczny.
MAX_UPLOAD_SIZE	Największy plik ZIP, jaki może zawierać żądanie, w MB (domyślnie 50). Twój ingress lub load balancer również musi akceptować treści żądań o takim rozmiarze.
OVERLEAF_LINKED_URL_*	Na jakie adresy mogą wskazywać snip_uri i zip_uri, zobacz Zewnętrzny URL.

​

Kilka replik

Nic dodatkowego. Żądanie niezalogowanego odwiedzającego jest przechowywane w Redis, więc zostaje wznowione na tej replice, do której odwiedzający trafi po zalogowaniu.

​

Przetestowano na Kubernetes

Na Kubernetes 1.37 z jedną repliką nasze testy end-to-end Import API przechodzą pomyślnie (14 przypadków): strona /devs i jej przykładowy projekt, fragmenty kodu, kompletne dokumenty, linki zakodowane w URL i pliki z data URL zamieniane w projekty, odrzucanie zgłoszeń, z których nie da się utworzyć projektu, odrzucanie pobrań z adresów wewnętrznych, zachowywanie wysłanych formularzy i linków niezalogowanych użytkowników po zalogowaniu oraz, przy OVERLEAF_ALLOW_PUBLIC_ACCESS, /devs dla niezalogowanych odwiedzających i wysłany fragment wznowiony jednokrotnie po zalogowaniu; ostatni przypadek przechodzi również na trzech replikach za HAProxy.