> ## 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.

# S3

> Simpan file proyek dan riwayatnya di penyimpanan yang kompatibel dengan S3 pada deployment Kubernetes.

File proyek dan riwayatnya disimpan oleh layanan **history-v1**, file template oleh layanan **filestore**, keduanya di dalam setiap pod Ayakaleaf Pro. Secara default keduanya menulis ke volume data; dengan S3 keduanya menulis ke bucket. Bucket dan izin apa saja yang diperlukan dijelaskan di [S3](https://ayakaleaf-pro.mintlify.site/id/on-premises/configuration/overleaf-toolkit/s3.md).

| | |
| - | - |
| Layanan | history-v1 (file proyek dan riwayat), filestore (file template), di setiap pod Ayakaleaf Pro |
| Pod → S3 | endpoint S3, untuk setiap file yang dibaca atau ditulis |
| Wajib | untuk [beberapa replika](https://ayakaleaf-pro.mintlify.site/id/on-premises/configuration/kubernetes/horizontal-scaling.md): volume data mereka tidak dibagi, sedangkan bucket dibagi |
| Tugas berkala | tidak ada |

> [!WARNING]
>
> Pilih S3 sebelum pengguna membuat proyek. Instance yang sudah menyimpan file di volumenya memerlukan [migrasi S3](https://ayakaleaf-pro.mintlify.site/id/on-premises/maintenance/s3-migration.md) terlebih dahulu.

### Konfigurasi

**1. Bucket dan kunci**

Buat tiga bucket `overleaf-template-files`, `overleaf-project-blobs`, dan `overleaf-chunks` serta dua pengguna terbatas dengan layanan S3 Anda seperti dijelaskan di [Penyiapan S3](https://ayakaleaf-pro.mintlify.site/id/on-premises/configuration/overleaf-toolkit/s3.md#s3-setup), atau jalankan Garage di klaster seperti ditunjukkan di bawah. Masukkan keempat kunci ke dalam sebuah Secret:

```bash wrap theme={null}
kubectl -n overleaf create secret generic overleaf-s3 \
  --from-literal=OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID=<filestore key> \
  --from-literal=OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY=<filestore secret> \
  --from-literal=OVERLEAF_HISTORY_S3_ACCESS_KEY_ID=<history key> \
  --from-literal=OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY=<history secret>
```

**2. ConfigMap**

```yaml title="30-config.yaml (additions)" wrap theme={null}
  OVERLEAF_FILESTORE_BACKEND: s3
  OVERLEAF_FILESTORE_TEMPLATE_FILES_BUCKET_NAME: overleaf-template-files
  OVERLEAF_FILESTORE_S3_REGION: eu-west-1
  OVERLEAF_HISTORY_BACKEND: s3
  OVERLEAF_HISTORY_PROJECT_BLOBS_BUCKET: overleaf-project-blobs
  OVERLEAF_HISTORY_CHUNKS_BUCKET: overleaf-chunks
  OVERLEAF_HISTORY_S3_REGION: eu-west-1
  # a self-hosted S3 service also needs its endpoint and path-style addressing
  # OVERLEAF_FILESTORE_S3_ENDPOINT: http://garage:3900
  # OVERLEAF_FILESTORE_S3_PATH_STYLE: "true"
  # OVERLEAF_HISTORY_S3_ENDPOINT: http://garage:3900
  # OVERLEAF_HISTORY_S3_PATH_STYLE: "true"
```

**3. Tambahkan Secret ke pod dan mulai ulang**

Di Deployment (atau StatefulSet), tambahkan Secret di samping yang lainnya:

```yaml theme={null}
          envFrom:
            - configMapRef: {name: overleaf-env}
            - secretRef: {name: overleaf-secrets}
            - secretRef: {name: overleaf-s3}
```

```bash theme={null}
kubectl apply -f 30-config.yaml -f 40-overleaf.yaml
kubectl -n overleaf rollout restart deployment/overleaf     # or statefulset/overleaf
```

### Garage di klaster

Tanpa layanan S3, [Garage](https://garagehq.deuxfleurs.fr/) adalah server S3 kecil yang berjalan di klaster. Penyiapan [Penskalaan horizontal](https://ayakaleaf-pro.mintlify.site/id/on-premises/configuration/kubernetes/horizontal-scaling.md) diuji dengannya. Perintah-perintah di bawah ini membuat kunci dan Secret `overleaf-s3` sendiri, jadi gunakan perintah ini sebagai ganti perintah Secret di langkah 1.

> [!NOTE]
>
> MinIO, yang digunakan dalam contoh Overleaf, tidak lagi menerbitkan image kontainer: `minio/minio` sudah tidak ada di Docker Hub dan quay.io.

```yaml title="50-garage.yaml" wrap theme={null}
apiVersion: v1
kind: ConfigMap
metadata:
  name: garage-config
  namespace: overleaf
data:
  garage.toml: |
    metadata_dir = "/var/lib/garage/meta"
    data_dir = "/var/lib/garage/data"
    db_engine = "lmdb"
    replication_factor = 1
    rpc_bind_addr = "[::]:3901"
    rpc_public_addr = "127.0.0.1:3901"
    # rpc_secret and admin_token come from GARAGE_RPC_SECRET / GARAGE_ADMIN_TOKEN
    [s3_api]
    s3_region = "garage"          # Overleaf's OVERLEAF_*_S3_REGION must match
    api_bind_addr = "[::]:3900"
    [admin]
    api_bind_addr = "[::]:3903"
---
apiVersion: v1
kind: Service
metadata:
  name: garage
  namespace: overleaf
spec:
  selector:
    app: garage
  ports:
    - name: s3
      port: 3900
---
apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: garage
  namespace: overleaf
spec:
  serviceName: garage
  replicas: 1
  selector:
    matchLabels:
      app: garage
  template:
    metadata:
      labels:
        app: garage
    spec:
      containers:
        - name: garage
          image: dxflrs/garage:v2.5.0
          env:
            - name: GARAGE_RPC_SECRET
              valueFrom: {secretKeyRef: {name: garage-secrets, key: rpc_secret}}
            - name: GARAGE_ADMIN_TOKEN
              valueFrom: {secretKeyRef: {name: garage-secrets, key: admin_token}}
          ports:
            - containerPort: 3900
          readinessProbe:
            tcpSocket:
              port: 3900
          resources:
            requests: {cpu: 50m, memory: 64Mi}
            limits: {memory: 512Mi}
          volumeMounts:
            - {name: config, mountPath: /etc/garage.toml, subPath: garage.toml}
            - {name: data, mountPath: /var/lib/garage}
      volumes:
        - name: config
          configMap:
            name: garage-config
  volumeClaimTemplates:
    - metadata:
        name: data
      spec:
        accessModes: [ReadWriteOnce]
        resources:
          requests:
            storage: 10Gi
```

Buat secret, jalankan Garage, lalu buat layout, bucket, dan dua kunci terbatas. ID kunci Garage adalah `GK` ditambah 24 karakter heksadesimal, secret-nya 64 karakter heksadesimal:

```bash wrap theme={null}
kubectl -n overleaf create secret generic garage-secrets \
  --from-literal=rpc_secret="$(openssl rand -hex 32)" \
  --from-literal=admin_token="$(openssl rand -base64 32)"
kubectl -n overleaf create secret generic overleaf-s3 \
  --from-literal=OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID="GK$(openssl rand -hex 12)" \
  --from-literal=OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY="$(openssl rand -hex 32)" \
  --from-literal=OVERLEAF_HISTORY_S3_ACCESS_KEY_ID="GK$(openssl rand -hex 12)" \
  --from-literal=OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY="$(openssl rand -hex 32)"
kubectl apply -f 50-garage.yaml
kubectl -n overleaf rollout status statefulset/garage

g() { kubectl -n overleaf exec garage-0 -- /garage "$@"; }
s() { kubectl -n overleaf get secret overleaf-s3 -o jsonpath="{.data.$1}" | base64 -d; }
g layout assign -z dc1 -c 8G "$(g status 2>/dev/null | awk '/^[0-9a-f]{16}/{print $1; exit}')"
g layout apply --version 1
for b in overleaf-template-files overleaf-project-blobs overleaf-chunks; do g bucket create "$b"; done
g key import --yes -n overleaf-filestore "$(s OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID)" "$(s OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY)"
g key import --yes -n overleaf-history "$(s OVERLEAF_HISTORY_S3_ACCESS_KEY_ID)" "$(s OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY)"
g bucket allow --read --write overleaf-template-files --key overleaf-filestore
g bucket allow --read overleaf-project-blobs --key overleaf-filestore
g bucket allow --read --write overleaf-project-blobs --key overleaf-history
g bucket allow --read --write overleaf-chunks --key overleaf-history
```

Izin-izin tersebut sesuai dengan kebijakan di [S3](https://ayakaleaf-pro.mintlify.site/id/on-premises/configuration/overleaf-toolkit/s3.md#access-policies). Garage memeriksa region: di sini nilainya `garage`, dan `OVERLEAF_*_S3_REGION` harus sama.

Dengan Garage, atur endpoint, `PATH_STYLE: "true"`, dan region `garage` untuk kedua layanan di ConfigMap, seperti di `60-config.yaml` dari [Penskalaan horizontal](https://ayakaleaf-pro.mintlify.site/id/on-premises/configuration/kubernetes/horizontal-scaling.md).

### Beberapa replika

Semua replika harus menggunakan bucket dan kunci yang sama. Cadangkan bucket dengan alat dari penyedia S3 Anda; disk milik replika sendiri kemudian tidak menyimpan data yang perlu dicadangkan.

### Diuji di Kubernetes

Di Kubernetes 1.37 dengan tiga replika dan Garage seperti di atas, setiap pengujian end-to-end di halaman-halaman ini yang membuat proyek, mengunggah file, menggunakan riwayat, atau menerbitkan template lulus, dan setelahnya bucket `overleaf-project-blobs`, `overleaf-chunks`, dan `overleaf-template-files` berisi objek-objek tersebut, sementara `/var/lib/overleaf/data/history` milik replika sendiri tetap kosong.


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