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

<Info>
  Ten dokument opisuje konfigurację S3 w Server CE i Ayakaleaf Pro. Migrację istniejących danych do pamięci zgodnej z S3 opisuje [osobny przewodnik](/pl/on-premises/maintenance/s3-migration).
</Info>

<Warning>
  Czy dane przechowywane w S3 są szyfrowane, jeśli wdrożysz Ayakaleaf Pro z włączoną pamięcią [s3.md](/pl/on-premises/configuration/overleaf-toolkit/s3 "mention")?

  *<strong>Nie.</strong>* Dane nie są szyfrowane. Wszystkie fragmenty historii, pliki szablonów, pliki PDF i inne pliki są przechowywane jako zwykły tekst. Jeśli korzystasz z zewnętrznego dostawcy pamięci S3, zwróć szczególną uwagę na bezpieczeństwo i prywatność danych.
</Warning>

## Kiedy warto rozważyć użycie S3 do przechowywania danych

W przypadku instancji z mniej niż 1000 stanowisk zalecamy korzystanie z lokalnej pamięci dyskowej wraz z regularnymi [spójnymi kopiami zapasowymi](https://docs.overleaf.com/on-premises/maintenance/data-and-backups#performing-a-consistent-backup).

W przypadku większych instancji z ponad 1000 stanowisk, które osiągają limity lokalnej pamięci (rozmiaru lub przepustowości), zalecamy użycie backendu w postaci obiektowej pamięci masowej zgodnej z S3 zamiast innych sieciowych rozwiązań pamięci masowej, takich jak NFS.

## Opcje obiektowej pamięci masowej zgodnej z S3

Oto najpopularniejsze opcje obiektowej pamięci masowej zgodnej z S3:

* [AWS S3](https://aws.amazon.com/s3/), usługa zarządzana — sugerujemy wybór AWS S3, jeśli uruchamiasz Overleaf CE/Server Pro w AWS
* [MINIO](https://min.io/), hostowana samodzielnie
* [Ceph](https://ceph.io/en/), hostowana samodzielnie
* Inni dostawcy hostingu również oferują jakąś formę zarządzanej obiektowej pamięci masowej zgodnej z S3 — jeśli już uruchamiasz Overleaf CE/Server Pro u takiego dostawcy, możesz z niej skorzystać zamiast utrzymywać własną.

## Opóźnienia przy wyborze obiektowej pamięci masowej zgodnej z S3

Opóźnienie między instancją Server CE/Server Pro a obiektową pamięcią masową zgodną z S3 ma duży wpływ na czas trwania migracji. Opóźnienie wpływa również na wydajność przesyłania plików w Server CE/Server Pro, a powolne pobieranie plików może znacząco wydłużyć czas kompilacji PDF. Zalecamy minimalizowanie odległości geograficznej między instancją Server CE/Server Pro a obiektową pamięcią masową zgodną z S3. W środowisku zarządzanym oznacza to utworzenie bucketu w tym samym regionie, a w przypadku rozwiązania on-premise — uruchomienie obu w tym samym kampusie.

## Konfiguracja S3

Potrzebujemy czterech "bucketów" i dwóch kont użytkowników z ograniczonymi uprawnieniami. `overleaf-user-files` i `OVERLEAF_FILESTORE_USER_FILES_BUCKET_NAME` są potrzebne tylko w wersjach sprzed v6.

<Warning>
  Buckety **nie** powinny być publicznie dostępne
</Warning>

<div style={{ overflowX: "auto" }}><table style={{ display: "table", width: "100%" }}><thead><tr><th width="279" /><th width="152" /><th width="97" /><th /></tr></thead><tbody><tr><td>Bucket</td><td>Zastosowanie</td><td>Usługa</td><td>Wcześniej w `/var/lib/overleaf/data`</td></tr><tr><td>`overleaf-user-files`</td><td>pliki użytkowników w projektach</td><td>filestore</td><td>`user_files`</td></tr><tr><td>`overleaf-template-files`</td><td>pliki szablonów</td><td>filestore</td><td>`template_files`</td></tr><tr><td>`overleaf-project-blobs`</td><td>bloby historii projektów</td><td>history i filestore tylko do odczytu</td><td>`history/overleaf-project-blobs`</td></tr><tr><td>`overleaf-chunks`</td><td>fragmenty historii</td><td>history</td><td>`history/overleaf-chunks`</td></tr></tbody></table></div>

Możesz chcieć (lub musieć) wybrać inne nazwy — pamiętaj wtedy, aby używać własnych bucketów we wszystkich poleceniach.

W dalszej części zamiast rzeczywistych danych uwierzytelniających używane są symbole zastępcze:

<div style={{ overflowX: "auto" }}><table style={{ display: "table", width: "100%" }}><thead><tr><th width="431">Zmienna środowiskowa</th><th>Opis</th></tr></thead><tbody><tr><td>`OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID`</td><td>Klucz dostępu / nazwa użytkownika z ograniczonymi uprawnieniami dla usługi filestore.</td></tr><tr><td>`OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY`</td><td>Klucz tajny / hasło użytkownika z ograniczonymi uprawnieniami dla usługi filestore.</td></tr><tr><td>`OVERLEAF_HISTORY_S3_ACCESS_KEY_ID`</td><td>Klucz dostępu / nazwa użytkownika z ograniczonymi uprawnieniami dla usługi history.</td></tr><tr><td>`OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY`</td><td>Klucz tajny / hasło użytkownika z ograniczonymi uprawnieniami dla usługi history.</td></tr></tbody></table></div>

Server CE i Server Pro potrzebują jedynie niewielkiego zestawu uprawnień do każdego bucketu:

* tworzenie obiektów
* pobieranie obiektów
* usuwanie obiektów
* wyświetlanie zawartości bucketu

### Zasady dostępu

Oto jak może wyglądać zasada dla użytkownika filestore:

```json theme={null}
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "s3:ListBucket"
      ],
      "Resource": "arn:aws:s3:::overleaf-user-files"
    },
    {
      "Effect": "Allow",
      "Action": [
        "s3:PutObject",
        "s3:GetObject",
        "s3:DeleteObject"
      ],
      "Resource": "arn:aws:s3:::overleaf-user-files/*"
    },
    {
      "Effect": "Allow",
      "Action": [
        "s3:GetObject"
      ],
      "Resource": "arn:aws:s3:::overleaf-project-blobs/*"
    },
    {
      "Effect": "Allow",
      "Action": [
        "s3:ListBucket"
      ],
      "Resource": "arn:aws:s3:::overleaf-template-files"
    },
    {
      "Effect": "Allow",
      "Action": [
        "s3:PutObject",
        "s3:GetObject",
        "s3:DeleteObject"
      ],
      "Resource": "arn:aws:s3:::overleaf-template-files/*"
    }
  ]
}
```

Oto jak może wyglądać zasada dla użytkownika history:

```json theme={null}
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "s3:ListBucket"
      ],
      "Resource": "arn:aws:s3:::overleaf-project-blobs"
    },
    {
      "Effect": "Allow",
      "Action": [
        "s3:PutObject",
        "s3:GetObject",
        "s3:DeleteObject"
      ],
      "Resource": "arn:aws:s3:::overleaf-project-blobs/*"
    },
    {
      "Effect": "Allow",
      "Action": [
        "s3:ListBucket"
      ],
      "Resource": "arn:aws:s3:::overleaf-chunks"
    },
    {
      "Effect": "Allow",
      "Action": [
        "s3:PutObject",
        "s3:GetObject",
        "s3:DeleteObject"
      ],
      "Resource": "arn:aws:s3:::overleaf-chunks/*"
    }
  ]
}
```

### Przegląd zmiennych

#### W przypadku AWS S3

```bash theme={null}
# Enable S3 backend for filestore
OVERLEAF_FILESTORE_BACKEND=s3

# Bucket name for project files
OVERLEAF_FILESTORE_USER_FILES_BUCKET_NAME=overleaf-user-files

# Bucket name for template files
OVERLEAF_FILESTORE_TEMPLATE_FILES_BUCKET_NAME=overleaf-template-files

# Key for filestore user
OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID=...

# Secret for filestore user
OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY=...

# Bucket region you picked when creating the buckets.
OVERLEAF_FILESTORE_S3_REGION=""

# Enable S3 backend for history
OVERLEAF_HISTORY_BACKEND=s3

# Bucket name for project history blobs
OVERLEAF_HISTORY_PROJECT_BLOBS_BUCKET=overleaf-project-blobs

# Bucket name for history chunks
OVERLEAF_HISTORY_CHUNKS_BUCKET=overleaf-chunks

# Key for history user
OVERLEAF_HISTORY_S3_ACCESS_KEY_ID=...

# Secret for history user
OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY=...

# Bucket region you picked when creating the buckets.
OVERLEAF_HISTORY_S3_REGION=""
```

#### W przypadku opcji hostowanej samodzielnie

```bash theme={null}
# Enable S3 backend for filestore
OVERLEAF_FILESTORE_BACKEND=s3

# Bucket name for project files
OVERLEAF_FILESTORE_USER_FILES_BUCKET_NAME=overleaf-user-files

# Bucket name for template files
OVERLEAF_FILESTORE_TEMPLATE_FILES_BUCKET_NAME=overleaf-template-files

# Key for filestore user
OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID=...

# Secret for filestore user
OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY=...

# S3 provider endpoint
OVERLEAF_FILESTORE_S3_ENDPOINT=http://10.10.10.10:9000

# Path style addressing of buckets. Most likely you need to set this to "true".
OVERLEAF_FILESTORE_S3_PATH_STYLE="true"

# Bucket region. Most likely you do not need to configure this.
OVERLEAF_FILESTORE_S3_REGION=""

# Enable S3 backend for history
OVERLEAF_HISTORY_BACKEND=s3

# Bucket name for project history blobs
OVERLEAF_HISTORY_PROJECT_BLOBS_BUCKET=overleaf-project-blobs

# Bucket name for history chunks
OVERLEAF_HISTORY_CHUNKS_BUCKET=overleaf-chunks

# Key for history user
OVERLEAF_HISTORY_S3_ACCESS_KEY_ID=...

# Secret for history user
OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY=...

# S3 provider endpoint
OVERLEAF_HISTORY_S3_ENDPOINT=http://10.10.10.10:9000

# Path style addressing of buckets. Most likely you need to set this to "true".
OVERLEAF_HISTORY_S3_PATH_STYLE="true"

# Bucket region. Most likely you do not need to configure this.
OVERLEAF_HISTORY_S3_REGION=""
```

### Konfiguracja MINIO

<Info>
  `MINIO_ROOT_USER` i `MINIO_ROOT_PASSWORD` to dane uwierzytelniające użytkownika root instancji MINIO.
</Info>

Aby uzyskać `mc`, postępuj zgodnie z [oficjalną dokumentacją](https://min.io/docs/minio/linux/reference/minio-mc.html#quickstart).

```bash theme={null}
mc alias set s3 http://10.10.10.10:9000 MINIO_ROOT_USER MINIO_ROOT_PASSWORD

# Put the contents of the policies from the previous section in the
# respective json file policy-filestore.json and policy-history.json.

# Reminder: Replace the bucket names and credentials accordingly.

# filestore buckets, user and policy
mc mb --ignore-existing s3/overleaf-user-files
mc mb --ignore-existing s3/overleaf-template-files
mc admin user add s3 \
  OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID \
  OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY
mc admin policy create s3 overleaf-filestore policy-filestore.json
mc admin policy attach s3 overleaf-filestore \
  --user=OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID

# history buckets, user and policy
mc mb --ignore-existing s3/overleaf-project-blobs
mc mb --ignore-existing s3/overleaf-chunks
mc admin user add s3 \
  OVERLEAF_HISTORY_S3_ACCESS_KEY_ID \
  OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY
mc admin policy create s3 overleaf-history policy-history.json
mc admin policy attach s3 overleaf-history \
  --user=OVERLEAF_HISTORY_S3_ACCESS_KEY_ID
```


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