File dan lokasi

Halaman ini menjelaskan file-file konfigurasi yang digunakan oleh Toolkit untuk mengonfigurasi deployment Overleaf on-premises Anda.

​

Data Persisten

Overleaf Toolkit perlu menyimpan data persisten, seperti file yang dibutuhkan untuk mengompilasi proyek LaTeX, dan isi database MongoDB. Hal ini dilakukan dengan me-mount beberapa direktori dari mesin host ke dalam container Docker, lalu menulis data ke direktori-direktori tersebut.

​

Direktori Data

Container sharelatex memerlukan sebuah direktori untuk menyimpan data yang berkaitan dengan kompilasi LaTeX. Direktori ini diatur dengan variabel OVERLEAF_DATA_PATH di config/overleaf.rc.

Container mongo, jika diaktifkan, memerlukan sebuah direktori untuk menyimpan file database-nya, dan hal yang sama berlaku untuk container redis. Direktori-direktori ini juga dapat dikonfigurasi di config/overleaf.rc.

​

Izin File

Karena Docker berjalan sebagai root, direktori data pada akhirnya akan dimiliki oleh pengguna root, meskipun Toolkit digunakan oleh pengguna non-root. Ini bukan masalah, tetapi perlu diperhatikan jika Anda berniat mengubah data persisten dari luar container.

​

Lokasi file konfigurasi

Semua file konfigurasi milik pengguna terdapat di direktori config/.

Direktori ini dikecualikan dari sistem kontrol revisi git, sehingga tidak akan berubah saat kode Toolkit diperbarui. Toolkit tidak akan mengubah data apa pun di direktori config/ tanpa izin Anda.

Perubahan pada file konfigurasi tidak akan diterapkan secara otomatis ke container yang sudah ada, bahkan jika container dihentikan dan dijalankan ulang (dengan bin/stop dan bin/start). Untuk menerapkan perubahan, jalankan bin/up, dan di balik layar, docker compose akan secara otomatis menerapkan perubahan konfigurasi ke container baru. (Atau, jalankan bin/up -d jika Anda tidak ingin terhubung ke log Docker.)

​

File overleaf.rc

File config/overleaf.rc berisi pengaturan konfigurasi tingkat atas yang paling penting yang digunakan oleh Toolkit. File ini berisi pernyataan yang mengatur variabel, dengan format: VARIABLE_NAME=value

Untuk melihat rincian semua opsi konfigurasi yang tersedia, lihat bagian pengaturan kami.

​

File variables.env

File config/variables.env berisi variabel lingkungan yang dimuat ke dalam container sharelatex dan digunakan untuk mengonfigurasi microservice Overleaf. Ini mencakup nama aplikasi, seperti yang ditampilkan di header antarmuka web, pengaturan untuk pengiriman email, dan pengaturan premium lainnya seperti SSO untuk digunakan dengan Server Pro.

Untuk melihat rincian semua variabel lingkungan yang tersedia, lihat bagian Variabel lingkungan.

​

File version

File config/version berisi nomor versi image Docker yang akan digunakan untuk membuat instans server Overleaf Anda yang sedang berjalan.

Perubahan pada file konfigurasi ini tidak akan diterapkan secara otomatis ke container yang sudah ada, bahkan jika container dihentikan dan dijalankan ulang (dengan bin/stop dan bin/start). Untuk menerapkan perubahan Anda, jalankan bin/up, dan Toolkit akan secara otomatis membuat container baru untuk Anda dengan perubahan konfigurasi yang telah diterapkan.

​

File docker-compose.override.yml

Jika ada, file config/docker-compose.override.yml akan disertakan dalam pemanggilan docker compose. Ini berguna untuk menimpa konfigurasi yang spesifik untuk Docker Compose.

Lihat dokumentasi docker-compose untuk detail lebih lanjut.