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

> Gem projektfiler og historik i S3-kompatibel lagring i en Kubernetes-installation.

Projektfiler og deres historik gemmes af **history-v1**-tjenesten, skabelonfiler af **filestore**-tjenesten, begge i hver Ayakaleaf Pro-pod. Som standard skriver de til datavolumet; med S3 skriver de til buckets. Hvilke buckets og tilladelser der kræves, er beskrevet under [S3](https://ayakaleaf-pro.mintlify.site/da/on-premises/configuration/overleaf-toolkit/s3.md).

| | |
| - | - |
| Tjenester | history-v1 (projektfiler og historik), filestore (skabelonfiler), i hver Ayakaleaf Pro-pod |
| Pod → S3 | S3-endpointet, for hver fil, der læses eller skrives |
| Påkrævet | for [flere replikaer](https://ayakaleaf-pro.mintlify.site/da/on-premises/configuration/kubernetes/horizontal-scaling.md): deres datavolumes deles ikke, det gør buckets |
| Periodiske job | ingen |

> [!WARNING]
>
> Vælg S3, før brugerne opretter projekter. En instans, der allerede gemmer filer på sit volume, skal først gennem [S3-migreringen](https://ayakaleaf-pro.mintlify.site/da/on-premises/maintenance/s3-migration.md).

### Konfiguration

**1. Buckets og nøgler**

Opret de tre buckets `overleaf-template-files`, `overleaf-project-blobs` og `overleaf-chunks` og de to begrænsede brugere med din S3-tjeneste som beskrevet under [Opsætning af S3](https://ayakaleaf-pro.mintlify.site/da/on-premises/configuration/overleaf-toolkit/s3.md#s3-setup), eller kør Garage i clusteret som vist nedenfor. Læg de fire nøgler i et 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. Tilføj Secret'et til poden, og genstart**

Tilføj Secret'et ved siden af de andre i Deployment'et (eller StatefulSet'et):

```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 i clusteret

Uden en S3-tjeneste er [Garage](https://garagehq.deuxfleurs.fr/) en lille S3-server, der kører i clusteret. Opsætningen under [Horisontal skalering](https://ayakaleaf-pro.mintlify.site/da/on-premises/configuration/kubernetes/horizontal-scaling.md) blev testet med den. Kommandoerne nedenfor genererer selv nøglerne og opretter Secret'et `overleaf-s3`, så brug dem i stedet for Secret-kommandoen i trin 1.

> [!NOTE]
>
> MinIO, som bruges i Overleafs eksempel, udgiver ikke længere container-images: `minio/minio` er fjernet fra Docker Hub og 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
```

Generér secrets, start Garage, og opret derefter layoutet, buckets og de to begrænsede nøgler. Garage-nøgle-ID'er er `GK` plus 24 hex-tegn, secrets er 64 hex-tegn:

```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
```

Tilladelserne svarer til politikkerne under [S3](https://ayakaleaf-pro.mintlify.site/da/on-premises/configuration/overleaf-toolkit/s3.md#access-policies). Garage kontrollerer regionen: den er `garage` her, og `OVERLEAF_*_S3_REGION` skal være den samme.

Med Garage skal du sætte endpointet, `PATH_STYLE: "true"` og regionen `garage` for begge tjenester i ConfigMap'et, som i `60-config.yaml` under [Horisontal skalering](https://ayakaleaf-pro.mintlify.site/da/on-premises/configuration/kubernetes/horizontal-scaling.md).

### Flere replikaer

Alle replikaer skal bruge de samme buckets og nøgler. Sikkerhedskopiér buckets med din S3-udbyders værktøjer; replikaernes egne diske indeholder så ingen data, der skal sikkerhedskopieres.

### Testet på Kubernetes

På Kubernetes 1.37 med tre replikaer og Garage som ovenfor bestod alle end-to-end-tests på disse sider, der opretter projekter, uploader filer, bruger historikken eller udgiver skabeloner, og bagefter indeholdt buckets `overleaf-project-blobs`, `overleaf-chunks` og `overleaf-template-files` objekterne, mens replikaernes egen `/var/lib/overleaf/data/history` forblev tom.


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