Pengaturan Toolkit

Halaman ini menjelaskan variabel lingkungan yang didukung di file config/overleaf.rc untuk deployment Toolkit.

File config/overleaf.rc terdiri dari definisi variabel dalam bentuk NAME=value. Baris yang diawali dengan # diperlakukan sebagai komentar.

Anda perlu membuat ulang kontainer Docker dengan menjalankan bin/up setelah mengubah apa pun di overleaf.rc atau variables.env.

​

Kontainer

​

sharelatex

Nama	Deskripsi
PROJECT_NAME	Mengatur nilai flag --project-name yang diberikan ke docker-compose. Ini berguna saat menjalankan beberapa instans Overleaf di satu host, karena setiap instans dapat memiliki nama proyek yang berbeda. - Default: overleaf
OVERLEAF_IMAGE_NAME	Image Docker yang digunakan oleh kontainer aplikasi Server Pro/CE. Ini hanya nama image Docker; tag image Docker diambil dari config/version. - Default: - Server Pro: ghcr.io/ayaka-notes/overleaf-pro - Community Edition: sharelatex/sharelatex
SERVER_PRO	Jika diatur ke true, Toolkit akan menggunakan image Server Pro (ghcr.io/ayaka-notes/overleaf-pro), alih-alih image Server CE default (sharelatex/sharelatex). - Default: false
GIT_BRIDGE_ENABLED	Atur ke true untuk mengaktifkan fitur git-bridge (khusus Server Pro). Untuk informasi lebih lanjut, lihat dokumentasi pengguna https://www.overleaf.com/learn/how-to/Git_integration. - Default: false
GIT_BRIDGE_IMAGE	Image Docker yang digunakan oleh kontainer git-bridge (khusus Server Pro). Ini hanya nama image Docker; tag image Docker diambil dari config/version. - Default: ghcr.io/ayaka-notes/overleaf-pro/git-bridge
GIT_BRIDGE_DATA_PATH	Mengatur path ke direktori yang akan di-mount ke dalam kontainer git-bridge (khusus Server Pro), dan digunakan untuk menyimpan repositori git. Nilainya dapat berupa path lengkap (diawali dengan /), atau relatif terhadap direktori dasar Toolkit.
GIT_BRIDGE_LOG_LEVEL	Mengonfigurasi level logging kontainer git-bridge. Level yang tersedia: TRACE, DEBUG, INFO, WARN, ERROR. - Default: INFO
SIBLING_CONTAINERS_ENABLED	Jika diatur ke true, Toolkit akan menggunakan teknik Sibling Containers untuk mengompilasi proyek dalam sandbox terpisah, menggunakan kontainer Docker terpisah untuk setiap proyek. Lihat dokumentasi <server-pro-only-configuration/sandboxed-compiles> untuk informasi lebih lanjut. - Memerlukan: SERVER_PRO=true - Default: true
SIBLING_CONTAINERS_PULL	Jika diatur ke true, Toolkit akan secara otomatis menarik semua image TeX Live yang diatur melalui ALL_TEX_LIVE_DOCKER_IMAGES di file config/variables.env saat menggunakan perintah bin/up. - Default: true
DOCKER_SOCKET_PATH	Mengatur path ke socket Docker di mesin host (mesin yang menjalankan Toolkit). Jika SIBLING_CONTAINERS_ENABLED bernilai true, socket akan di-mount ke dalam kontainer agar layanan compiler dapat membuat kontainer Docker baru di host. - Memerlukan: SIBLING_CONTAINERS_ENABLED=true - Default: /var/run/docker.sock
OVERLEAF_DATA_PATH	Mengatur path ke direktori yang akan di-mount ke dalam kontainer utama sharelatex, dan digunakan untuk menyimpan data kompilasi. Nilainya dapat berupa path lengkap (diawali dengan /), atau relatif terhadap direktori dasar Toolkit. - Default: data/overleaf
OVERLEAF_LISTEN_IP	Mengatur alamat IP host tempat kontainer akan melakukan bind. Misalnya, jika diatur ke 0.0.0.0, antarmuka web akan tersedia di alamat IP host mana pun. Untuk akses kontainer secara langsung, nilai OVERLEAF_LISTEN_IP harus diatur ke alamat IP publik Anda. Mengatur OVERLEAF_LISTEN_IP ke 0.0.0.0 atau IP eksternal host Anda biasanya akan menyebabkan error jika digunakan bersama dengan . - Default: 127.0.0.1
OVERLEAF_PORT	Mengatur port host tempat kontainer akan melakukan bind. Misalnya, jika diatur ke 8099 dan OVERLEAF_LISTEN_IP diatur ke 127.0.0.1, antarmuka web akan tersedia di http://localhost:8099. - Default: 80
OVERLEAF_LOG_PATH	Mengatur path ke direktori yang akan di-mount ke dalam kontainer utama sharelatex, dan digunakan agar log aplikasi tersedia di host Docker. Nilainya dapat berupa path lengkap (diawali dengan /), atau relatif terhadap direktori dasar Toolkit. Hapus entri konfigurasi ini untuk menonaktifkan bind-mount. Jika tidak diatur, log akan dibuang saat kontainer dibuat ulang. Lihat untuk informasi tentang logging. - Default: tidak diatur

