Overleaf Import API

Дозвольте іншим вебсайтам відкривати фрагменти LaTeX і проєкти в розгортанні на Kubernetes.

Import API (/docs і кнопки «Open in Ayakaleaf», модуль open-in-overleaf) працює в службі web кожного пода Ayakaleaf Pro і ввімкнений за замовчуванням. Файли, задані через URL, завантажуються через linked-url-proxy у тому самому поді. Як його викликати, описано в розділі Overleaf Import API.

Служба	web (модуль open-in-overleaf); завантаження через linked-url-proxy
Ззовні → Overleaf	браузери виконують GET або POST ${OVERLEAF_SITE_URL}/docs з будь-якого вебсайту
Под → назовні	завантаження snip_uri і zip_uri, обмежені, як описано в розділі Зовнішня URL-адреса
Стан	запит відвідувача, який не ввійшов у систему, зберігається в Redis 10 хвилин, доки він не ввійде
Періодичні завдання	немає

​

Налаштування

Щоб увімкнути його, нічого не потрібно. Пов’язані налаштування в ConfigMap:

Налаштування
OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"	Відвідувачі, які не ввійшли в систему, можуть відкривати /devs, а надісланий ними запит зберігається, доки вони не ввійдуть, див. Публічний доступ.
MAX_UPLOAD_SIZE	Найбільший ZIP, який може містити запит, у МБ (за замовчуванням 50). Ваш ingress або балансувальник навантаження також має приймати тіла запитів такого розміру.
OVERLEAF_LINKED_URL_*	На які адреси можуть вказувати snip_uri і zip_uri, див. Зовнішня URL-адреса.

​

Кілька реплік

Нічого додаткового. Запит відвідувача, який не ввійшов у систему, зберігається в Redis, тож його буде відновлено на тій репліці, на яку відвідувач потрапить після входу.

​

Перевірено на Kubernetes

На Kubernetes 1.37 з однією реплікою наші наскрізні тести Import API проходять (14 випадків): сторінка /devs та її приклад проєкту, фрагменти, повні документи, URL-кодовані посилання та файли з data URL, перетворені на проєкти, відхилення надсилань, з яких не можна створити проєкт, відхилення завантажень із внутрішніх адрес, збереження надсилань і посилань від відвідувачів, які не ввійшли, на час входу, а також, з OVERLEAF_ALLOW_PUBLIC_ACCESS, /devs для відвідувачів, які не ввійшли, і надісланий фрагмент, відновлений один раз після входу; останній випадок проходить також на трьох репліках за HAProxy.