Yleiskatsaus

Overleaf toimii useina palveluina, jotka kutsuvat toisiaan HTTP:n kautta Docker-verkon sisällä. Tämän osion sivut kuvaavat näitä sisäisiä API-rajapintoja. Ne perustuvat hakemiston develop/hoppscotch/openapi/ OpenAPI-tiedostoihin, jotka on kirjoitettu kunkin palvelun koodin pohjalta.

Mikään näistä API-rajapinnoista ei ole julkinen: niihin pääsee vain Docker-verkon sisältä, eikä useimmissa ole todennusta.

​

Palvelut

Palvelu	Osoite	Mitä se tekee
web	http://web:3000	Pääsovellus. Sen yksityistä API:a kutsuvat muut palvelut ja imagen cron-skriptit
document-updater	http://document-updater:3003	Pitää editorissa avoinna olevat dokumentit Redisissä, soveltaa muokkaukset ja kirjoittaa ne takaisin Mongoon
docstore	http://docstore:3016	Tallentaa jokaisen projektin jokaisen dokumentin Mongo-kokoelmaan docs
real-time	http://real-time:3026	Ylläpitää editorin socket.io-yhteyksiä ja välittää muokkauksia selainten ja palvelujen välillä
chat	http://chat:3010	Tallentaa projektin chatin ja kommenttiketjut
project-history	http://project-history:3054	Muuttaa jonossa olevat muokkaukset historiamuutoksiksi ja lähettää ne history-v1:lle; säilyttää tunnisteet
history-v1	http://history-v1:3100	Tallentaa jokaisen projektin koko historian ja tiedostojen sisällön blobeina
filestore	http://filestore:3009	Tarjoilee mallitiedostot ja vain luku -tilassa history-v1:n kirjoittamat blobit
clsi	http://clsi:3013	Kääntää projektit, ajaa SyncTeX:n ja sanalaskennan, muuntaa asiakirjoja
notifications	http://notifications:3042	Tallentaa projektiluettelossa näytettävät ilmoitukset
linked-url-proxy	http://linked-url-proxy:3066	Hakee ulkoisia URL-osoitteita webille ja hylkää sisäiset osoitteet
third-party-datastore	http://third-party-datastore:3002	Synkronoi projekteja Dropboxin kanssa yhden käyttäjäkohtaisen työjonon kautta

​

Todennus

• web: HTTP basic -todennus muuttujilla WEB_API_USER ja WEB_API_PASSWORD. git-bridge-reitit käyttävät sen sijaan henkilökohtaista käyttötunnusta.
• history-v1: HTTP basic -todennus käyttäjänä staging salasanalla STAGING_PASSWORD tai JWT.
• Kaikki muut palvelut: ei mitään.

​

Kokeile niitä

Kehitysympäristö ajaa Hoppscotchia osoitteessa http://localhost:9170 välityspalvelimen kanssa, joka tavoittaa palvelut niiden Docker-osoitteilla. Sen README näyttää, miten välityspalvelin asetetaan ja OpenAPI-tiedostot tuodaan.