---

​

mongo

Nama	Deskripsi
MONGO_ENABLED	Jika diatur ke true, Toolkit akan membuat kontainer MongoDB untuk menampung database. Jika diatur ke false, kontainer ini tidak akan dibuat, dan sistem akan menggunakan database MongoDB yang ditentukan oleh MONGO_URL. - Default: true
MONGO_URL	Menentukan URL koneksi MongoDB yang digunakan saat MONGO_ENABLED bernilai false. - Default: tidak diatur
MONGO_DATA_PATH	Mengatur path ke direktori yang akan di-mount ke dalam kontainer mongo, dan digunakan untuk menyimpan database MongoDB. Nilainya dapat berupa path lengkap (diawali dengan /), atau relatif terhadap direktori dasar toolkit. Opsi ini hanya memengaruhi kontainer mongo lokal yang dibuat saat MONGO_ENABLED bernilai true. - Default: data/mongo
MONGO_IMAGE	Image Docker yang digunakan oleh kontainer MongoDB. Ini hanya nama image Docker; tag image Docker harus dimasukkan ke MONGO_VERSION (lihat di bawah). - Default: mongo
MONGO_VERSION	Versi MongoDB yang digunakan oleh kontainer MongoDB. Nilainya harus diawali dengan versi mayor MongoDB dan sebuah titik, misalnya 6.0 atau 6.0-with-suffix. - Default: 6.0

---

​

redis

Nama	Deskripsi
REDIS_ENABLED	Jika diatur ke true, Toolkit akan membuat kontainer Redis untuk menampung database redis. Jika diatur ke false, kontainer ini tidak akan dibuat, dan sistem akan menggunakan database Redis yang ditentukan oleh REDIS_HOST dan REDIS_PORT. - Default: true
REDIS_HOST	Menentukan host Redis yang digunakan saat REDIS_ENABLED bernilai false. - Default: tidak diatur
REDIS_PORT	Menentukan port Redis yang digunakan saat REDIS_ENABLED bernilai false. - Default: tidak diatur
REDIS_DATA_PATH	Mengatur path ke direktori yang akan di-mount ke dalam kontainer redis, dan digunakan untuk menyimpan database Redis. Nilainya dapat berupa path lengkap (diawali dengan /), atau relatif terhadap direktori dasar Toolkit. Opsi ini hanya memengaruhi kontainer redis lokal yang dibuat saat REDIS_ENABLED bernilai true. - Default: data/redis
REDIS_AOF_PERSISTENCE	Mengaktifkan persistensi AOF (Append Only File) untuk Redis. Ini adalah konfigurasi yang direkomendasikan untuk persistensi Redis. Untuk detail tambahan, lihat bagian <../../../maintenance/data-and-backups#aof-append-only-file> di <../../maintenance/data-and-backups>. - Default: true

---

​

nginx

Nama	Deskripsi
NGINX_ENABLED	Jika diatur ke true, Toolkit akan membuat kontainer NGINX yang berfungsi sebagai TLS Proxy. - Default: false
NGINX_CONFIG_PATH	Path ke file konfigurasi NGINX yang digunakan untuk TLS Proxy. - Default: config/nginx/nginx.conf
NGINX_TLS_LISTEN_IP	Mengatur alamat IP host tempat kontainer TLS Proxy akan melakukan bind untuk HTTPS. Misalnya, jika diatur ke 0.0.0.0, antarmuka web HTTPS akan tersedia di alamat IP host mana pun. Biasanya nilai ini harus diatur ke IP eksternal host Anda. - Default: 127.0.1.1
NGINX_HTTP_LISTEN_IP	Mengatur alamat IP host tempat kontainer TLS Proxy akan melakukan bind untuk pengalihan HTTP. Misalnya, jika diatur ke 127.0.1.1, koneksi HTTP ke 127.0.1.1 akan dialihkan ke antarmuka web HTTPS. Biasanya nilai ini harus diatur ke IP eksternal host Anda. Jangan atur ke 0.0.0.0 karena biasanya akan menimbulkan konflik dengan OVERLEAF_LISTEN_IP. - Default: 127.0.1.1
NGINX_HTTP_PORT	Mengatur port host tempat kontainer TLS Proxy akan melakukan bind untuk HTTP. - Default: 80
TLS_PORT	Mengatur port host tempat kontainer TLS Proxy akan melakukan bind untuk HTTPS. - Default: 443
TLS_PRIVATE_KEY_PATH	Path ke private key yang digunakan untuk TLS Proxy. - Default: config/nginx/certs/overleaf_key.pem
TLS_CERTIFICATE_PATH	Path ke sertifikat publik yang digunakan untuk TLS Proxy. - Default: config/nginx/certs/overleaf_certificate.pem