S3

このドキュメントは Server CE と Overleaf Pro における S3 の設定について説明します。A 別のガイド 既存データを S3 互換ストレージに移行する方法については見つけることができます。

データ保存に S3 を検討すべき場合

1000 未満のシート数のインスタンスには、定期的な 一貫したバックアップ.

を行うローカルディスクストレージの使用を推奨します。ローカルストレージ（容量やスループット）の限界に達するような 1000 を超える大規模なインスタンスには、NFS のような他のネットワークベースのストレージソリューションよりも S3 互換のオブジェクトストレージバックエンドの使用を推奨します。

S3 互換オブジェクトストレージのオプション

S3 互換オブジェクトストレージの最も一般的なオプションは次のとおりです：

• AWS S3、マネージド、Overleaf CE/Server Pro を AWS 上で運用する場合は AWS S3 を選択することをお勧めします

• MINIO、セルフホスト

• Ceph、セルフホスト

• 他のホスティングプロバイダも管理された S3 互換オブジェクトストレージを提供している場合があり、そのようなプロバイダ上で既に Overleaf CE/Server Pro を運用している場合は、自分で運用する代わりにそれらを利用することを検討してもよいでしょう。

S3 互換オブジェクトストレージを選ぶ際のレイテンシに関する考慮事項

Server CE/Server Pro インスタンスと S3 互換オブジェクトストレージ間のレイテンシは、移行完了にかかる時間に大きく影響します。レイテンシは Server CE/Server Pro のファイルアップロード性能にも影響し、ファイルのダウンロードが遅いと PDF コンパイル時間にも大きな影響を与える可能性があります。Server CE/Server Pro インスタンスと S3 互換オブジェクトストレージの地理的距離を最小限にすることをお勧めします。マネージド環境では同じリージョンにバケットをプロビジョニングすることを意味し、オンプレミスのソリューションでは同じキャンパス内で両者を稼働させることを意味します。

S3 の設定

4 つの「バケット」と 2 つの制限付きユーザーアカウントが必要です。

バケットは に 公開アクセスされてはいけません

バケット	用途	サービス	以前は /var/lib/overleaf/data
overleaf-user-files	プロジェクトのユーザーファイル	filestore	user_files
overleaf-template-files	テンプレートファイル	filestore	template_files
overleaf-project-blobs	プロジェクト履歴のブロブ	履歴および読み取り専用のファイルストア	history/overleaf-project-blobs
overleaf-chunks	履歴チャンク	履歴	history/overleaf-chunks

別の名前を選ぶ必要があるかもしれません。すべてのコマンドでカスタムバケットを使用するようにしてください。

以下では実際の認証情報のプレースホルダを使用します：

環境変数	説明
OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID	filestore サービス用の制限付きユーザーのアクセスキー／ユーザー名。
OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY	filestore サービス用の制限付きユーザーのシークレットキー／パスワード。
OVERLEAF_HISTORY_S3_ACCESS_KEY_ID	history サービス用の制限付きユーザーのアクセスキー／ユーザー名。
OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY	history サービス用の制限付きユーザーのシークレットキー／パスワード。

Server CE と Server Pro は各バケットに対して限られた権限のみを必要とします：

• オブジェクトの作成

• オブジェクトの取得

• オブジェクトの削除

• バケットの一覧表示

アクセスポリシー

filestore ユーザーのポリシーは次のようになる可能性があります：

{
  "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/*"
    }
  ]
}

history ユーザーのポリシーは次のようになる可能性があります：

{
  "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/*"
    }
  ]
}

変数の概要

AWS S3 を使用する場合

# filestore 用に S3 バックエンドを有効にする
OVERLEAF_FILESTORE_BACKEND=s3

# プロジェクトファイル用のバケット名
OVERLEAF_FILESTORE_USER_FILES_BUCKET_NAME=overleaf-user-files

# テンプレートファイル用のバケット名
OVERLEAF_FILESTORE_TEMPLATE_FILES_BUCKET_NAME=overleaf-template-files

# filestore ユーザーのキー
OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID=...

# filestore ユーザーのシークレット
OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY=...

# バケットを作成したときに選択したリージョン。
OVERLEAF_FILESTORE_S3_REGION=""

# history 用に S3 バックエンドを有効にする
OVERLEAF_HISTORY_BACKEND=s3

# プロジェクト履歴ブロブ用のバケット名
OVERLEAF_HISTORY_PROJECT_BLOBS_BUCKET=overleaf-project-blobs

# 履歴チャンク用のバケット名
OVERLEAF_HISTORY_CHUNKS_BUCKET=overleaf-chunks

# history ユーザーのキー
OVERLEAF_HISTORY_S3_ACCESS_KEY_ID=...

# history ユーザーのシークレット
OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY=...

# バケットを作成したときに選択したリージョン。
OVERLEAF_HISTORY_S3_REGION=""

セルフホストオプションを使用する場合

# filestore 用に S3 バックエンドを有効にする
OVERLEAF_FILESTORE_BACKEND=s3

# プロジェクトファイル用のバケット名
OVERLEAF_FILESTORE_USER_FILES_BUCKET_NAME=overleaf-user-files

# テンプレートファイル用のバケット名
OVERLEAF_FILESTORE_TEMPLATE_FILES_BUCKET_NAME=overleaf-template-files

# filestore ユーザーのキー
OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID=...

# filestore ユーザーのシークレット
OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY=...

# S3 プロバイダのエンドポイント
OVERLEAF_FILESTORE_S3_ENDPOINT=http://10.10.10.10:9000

# バケットのパススタイルアドレッシング。ほとんどの場合これを "true" に設定する必要があります。
OVERLEAF_FILESTORE_S3_PATH_STYLE="true"

# バケットのリージョン。多くの場合これを設定する必要はありません。
OVERLEAF_FILESTORE_S3_REGION=""

# history 用に S3 バックエンドを有効にする
OVERLEAF_HISTORY_BACKEND=s3

# プロジェクト履歴ブロブ用のバケット名
OVERLEAF_HISTORY_PROJECT_BLOBS_BUCKET=overleaf-project-blobs

# 履歴チャンク用のバケット名
OVERLEAF_HISTORY_CHUNKS_BUCKET=overleaf-chunks

# history ユーザーのキー
OVERLEAF_HISTORY_S3_ACCESS_KEY_ID=...

# history ユーザーのシークレット
OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY=...

# S3 プロバイダのエンドポイント
OVERLEAF_HISTORY_S3_ENDPOINT=http://10.10.10.10:9000

# バケットのパススタイルアドレッシング。ほとんどの場合これを "true" に設定する必要があります。
OVERLEAF_HISTORY_S3_PATH_STYLE="true"

# バケットのリージョン。多くの場合これを設定する必要はありません。
OVERLEAF_HISTORY_S3_REGION=""

MINIO の設定

MINIO_ROOT_USER と MINIO_ROOT_PASSWORD は MINIO インスタンスのルート認証情報です。

を参照してください 公式ドキュメント のコピーを取得するために mc.

mc alias set s3 http://10.10.10.10:9000 MINIO_ROOT_USER MINIO_ROOT_PASSWORD

# 前節のポリシーの内容をそれぞれの
# json ファイル policy-filestore.json および policy-history.json に入れてください。

# 注意：バケット名と認証情報を適切に置き換えてください。

# filestore バケット、ユーザーおよびポリシー
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 バケット、ユーザーおよびポリシー
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