Przegląd

Overleaf działa jako kilka usług, które wywołują się nawzajem przez HTTP wewnątrz sieci Docker. Strony w tej sekcji opisują te wewnętrzne API. Pochodzą one z plików OpenAPI w develop/hoppscotch/openapi/, napisanych na podstawie kodu każdej usługi.

Żadne z tych API nie jest publiczne: są dostępne tylko wewnątrz sieci Docker, a większość z nich nie ma uwierzytelniania.

​

Usługi

Usługa	Adres	Co robi
web	http://web:3000	Główna aplikacja. Jej prywatne API wywołują inne usługi i skrypty cron obrazu
document-updater	http://document-updater:3003	Przechowuje w Redis dokumenty otwarte w edytorze, stosuje zmiany i zapisuje je z powrotem w Mongo
docstore	http://docstore:3016	Przechowuje każdy dokument każdego projektu w kolekcji Mongo docs
real-time	http://real-time:3026	Utrzymuje połączenia socket.io edytora i przekazuje zmiany między przeglądarkami a usługami
chat	http://chat:3010	Przechowuje czat projektu i wątki komentarzy
project-history	http://project-history:3054	Zamienia zakolejkowane zmiany na zmiany historii i wysyła je do history-v1; przechowuje etykiety
history-v1	http://history-v1:3100	Przechowuje pełną historię każdego projektu i zawartość plików jako bloby
filestore	http://filestore:3009	Serwuje pliki szablonów i, tylko do odczytu, bloby zapisywane przez history-v1
clsi	http://clsi:3013	Kompiluje projekty, uruchamia SyncTeX i liczenie słów, konwertuje dokumenty
notifications	http://notifications:3042	Przechowuje powiadomienia wyświetlane na liście projektów
linked-url-proxy	http://linked-url-proxy:3066	Pobiera zewnętrzne adresy URL dla web i odrzuca adresy wewnętrzne
third-party-datastore	http://third-party-datastore:3002	Synchronizuje projekty z Dropbox za pomocą jednej kolejki zadań na użytkownika

​

Uwierzytelnianie

• web: HTTP basic auth z WEB_API_USER i WEB_API_PASSWORD. Trasy git-bridge używają zamiast tego osobistego tokenu dostępu.
• history-v1: HTTP basic auth jako staging z STAGING_PASSWORD lub JWT.
• Wszystkie inne usługi: brak.

​

Wypróbuj je

Środowisko deweloperskie uruchamia Hoppscotch pod adresem http://localhost:9170, z proxy, które łączy się z usługami przez ich adresy Docker. Jego README pokazuje, jak ustawić proxy i zaimportować pliki OpenAPI.