Keamanan yang lebih baik
Sandboxed Compiles adalah pendekatan yang direkomendasikan untuk Ayakaleaf Pro karena banyak dokumen LaTeX memerlukan/memiliki kemampuan untuk mengeksekusi perintah shell arbitrer sebagai bagian dari proses kompilasi PDF. Jika Anda menggunakan Sandboxed Compiles, setiap kompilasi berjalan di kontainer Docker terpisah dengan kemampuan terbatas yang tidak dibagikan dengan pengguna atau proyek lain dan tidak memiliki akses ke sumber daya luar seperti jaringan host.Manajemen paket yang lebih mudah
Untuk menghindari instalasi paket secara manual, kami menyarankan untuk mengaktifkan Sandboxed Compiles. Ini adalah pengaturan yang dapat dikonfigurasi di Ayakaleaf Pro yang akan memberikan pengguna Anda akses ke lingkungan TeX Live yang sama seperti di overleaf.com, tetapi di dalam instalasi on-premise Anda sendiri. Image TeX Live yang digunakan oleh Sandboxed Compiles berisi paket dan font paling populer yang telah diuji terhadap template galeri kami, sehingga memastikan kompatibilitas maksimum dengan proyek on-premise. Mengaktifkan Sandboxed Compiles memungkinkan Anda mengonfigurasi versi TeX Live mana yang dapat dipilih pengguna dalam proyek mereka, serta menetapkan versi image TeX Live default untuk proyek baru.Jika Anda mencoba menjalankan Ayakaleaf Pro tanpa Sandboxed Compiles, instance Anda akan secara default menggunakan versi skema dasar TeX Live untuk kompilasi. Versi dasar ini ringan dan hanya berisi subset paket LaTeX yang sangat terbatas, yang kemungkinan besar akan menyebabkan error paket hilang bagi pengguna Anda, terutama jika mereka mencoba menggunakan template yang sudah jadi.
Sandboxed Compiles mengharuskan kontainer
sharelatex memiliki akses ke socket Docker pada mesin host (melalui bind mount) agar dapat mengelola kontainer kompilasi saudara (sibling) ini.Cara kerjanya
Ketika Sandboxed Compiles diaktifkan, socket Docker akan di-mount dari mesin host ke dalam kontainersharelatex, sehingga layanan compiler di dalam kontainer dapat membuat kontainer Docker baru di host. Kemudian, untuk setiap kali compiler dijalankan di setiap proyek, layanan compiler LaTeX (CLSI) akan melakukan hal berikut:
- Menulis file proyek ke suatu lokasi di dalam
OVERLEAF_DATA_PATH. - Menggunakan socket Docker yang di-mount untuk membuat kontainer
texlivebaru untuk proses kompilasi tersebut. - Membuat kontainer
texlivemembaca data proyek dari lokasi di bawahOVERLEAF_DATA_PATH. - Mengompilasi proyek di dalam kontainer
texlive.
Mengaktifkan Sandboxed Compiles
Untuk Pengguna Toolkit
Untuk mengaktifkan sandboxed compiles (juga dikenal sebagai Sibling containers), atur opsi konfigurasi berikut dioverleaf-toolkit/config/overleaf.rc:
config/overleaf.rc
SIBLING_CONTAINERS_ENABLED=false lalu jalankan bin/up. Kompilasi kemudian berjalan di dalam kontainer sharelatex dengan TeX Live dasarnya.
Untuk Pengguna Docker Compose
Menyiapkan Image TexLive
Untuk pengguna di Tiongkok daratan, Anda dapat menarik image dari mirror JANGAN menggunakan
ghcr.nju.edu.cn untuk mempercepat unduhan, lalu memberinya tag dengan nama ghcr.io-nya:ghcr.nju.edu.cn di pengaturan env toolkit Anda: tetap gunakan nama ghcr.io di sana. Agar bin/up tidak menarik image dari ghcr.io lagi, atur SIBLING_CONTAINERS_PULL=false di config/overleaf.rc. Untuk menjaga image tetap mutakhir melalui mirror, lihat Memperbarui Image TeX Live Full Secara Otomatis.TEX_LIVE_DOCKER_IMAGE(opsional), Image TeX Live yang digunakan oleh proyek baru. Image ini harus salah satu dari image diALL_TEX_LIVE_DOCKER_IMAGES. Jika tidak diatur, proyek baru menggunakan image pertama diALL_TEX_LIVE_DOCKER_IMAGES.ALL_TEX_LIVE_DOCKER_IMAGE_NAMES(opsional), Daftar nama untuk image yang dipisahkan koma, dengan urutan yang sama, ditampilkan di pengaturan compiler. Jika tidak diatur, atau lebih pendek dari daftar image, image ditampilkan berdasarkan tag-nya, misalnya2026.1.ALL_TEX_LIVE_DOCKER_IMAGES(wajib), Daftar image TeX Live yang akan digunakan, dipisahkan koma. Jika Overleaf Toolkit digunakan untuk deployment, image-image ini akan diunduh atau diperbarui. Untuk melewati pengunduhan, aturSIBLING_CONTAINERS_PULL=falsediconfig/overleaf.rc.
bin/up, Toolkit akan secara otomatis menarik semua image yang tercantum di ALL_TEX_LIVE_DOCKER_IMAGES.
Berikut contoh di mana kami menggunakan TeX Live 2026 sebagai default untuk proyek baru, dan tetap menggunakan 2025 untuk proyek lama.
- Instalasi minimum
- Instalasi lengkap
Konfigurasi berikut menginstal semua image Docker TeX Live lengkap dari 2025 hingga 2026. Kami menyarankan agar Anda memiliki setidaknya 64 GB ruang penyimpanan yang tersedia sebelum menggunakan konfigurasi ini.
config/variables.env
Sangat disarankan untuk mengatur setidaknya 2 image texlive-full. Untuk alasan selengkapnya, lihat #known-issues
Image TeX Live yang tersedia
Berikut adalah serangkaian image TeX Live yang dioptimalkan khusus untuk Overleaf, dan juga dapat ditambahkan keTEX_LIVE_DOCKER_IMAGE dan ALL_TEX_LIVE_DOCKER_IMAGES:
ghcr.io/ayaka-notes/texlive-full:2026.1(juga taglatest)ghcr.io/ayaka-notes/texlive-full:2025.1ghcr.io/ayaka-notes/texlive-full:2024.1ghcr.io/ayaka-notes/texlive-full:2023.1ghcr.io/ayaka-notes/texlive-full:2022.1ghcr.io/ayaka-notes/texlive-full:2021.1ghcr.io/ayaka-notes/texlive-full:2020.1
Bisakah Saya Menggunakan Image Registry Lain
Sebagian orang mungkin bertanya-tanya apakah saya dapat mengganti ghcr.io dengan situs mirror lain, atau mengganti texlive dengan image lain dari docker hub?
Tidak, kami tidak menyarankannya karena konfigurasinya relatif rumit. Jika Anda mengunduh dari situs mirror, Anda dapat mengganti nama image Anda menjadi ghcr.io/ayaka-notes/texlive-full.
Namun, jika Anda benar-benar ingin menggunakan Image Registry Anda sendiri, tambahkan:
config/variables.env
your-repo, seperti
hub.your.com/your-repo/texlive-full:2025.1hub.your.com/your-repo/texlive-full:2024.1
sandboxed-compiles/index.mjs
Sinkronisasi Image TeX Live Otomatis
Untuk menghindari pembaruan manual instance Anda denganbin/up setiap saat, Anda dapat mengotomatiskan pembaruan image TeX Live Anda. Lihat updating-tex-live-full-images-automatically.md.
Masalah yang Diketahui
Berikut adalah kasus nyata dari komunitas Overleaf:Menggunakan6.0.1-ext-v3.3, saya memiliki pengaturan berikut divariables.env:Ini berfungsi dengan baik dengantexlive/texlive:latest-full. Namun, saya menarik image texlive laindanteev/texlive:2025-10-15dan mengubah kedua variabel ini ke nama image baru, tetapi tidak berhasil:Di log, saya melihat hal berikut:
Tampaknya pengaturan yang diperbarui diKarena beberapa keterbatasan teknis, jika Anda hanya menyiapkan satu image Docker TeXLive, sepertivariables.envtidak diterapkan. Kompilasi masih mencoba menjalankan imagetexlive/texlive:latest-full, bukan image yang baru. Saya sudah mencoba me-reboot, menghapus kontainer, dan menjalankannya ulang, tetapi masalahnya tetap sama. Ada solusi?
texlive-fullA:latest
texlive-fullB:latest. Kemudian, Anda akan melihat bahwa pengguna Anda tidak dapat mengompilasi semua proyek.
Debug dan Pelaporan
Jalankan perintah berikut untuk memeriksa log clsi dari toolkit:Tanya Jawab
Apakah kontainer sandbox, file kompilasi, dan image TeX Live dihapus secara otomatis?
Apakah kontainer sandbox, file kompilasi, dan image TeX Live dihapus secara otomatis?
Jawaban: Kontainer dan file kompilasi dihapus, setelah jeda waktu tertentu; image TeX Live tidak.
- Kontainer kompilasi (
project-<project id>-<hash>) digunakan kembali di seluruh kompilasi proyek yang sama, sehingga tetap ada setelah kompilasi. Pemeriksaan berjalan setiap jam dan menghapus kontainer yang berusia lebih dari satu jam dan proyeknya tidak dikompilasi dalam satu jam terakhir. Kontainer biasanya hilang satu hingga dua jam setelah kompilasi terakhir. Memulai ulang Overleaf tidak menghapusnya; pemeriksaan per jam berikutnya yang akan menghapusnya. - Kontainer penghitung kata, SyncTeX, dan konversi dihapus segera setelah selesai.
- File kompilasi (
data/overleaf/data/compilesdanoutput) dihapus setelah sebuah proyek tidak digunakan selama satu hari, diperiksa setiap 10 menit. Saat ruang disk menipis, periode ini dipersingkat secara bertahap, hingga setengah hari. - Image TeX Live tidak pernah dihapus, karena setiap kompilasi memerlukannya. Untuk mengosongkan ruang setelah menghapus image dari
ALL_TEX_LIVE_DOCKER_IMAGES, hapus image tersebut dengandocker image rm <image>.
Apakah proyek dapat membaca file dari direktori host atau NAS?
Apakah proyek dapat membaca file dari direktori host atau NAS?
Jawaban: Tidak. Setiap kontainer kompilasi hanya me-mount direktori kompilasi dari proyeknya sendiri, di
/compile, dan tidak memiliki jaringan, serta tidak ada pengaturan untuk me-mount direktori host lain ke dalamnya. Sebagai gantinya, unggah file yang dibutuhkan proyek ke proyek tersebut.Apakah ada image TeX Live basic, dan bagaimana cara mengonfigurasinya?
Apakah ada image TeX Live basic, dan bagaimana cara mengonfigurasinya?
Jawaban: Ya.
ghcr.io/ayaka-notes/texlive-basic:<year>.1 (2020.1 hingga 2026.1) berisi skema TeX Live basic ditambah beberapa paket seperti latexmk, xetex, dan fontspec, tanpa set font lengkap. Image ini jauh lebih kecil daripada texlive-full, tetapi proyek yang menggunakan paket lain akan mendapatkan error paket yang hilang. Untuk TeX Live 2025 basic:config/variables.env
ghcr.io/ayaka-notes/texlive-full:base bukan image basic: image ini tidak berisi TeX Live dan tidak dapat melakukan kompilasi.Di mana saya dapat melihat berapa lama kompilasi berlangsung?
Di mana saya dapat melihat berapa lama kompilasi berlangsung?
Jawaban: Editor tidak menampilkannya, dan log
clsi hanya mencatatnya pada level debug. Namun, setiap permintaan kompilasi mengembalikannya: buka developer tools browser, buka tab Network, lakukan kompilasi ulang, lalu pilih permintaan compile. Respons JSON-nya berisi timings dalam milidetik, dengan compileE2E adalah keseluruhan kompilasi di layanan kompilasi dan compile adalah proses LaTeX itu sendiri.
