Prasyarat
Overleaf adalah proyek open source khas dengan arsitektur microservice, di mana semua layanan berjalan di Docker.- Kode sumber resmi Community Edition tersedia di GitHub Overleaf Official.
- Kode sumber Overleaf-CEP tersedia di GitHub Yu-i-i/Overleaf.
- Ayakaleaf Pro tersedia di GitHub ayaka-notes/ayakaleaf-pro.
Karena server dengan 8 core CPU atau lebih biasanya mahal, sangat disarankan untuk menggunakan komputer lokal Anda untuk pengembangan.
- Server/desktop yang bertenaga untuk pengembangan
- Ubuntu LTS yang terbaru dan stabil (misalnya Ubuntu 24.04)
- Lingkungan Docker dan Git
Tutorial Konfigurasi
Di sini, kami menggunakan Ayakaleaf Pro untuk menunjukkan cara menyiapkan lingkungan pengembangan Overleaf. Semua perintah di bawah dijalankan di direktoridevelop kecuali disebutkan lain.
1
Tarik Kode Sumber
Pertama-tama, mari kita clone repositorinya:
bash
2
Menyinkronkan yarn.lock
Repositori menggunakan Yarn 4 (
packageManager di package.json root), dan yarn.lock-nya bisa tidak sinkron dengan file package.json. Sinkronkan setelah clone pertama dan setelah setiap perubahan package.json:bash
bin/sync menjalankan yarn install --mode=update-lockfile di container node:24.18.1, jadi Anda tidak memerlukan Node.js di host. Jangan commit yarn.lock yang berubah.3
Build Image Pengembangan
Bangun layanan:
bash
Jika Docker kehabisan RAM saat mem-build layanan secara paralel, buat file
.env di direktori ini yang berisi COMPOSE_PARALLEL_LIMIT=1.4
Menerapkan terjemahan
Modul Ayakaleaf Pro menyimpan terjemahannya di Perintah ini memerlukan
services/web/locales/locales_patches/, yang tidak ada di file locale yang di-commit. Terapkan sekali sebelum start pertama, atau halaman modul ini akan menampilkan kunci seperti about_to_permanently_delete_accounts alih-alih teks:bash
jq di host. Jalankan lagi setelah menambahkan terjemahan atau berganti branch, lihat Memperbarui Terjemahan i18n.5
Jalankan Semua Microservice
Kemudian jalankan layanannya:Setelah layanan berjalan, buka http://localhost/launchpad untuk membuat akun admin pertama. Tambahkan port jika Anda mengubah
bash
OVERLEAF_PORT (lihat di bawah).LDAP aktif secara default (
LDAP_ENABLED=true di dev.rc). Launchpad kemudian menampilkan formulir admin LDAP: formulir ini hanya meminta email, dan admin tersebut setelahnya login melalui LDAP, misalnya sebagai professor / professor (professor@planetexpress.com). Pengguna uji tercantum di develop/authentication/README.md. Atur LDAP_ENABLED=false dan SAML_ENABLED=false untuk membuat admin lokal dengan kata sandi sebagai gantinya.develop/dev.env sudah menetapkan ADMIN_PRIVILEGE_AVAILABLE=true, sehingga admin dapat membuka panel Admin tanpa penyiapan tambahan.Konfigurasi (dev.rc)
develop/dev.rc, di samping dev.env, berisi sakelar lingkungan pengembangan, seperti overleaf.rc di Overleaf Toolkit. Ubah sebuah nilai lalu jalankan bin/dev lagi untuk menerapkannya; fitur yang dinonaktifkan juga menghentikan container-nya.
Setiap fitur menyimpan
docker-compose.yml dan file lainnya di foldernya sendiri: authentication/ldap, authentication/saml, mail, s3, hoppscotch, dan grafana. Fitur yang memerlukan pengaturan web tanpa variabel lingkungan memasang file ke /etc/overleaf/settings.d/, dan develop/settings.dev-env.cjs menggabungkan semuanya. Semua skrip bin/* melewati bin/docker-compose, yang menambahkan file fitur yang aktif. Panggil bin/docker-compose alih-alih docker compose saat Anda sendiri memerlukan perintah compose.
Port
Situs, konsol RustFS, dan Hoppscotch mendengarkan di127.0.0.1 host; di mesin jarak jauh, teruskan port-nya terlebih dahulu, misalnya ssh -L 9001:localhost:9001 <host>. Situs menggunakan OVERLEAF_PORT dari dev.rc, jadi tambahkan port ke alamat di bawah jika Anda mengubahnya.
Mailpit, Grafana, Mongo Express, dan RedisInsight disajikan oleh situs di path-nya sendiri melalui webpack-dev-server, sehingga tidak memerlukan port sendiri. Setelah Anda login, menu Dev tools di bilah navigasi situs menautkannya; halaman yang fiturnya dinonaktifkan di
dev.rc tidak ditampilkan. Menyiapkan Alat Pengembangan menunjukkan fungsi masing-masing.
S3 API (port 9000) dan SMTP (port 1025) hanya dapat dijangkau di dalam jaringan Docker. Mongo (27017), Redis (6379), Mongo Express (8081), RedisInsight (5540), dan git-bridge (8000) hanya dipublikasikan di 127.0.0.1 host.
TeX Live
Kompilasi sandbox aktif secara default:develop/dev.env menetapkan SANDBOXED_COMPILES=true serta image ghcr.io/ayaka-notes/texlive-full:2026.1 dan ghcr.io/ayaka-notes/texlive-full:2025.1. clsi tidak menarik image sendiri, jadi tarik image tersebut sekali:
dev.env juga mengaktifkan konversi Pandoc dengan PANDOC_IMAGE=overleaf-pandoc:local. Bangun image itu sekali dari root repositori:
.env di direktori develop yang berisi DOCKER_SOCKET_PATH=/var/run/docker.sock.raw
Pengembangan
Agar tidak perlu menjalankanbin/build && bin/up setiap kali kode berubah, Anda dapat menjalankan Overleaf Community Edition dalam mode pengembangan, di mana layanan akan diperbarui secara otomatis saat kode berubah.
Untuk melakukannya, gunakan skrip bin/dev yang disertakan:
node --watch, yang akan memantau kode secara otomatis dan memulai ulang layanan bila diperlukan. Jalankan lagi setelah mengubah dev.rc.
Untuk meningkatkan performa, Anda dapat menjalankan hanya sebagian layanan dalam mode pengembangan dengan memberikan daftar yang dipisahkan spasi ke skrip bin/dev:
Menjalankan layanan
web dalam mode pengembangan hanya akan memperbarui layanan web saat kode backend berubah. Agar kode frontend juga diperbarui secara otomatis, pastikan untuk menjalankan layanan webpack dalam mode pengembangan juga.bin/i18n, lihat Memperbarui Terjemahan i18n.
Debugging
Saat berjalan dalam mode pengembangan, sebagian besar layanan membuka port debugging yang dapat Anda sambungkan ke debugger, seperti inspector di Chrome Dev Tools atau debugger yang terintegrasi di IDE. Tabel berikut menunjukkan port yang dibuka di127.0.0.1 pada mesin host untuk setiap layanan:
Untuk terhubung ke layanan menggunakan remote debugging Chrome, buka chrome://inspect/ dan pastikan Discover network targets dicentang. Selanjutnya klik Configure… dan tambahkan entri
localhost:[service port] untuk setiap layanan yang ingin Anda hubungkan dengan debugger.
Setelah menambahkan entri, layanan akan muncul sebagai Remote Target yang dapat Anda inspeksi dan debug.
Logging
Skripbin/logs mengikuti log dan memformatnya dengan bunyan. Skrip ini juga memerlukan ggrep, yaitu nama GNU grep saat diinstal dengan Homebrew di macOS; Ubuntu tidak memiliki perintah ggrep.
bin/docker-compose alih-alih docker compose, agar layanan dari fitur di dev.rc (mailpit, rustfs, ldap, saml, hoppscotch, dan grafana beserta Prometheus, Loki, dan exporter) juga ditemukan.
Dengan GRAFANA_ENABLED=true, log setiap container juga ada di Grafana, tempat log dapat difilter berdasarkan layanan, level, dan teks, lihat Menyiapkan Alat Pengembangan.

