ストレージエンジン：S3 (Pro)

File storage: S3(Pro)Professional Edition+

はじめに

ファイル管理プラグインを基盤として、S3プロトコル互換のファイルストレージタイプが新たに追加されました。Amazon S3、Aliyun OSS、Tencent COS、MinIO、Cloudflare R2など、S3プロトコルをサポートするあらゆるオブジェクトストレージサービスを簡単に連携でき、ストレージサービスの互換性と柔軟性がさらに向上します。

機能

クライアントサイドアップロード：ファイルアップロードプロセスはNocoBaseサーバーを経由せず、ファイルストレージサービスに直接接続するため、より効率的で高速なアップロード体験を実現します。
プライベートアクセス：デフォルトでは有効期限付きの署名 URL を使用します。公開 Bucket 向けに署名なし URL を生成することもできます。

ユースケース

ファイルコレクション管理：アップロードされたすべてのファイルを一元的に管理・保存し、多様なファイルタイプと保存方法をサポートすることで、ファイルの分類と検索を容易にします。
添付ファイルフィールドストレージ：フォームやレコードにアップロードされる添付ファイルのデータストレージとして利用され、特定のデータレコードとの関連付けをサポートします。

プラグイン設定

plugin-file-storage-s3-pro プラグインを有効にします。
「Setting」->「FileManager」をクリックし、ファイル管理設定画面に進みます。
「Add new」ボタンをクリックし、「S3 Pro」を選択します。

ポップアップが表示されたら、多くの入力項目があるフォームが表示されます。対応するファイルサービスに関するパラメータ情報は、後続のドキュメントを参照し、フォームに正しく入力してください。

URL 設定

S3 Pro では、ファイル管理の共通オプションである「NocoBase URL」「元の URL」「公開アクセスを許可」に加えて、アップロード URL とアクセス URL の形式、および署名付き URL を使用するかどうかを個別に設定できます。共通オプションについては、ストレージエンジンの概要を参照してください。

各オプションは異なる段階を制御します。

「NocoBase URL / 元の URL」は、ファイルレコードが返すアドレスを制御します
「公開アクセスを許可」は、NocoBase URL へのアクセス時にファイルレコードの閲覧権限をチェックするかどうかを制御します
「署名付き URL を使用しない」は、オブジェクトストレージが URL の署名を検証するかどうかを制御します

これらの設定は独立して組み合わせられます。デフォルトでは、NocoBase URL を使用し、「公開アクセスを許可」をチェックせず、署名付き URL を有効にしておくことを推奨します。

S3 Pro の URL 設定

選択方法

ユースケース	ファイル URL	公開アクセスを許可	署名付き URL を使用しない
Bucket を非公開のまま、ファイルにロール権限とデータ権限を適用する	NocoBase URL	チェックしない	チェックしない
Bucket を非公開のまま、公開用の NocoBase ファイルアドレスを提供する	NocoBase URL	チェックする	チェックしない
外部サービスがストレージアドレスへ一時的にアクセスする	元の URL	該当なし	チェックせず、Access URL expiration を設定する
公開 Bucket または CDN で署名なしの元のアドレスを使用する	元の URL	該当なし	チェックする

アップロード URL 形式

「アップロード URL 形式」は、クライアントがファイルをアップロードするときに使用する S3 URL を制御します。ストレージサービスがサポートする形式を選択してください。設定フォームには、現在の Endpoint、Bucket、パスに基づく例が表示されます。

「Bucket as subdomain」：https://bucket-name.s3.example.com/path/to/object
「Bucket as subpath」：https://s3.example.com/bucket-name/path/to/object
「Ignore bucket」：https://upload.example.com/path/to/object

アクセス URL 形式

「アクセス URL 形式」は、S3 Pro がファイルアクセスアドレスを生成するときに、Bucket をドメインに含めるか、パスに含めるか、URL に含めないかを制御します。アップロード URL と同じ 3 つの形式がありますが、個別に設定できます。たとえば、アップロードには S3 Endpoint を使用し、アクセスには Bucket を含まない CDN ドメインを使用できます。

このオプションは、元の URL と、NocoBase URL が最終的にリダイレクトするストレージアドレスに影響します。ただし、NocoBase URL 自体の形式は変わりません。

署名付き URL を使用しない

S3 Pro はデフォルトで署名付き URL を使用します。生成された元の URL には、次のような署名パラメータが含まれます。

https://bucket-name.s3.example.com/path/to/object?X-Amz-Signature=xxxx

署名付き URL は「Access URL expiration」で設定した期間だけ有効で、Bucket は非公開のままにできます。NocoBase URL を使用する場合、権限チェックに成功した後で、NocoBase が署名付きアドレスを生成するか、そのアドレスへリダイレクトします。

