> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 2. Kenali Toolkit

### Melihat-lihat

Setelah Anda memiliki salinan lokal Toolkit, mari kita lihat struktur repositori menggunakan perintah `ls`.

```bash title="Run this" theme={null}
ls -l
```

> [!NOTE]
>
> Perintah `ls -l` menampilkan daftar panjang yang terperinci dari isi sebuah direktori, beserta informasi file tambahan seperti izin, kepemilikan, dan ukuran.

Jika semuanya berhasil di-clone, Anda akan melihat sesuatu seperti ini:

```text theme={null}
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md
```

> [!NOTE]
>
> Semua file konfigurasi milik pengguna berada di direktori `config/`. Direktori ini **dikecualikan** dari sistem kontrol revisi git, sehingga tidak akan berubah saat Toolkit diperbarui.

## Tata letak repositori

| Nama | Deskripsi |
| - | - |
| `bin` | Folder ini berisi kumpulan skrip yang membantu Anda mengelola instans server Overleaf Anda. Anda dapat membaca lebih lanjut tentang skrip-skrip ini di bagian Perintah di bawah. |
| `config` | Folder ini berisi file konfigurasi lokal Anda sendiri. |
| `lib` | Folder ini berisi file konfigurasi dasar yang digunakan oleh Toolkit. |
| `data` | Secara default, folder ini berisi lokasi penyimpanan untuk MongoDb, Redis, dan Overleaf. Untuk informasi lebih lanjut, lihat bagian [Data persisten](https://ayakaleaf-pro.mintlify.site/id/on-premises/configuration/overleaf-toolkit/files-and-locations.md#persistent-data) di bawah. |

> [!WARNING]
>
> Kami menyarankan untuk **tidak** mengubah file di luar folder `/config` secara langsung. Sebagai gantinya, jika Anda perlu melakukan perubahan, perubahan tersebut dapat dilakukan melalui variabel lingkungan yang diatur di **config/variables.env** atau **config/overleaf.rc**.\
> Misalnya, untuk mengatur image layanan `mongo`, alih-alih mengedit `lib/docker-compose.mongo.yml` secara langsung, atur image menggunakan variabel lingkungan `MONGO_IMAGE` di `config/overleaf.rc`. Untuk informasi lebih lanjut, lihat halaman [Pengaturan Toolkit](https://ayakaleaf-pro.mintlify.site/id/on-premises/configuration/overleaf-toolkit/toolkit-settings.md).

> [!NOTE]
>
> Toolkit **tidak** akan mengubah data apa pun di direktori `config/` tanpa izin Anda.

## Perintah

Jalankan skrip-skrip ini dari direktori Toolkit. Setiap skrip menampilkan opsinya dengan `--help`.

| Perintah | Fungsinya |
| - | - |
| `bin/init` | Membuat file konfigurasi di `config/` untuk pertama kalinya. `bin/init --tls` menambahkan konfigurasi NGINX TLS proxy. |
| `bin/up` | Membuat dan menjalankan kontainer (`bin/docker-compose up`). Tambahkan `-d` untuk menjalankannya di latar belakang alih-alih mengikuti log. Jalankan setelah setiap perubahan di `config/`: perintah ini membuat ulang kontainer yang konfigurasinya berubah. |
| `bin/start` | Menjalankan kembali kontainer yang sudah ada (`bin/docker-compose start`). Perintah ini tidak menerapkan perubahan konfigurasi. |
| `bin/stop` | Menghentikan kontainer dan tetap menyimpannya (`bin/docker-compose stop`). |
| `bin/docker-compose` | Menjalankan `docker compose` dengan file-file Toolkit, misalnya `bin/docker-compose ps` atau `bin/docker-compose restart sharelatex`. |
| `bin/logs` | Menampilkan atau mengikuti log dari satu atau beberapa layanan, misalnya `bin/logs -f web`. |
| `bin/error-logs` | Seperti `bin/logs`, tetapi hanya menampilkan error. |
| `bin/shell` | Membuka shell di dalam kontainer `sharelatex`. |
| `bin/mongo` | Membuka shell MongoDB pada database `sharelatex`. |
| `bin/run-script` | Menjalankan skrip yang disertakan di dalam kontainer `sharelatex`. |
| `bin/doctor` | Memeriksa host dan konfigurasi, lalu mencetak laporan untuk dibagikan saat Anda meminta bantuan. |
| `bin/images` | Menampilkan daftar image Docker Overleaf di host. |
| `bin/backup-config` | Menyalin direktori `config/` ke lokasi cadangan (copy, zip, atau tar). |
| `bin/upgrade` | Memperbarui Toolkit dan image Overleaf langkah demi langkah, lihat [Meningkatkan deployment Anda](https://ayakaleaf-pro.mintlify.site/id/on-premises/maintenance/upgrading-your-deployment.md). |
| `bin/rename-env-vars-5-0`, `bin/rename-rc-vars` | Migrasi sekali jalan untuk nama variabel lama `SHARELATEX_*` menjadi `OVERLEAF_*`. |

> [!WARNING]
>
> Saat `bin/up` membuat ulang sebuah kontainer, semua yang diubah di dalamnya akan hilang, misalnya paket yang diinstal atau file yang diedit melalui `bin/shell`. Hanya direktori data (`data/` secara default) dan `config/` yang dipertahankan. Lakukan perubahan permanen melalui `config/variables.env`, `config/overleaf.rc`, atau `config/docker-compose.override.yml`.

> [!NOTE]
>
> Jika setiap `bin/up` membuat semua pengguna logout, atur `OVERLEAF_SESSION_SECRET`. Tanpa variabel ini, cookie sesi ditandatangani dengan secret yang dibuat ulang setiap kali kontainer dibuat ulang, lihat Tanya Jawab di [Variabel Lingkungan](https://ayakaleaf-pro.mintlify.site/id/on-premises/configuration/overleaf-toolkit/environment-variables.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.