Ikhtisar

Overleaf berjalan sebagai beberapa layanan yang saling memanggil melalui HTTP di dalam jaringan Docker. Halaman di bagian ini menjelaskan API internal tersebut. Isinya berasal dari file OpenAPI di develop/hoppscotch/openapi/, yang ditulis berdasarkan kode setiap layanan.

Tidak satu pun API ini bersifat publik: semuanya hanya dapat dijangkau di dalam jaringan Docker, dan sebagian besar tidak memiliki autentikasi.

​

Layanan

Layanan	Alamat	Fungsinya
web	http://web:3000	Aplikasi utama. API privatnya dipanggil oleh layanan lain dan skrip cron image
document-updater	http://document-updater:3003	Menyimpan dokumen yang terbuka di editor di Redis, menerapkan suntingan, dan menuliskannya kembali ke Mongo
docstore	http://docstore:3016	Menyimpan setiap dokumen dari setiap proyek di koleksi Mongo docs
real-time	http://real-time:3026	Menangani koneksi socket.io editor dan meneruskan suntingan antara browser dan layanan
chat	http://chat:3010	Menyimpan obrolan proyek dan utas komentar
project-history	http://project-history:3054	Mengubah suntingan dalam antrean menjadi perubahan riwayat dan mengirimkannya ke history-v1; menyimpan label
history-v1	http://history-v1:3100	Menyimpan riwayat lengkap setiap proyek dan isi file sebagai blob
filestore	http://filestore:3009	Menyajikan file templat dan, hanya-baca, blob yang ditulis history-v1
clsi	http://clsi:3013	Mengompilasi proyek, menjalankan SyncTeX dan penghitungan kata, mengonversi dokumen
notifications	http://notifications:3042	Menyimpan notifikasi yang ditampilkan di daftar proyek
linked-url-proxy	http://linked-url-proxy:3066	Mengambil URL eksternal untuk web dan menolak alamat internal
third-party-datastore	http://third-party-datastore:3002	Menyinkronkan proyek dengan Dropbox melalui satu antrean pekerjaan per pengguna

​

Autentikasi

• web: HTTP basic auth dengan WEB_API_USER dan WEB_API_PASSWORD. Rute git-bridge menggunakan token akses pribadi sebagai gantinya.
• history-v1: HTTP basic auth sebagai staging dengan STAGING_PASSWORD, atau JWT.
• Semua layanan lain: tidak ada.

​

Mencobanya

Lingkungan pengembangan menjalankan Hoppscotch di http://localhost:9170, dengan proxy yang menjangkau layanan melalui alamat Docker-nya. README-nya menunjukkan cara mengatur proxy dan mengimpor file OpenAPI.