「署名付き URL を使用しない」をチェックすると、S3 Pro は署名パラメータのないアドレスを生成します。この場合、Bucket とアップロードされたオブジェクトで公開読み取りを許可する必要があり、「Access URL expiration」は適用されません。

「署名付き URL を使用しない」は、ストレージサービスによる署名検証だけを制御し、NocoBase のファイルレコード権限は変更しません。NocoBase URL を選択し、「公開アクセスを許可」をチェックしていない場合、リクエストは引き続き先に NocoBase の権限チェックを通過する必要があります。

サービスプロバイダー設定

Amazon S3

バケットの作成

https://ap-southeast-1.console.aws.amazon.com/s3/home を開いてS3コンソールにアクセスします。
右側の「Create bucket」ボタンをクリックします。

バケット名を入力します。その他のフィールドはデフォルト設定のままで構いません。ページ下部までスクロールし、「Create」ボタンをクリックして作成を完了します。

CORS設定

バケットリストに移動し、先ほど作成したバケットを見つけてクリックし、詳細ページに進みます。

「Permission」タブをクリックし、下にスクロールしてCORS設定セクションを見つけます。

以下の設定を入力し（必要に応じて詳細な設定も可能です）、保存します。

[
    {
        "AllowedHeaders": [
            "*"
        ],
        "AllowedMethods": [
            "POST",
            "PUT"
        ],
        "AllowedOrigins": [
            "*"
        ],
        "ExposeHeaders": [
            "ETag"
        ],
        "MaxAgeSeconds": 3000
    }
]

AccessKey、SecretAccessKey の取得

ページ右上の「Security credentials」ボタンをクリックします。

下にスクロールして「Access Keys」セクションを見つけ、「Create Access Key」ボタンをクリックします。

同意をクリックします（これはルートアカウントでのデモンストレーションです。本番環境ではIAMを使用することをお勧めします）。

ページに表示されるAccess keyとSecret access keyを保存します。

パラメータの取得と設定

AccessKey IDとAccessKey Secretは、前の手順で取得した値です。正確に入力してください。
バケット詳細ページの「Properties」パネルに移動すると、バケット名とリージョン（Region）情報を取得できます。

署名なしの公開アクセス（オプション）

署名なし URL が必要な場合にのみ設定してください。Bucket とアップロードされたオブジェクトで公開読み取りを許可する必要があります。公開用の NocoBase URL だけが必要な場合は、「公開アクセスを許可」をチェックして署名付き URL を使い続ければ、Bucket を公開する必要はありません。

「Permissions」パネルに移動し、「Object Ownership」までスクロールして「編集」をクリックし、ACLsを有効にします。

「Block public access」までスクロールし、「編集」をクリックして、ACLsによる制御を許可するように設定します。

NocoBase で「署名付き URL を使用しない」にチェックを入れます。

サムネイル設定（オプション）

この設定はオプションであり、画像のプレビューサイズや効果を最適化する場合に利用します。このデプロイソリューションは追加費用が発生する可能性がありますのでご注意ください。具体的な費用については、AWSの関連規約をご参照ください。

Dynamic Image Transformation for Amazon CloudFront にアクセスします。
ページ下部の Launch in the AWS Console ボタンをクリックし、ソリューションのデプロイを開始します。
プロンプトに従って設定を完了します。以下のオプションには特に注意してください。
1. スタックを作成する際、ソース画像を含むAmazon S3バケット名を指定する必要があります。以前に作成したバケット名を入力してください。
2. デモUIのデプロイを選択した場合、デプロイ完了後にこのインターフェースを通じて画像処理機能をテストできます。AWS CloudFormationコンソールでスタックを選択し、「出力」タブに移動してDemoUrlキーに対応する値を見つけ、そのリンクをクリックしてデモインターフェースを開きます。
3. このソリューションは、sharp Node.jsライブラリを使用して画像を効率的に処理します。GitHubリポジトリからソースコードをダウンロードし、必要に応じてカスタマイズできます。
設定が完了したら、デプロイステータスが CREATE_COMPLETE になるまで待ちます。
NocoBaseの設定には、いくつかの注意点があります。
1. Thumbnail rule：画像処理に関連するパラメータ（例： ?width=100）を入力します。詳細は AWSドキュメントをご参照ください。
2. Access endpoint：デプロイ後のOutputs -> ApiEndpointの値を入力します。
3. 「アクセス URL 形式」：Bucket 名はすでに設定に含まれており、アクセス URL には不要なため、「Ignore bucket」を選択します。

設定例