> For the complete documentation index, see [llms.txt](https://overleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://overleaf-pro.ayaka.space/on-premises/id/memulai/what-is-the-overleaf-toolkit.md). # Apa itu Overleaf Toolkit? Overleaf Toolkit adalah metode penerapan yang direkomendasikan untuk instalasi Community Edition, Server Pro, atau Overleaf Pro di lingkungan on-premises; Toolkit ini dirancang untuk bekerja dengan lingkungan yang paling umum: satu server fisik atau mesin virtual. Toolkit menggunakan `docker compose` untuk mengelola kontainer Docker server Anda dan menyediakan serangkaian skrip yang membungkus `docker` perintah untuk membantu sisi yang lebih teknis dalam mengelola versi Overleaf on-premises. #### The `bin/docker-compose` wrapper The `bin/docker-compose` skrip adalah pembungkus untuk `docker compose`. Ini memuat konfigurasi dari `direktori config/,` sebelum memanggil `docker compose` dengan argumen apa pun yang diteruskan ke skrip. Anda dapat menganggap `bin/docker-compose` sebagai pembungkus transparan untuk `docker compose` program yang terpasang di mesin Anda. Contoh: {% code title="Periksa kontainer yang sedang berjalan" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Pembantu praktis Selain `bin/docker-compose`, Toolkit menyediakan skrip praktis untuk membantu tugas-tugas umum: * `bin/up`: pintasan untuk `bin/docker-compose up` * `bin/start`: pintasan untuk `bin/docker-compose start` * `bin/stop`: pintasan untuk `bin/docker-compose stop` * `bin/shell`: memulai shell di dalam **sharelatex** kontainer * `bin/doctor`: skrip yang digunakan untuk mengumpulkan informasi instalasi dan penerapan. Lihat bagian "Memeriksa server Anda" di bawah * `bin/mongo`: memulai shell di dalam **mongo** kontainer dan beralih ke basis data yang benar (**sharelatex**) * `bin/backup-config`: buat salinan (zip atau tar) dari konfigurasi Anda saat ini dan simpan di direktori tujuan pilihan Anda * `bin/logs`: lihat/tail log layanan * `bin/error-logs`: lihat/tail log kesalahan layanan * `bin/rename-env-vars-5-0`: skrip migrasi untuk memperbarui variabel lingkungan di **config/variables.env** (re-branding dari ShareLaTeX menjadi Overleaf) * `bin/rename-rc-vars`: skrip migrasi untuk memperbarui variabel lingkungan di **config/overleaf.rc** (re-branding dari ShareLaTeX menjadi Overleaf) * `bin/run-script`: pembantu untuk menyederhanakan menjalankan skrip yang disimpan di dalam **sharelatex** kontainer * `bin/upgrade`: membantu peningkatan instans. Skrip akan memeriksa pembaruan Toolkit (melalui git) dan menawarkan untuk menarik perubahan, memeriksa versi image Docker terbaru dan menawarkan untuk memperbaruinya. Skrip ini menyediakan konfirmasi langkah demi langkah, opsi untuk mencadangkan konfigurasi saat ini, dan menangani penghentian/penyalaan layanan Docker. Lihat Meningkatkan deployment Anda untuk informasi lebih lanjut: {% hint style="info" %} Jika Anda lebih suka menjalankan instans tanpa terhubung ke log Docker, Anda dapat menjalankan `bin/up -d` untuk berjalan dalam mode terlepas. {% endhint %} #### Memeriksa server Anda Overleaf Toolkit menyertakan skrip praktis bernama `bin/doctor` yang menghasilkan laporan yang menunjukkan setiap dependensi yang belum terpenuhi. Sebelum melanjutkan, jalankan `bin/doctor` skrip dan periksa bahwa semuanya berfungsi dengan benar: {% code title="Jalankan Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Contoh output (dipotong/bersifat ilustratif):
Contoh output dari bin/doctor ``` ====== Overleaf Doctor ====== - Informasi Host - Linux - Output dari 'lsb_release -a': Tidak ada modul LSB yang tersedia. ID Distributor: Ubuntu Deskripsi: Ubuntu 22.04.5 LTS Rilis: 22.04 Nama kode: jammy - Dependensi - bash - status: ada - info versi: 5.1.16(1)-release - docker - status: ada - info versi: Docker version 27.3.1, build ce12230 - realpath - status: ada - info versi: realpath (GNU coreutils) 8.32 - perl - status: ada - info versi: 5.034000 - awk - status: ada - info versi: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - status: ada - info versi: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022) - docker compose - status: ada - info versi: Docker Compose version v2.29.7 - Docker Daemon - status: aktif ====== Konfigurasi ====== - config/version - status: ada - versi: 5.1.1 - config/overleaf.rc - status: ada - nilai - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - sudah login ke quay.io: true - SIBLING_CONTAINERS_ENABLED: true - OVERLEAF_LISTEN_IP: 0.0.0.0 - OVERLEAF_PORT: 80 - MONGO_ENABLED: true - MONGO_IMAGE: mongo - MONGO_VERSION: 6.0 - MONGO_DATA_PATH: data/mongo - REDIS_ENABLED: true - REDIS_IMAGE: redis:6.2 - REDIS_DATA_PATH: data/redis - config/variables.env - status: ada - nilai - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Peringatan ====== - Tidak ada, semua baik ====== Selesai ====== ```
Jika ada dependensi yang hilang, doctor akan mencetak peringatan. Jika Anda mengalami masalah, pertama jalankan `bin/doctor` dan periksa outputnya untuk peringatan. {% hint style="info" %} * Pengguna Community Edition gratis harus membuka issue di GitHub: * Pengguna Server Pro harus menghubungi dukungan: mailto: Dalam kedua kasus, sertakan output dari `bin/doctor` dalam pesan Anda. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://overleaf-pro.ayaka.space/on-premises/id/memulai/what-is-the-overleaf-toolkit.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.