-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add plugin-file-storage-s3-pro doc (#256)
* feat: add s3 pro doc * fix: replace img to docs.nocobase.com * fix: adjust dir and replace imgs
- Loading branch information
Showing
4 changed files
with
690 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,216 @@ | ||
| # File Storage: S3 (Pro) | ||
|
|
||
| <PluginInfo commercial="true" name="file-storage-s3-pro"></PluginInfo> | ||
|
|
||
| ## Introduction | ||
|
|
||
| Building on the file management plugin, this version adds support for file storage types compatible with the S3 protocol. Any object storage service supporting the S3 protocol can be seamlessly integrated, such as Amazon S3, Alibaba Cloud OSS, Tencent Cloud COS, MinIO, Cloudflare R2, etc., enhancing the compatibility and flexibility of storage services. | ||
|
|
||
| ## Features | ||
|
|
||
| 1. **Client Upload:** Files are uploaded directly to the storage service without passing through the NocoBase server, enabling a more efficient and faster upload experience. | ||
|
|
||
| 2. **Private Access:** All file URLs are signed temporary authorization addresses, ensuring secure and time-limited access to files. | ||
|
|
||
| ## Use Cases | ||
|
|
||
| 1. **File Table Management:** Centrally manage and store all uploaded files, supporting various file types and storage methods for easy classification and retrieval. | ||
|
|
||
| 2. **Attachment Field Storage:** Store attachments uploaded via forms or records and associate them with specific data entries. | ||
|
|
||
| ## Plugin Configuration | ||
|
|
||
| 1. Enable the `plugin-file-storage-s3-pro` plugin. | ||
|
|
||
| 2. Navigate to "Setting -> FileManager" to access the file management settings. | ||
|
|
||
| 3. Click the "Add new" button and select "S3 Pro". | ||
|
|
||
|  | ||
|
|
||
| 4. In the pop-up window, you will see a detailed form to fill out. Refer to the following documentation to obtain the relevant parameters for your file service and correctly input them into the form. | ||
|
|
||
|  | ||
|
|
||
| ## Service Provider Configuration | ||
|
|
||
| ### Amazon S3 | ||
|
|
||
| #### Bucket Creation | ||
|
|
||
| 1. Visit [Amazon S3 Console](https://ap-southeast-1.console.aws.amazon.com/s3/home). | ||
|
|
||
| 2. Click the "Create bucket" button on the right-hand side. | ||
|
|
||
|  | ||
|
|
||
| 3. Fill in the `Bucket Name`, leave other fields as default, scroll to the bottom, and click the **"Create"** button to complete the process. | ||
|
|
||
|  | ||
|
|
||
| #### CORS Configuration | ||
|
|
||
| 1. In the bucket list, find and click the newly created bucket to access its details. | ||
|
|
||
|  | ||
|
|
||
| 2. Navigate to the "Permission" tab and scroll down to the CORS configuration section. | ||
|
|
||
|  | ||
|
|
||
| 3. Enter the following configuration (customize as needed) and save. | ||
|
|
||
| ```Bash | ||
| [ | ||
| { | ||
| "AllowedHeaders": [ | ||
| "*" | ||
| ], | ||
| "AllowedMethods": [ | ||
| "POST", | ||
| "PUT" | ||
| ], | ||
| "AllowedOrigins": [ | ||
| "*" | ||
| ], | ||
| "ExposeHeaders": [ | ||
| "ETag" | ||
| ], | ||
| "MaxAgeSeconds": 3000 | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| #### AccessKey and SecretAccessKey Retrieval | ||
|
|
||
| 1. Click the "Security credentials" button in the top-right corner. | ||
|
|
||
|  | ||
|
|
||
| 2. Scroll to the "Access Keys" section and click "Create Access Key." | ||
|
|
||
|  | ||
|
|
||
| 3. Agree to the terms (IAM usage is recommended for production environments). | ||
|
|
||
|  | ||
|
|
||
| 4. Save the displayed Access Key and Secret Access Key. | ||
|
|
||
|  | ||
|
|
||
| #### Parameter Retrieval and Configuration | ||
|
|
||
| 1. Use the retrieved `AccessKey ID` and `AccessKey Secret`. | ||
|
|
||
| 2. Visit the bucket's properties panel to find the `Bucket Name` and `Region`. | ||
|
|
||
|  | ||
|
|
||
| #### Public Access (Optional) | ||
|
|
||
| For public file access, configure as follows: | ||
|
|
||
| 1. In the Permissions panel, scroll to "Object Ownership," click "Edit," and enable ACLs. | ||
|
|
||
|  | ||
|
|
||
| 2. Scroll to "Block public access," click "Edit," and allow ACL control. | ||
|
|
||
|  | ||
|
|
||
| 3. Check "Public access" in NocoBase. | ||
|
|
||
|  | ||
|
|
||
| ### Alibaba Cloud OSS | ||
|
|
||
| #### Bucket Creation | ||
|
|
||
| 1. Open the [OSS Console](https://oss.console.aliyun.com/overview). | ||
|
|
||
|  | ||
|
|
||
| 2. Select "Buckets" from the left menu and click "Create Bucket." | ||
|
|
||
|  | ||
|
|
||
| 3. Fill in the bucket details and click "Create." | ||
|
|
||
| - `Bucket Name`: Choose based on your business needs. | ||
| - `Region`: Select the nearest region for your users. | ||
| - Other settings can remain default or customized as needed. | ||
|
|
||
|  | ||
|
|
||
| #### CORS Configuration | ||
|
|
||
| 1. Navigate to the bucket details page. | ||
|
|
||
|  | ||
|
|
||
| 2. Click "Content Security -> CORS" in the menu. | ||
|
|
||
|  | ||
|
|
||
| 3. Click "Create Rule," complete the fields, and click "OK." | ||
|
|
||
|  | ||
|
|
||
| #### AccessKey and SecretAccessKey Retrieval | ||
|
|
||
| 1. Click "AccessKey" under your account avatar. | ||
|
|
||
|  | ||
|
|
||
| 2. Create an AccessKey. For production, refer to the [RAM AccessKey Guide](https://help.aliyun.com/zh/ram/user-guide/create-an-accesskey-pair-1?spm=5176.28366559.0.0.1b5c3c2fUI9Ql8#section-rjh-18m-7kp). | ||
|
|
||
|  | ||
|
|
||
| 3. Complete account verification. | ||
|
|
||
|  | ||
|
|
||
| 4. Save the Access Key and Secret Access Key. | ||
|
|
||
|  | ||
|
|
||
| #### Parameter Retrieval and Configuration (To Be Updated) | ||
|
|
||
| 1. Use the retrieved `AccessKey ID` and `AccessKey Secret`. | ||
|
|
||
| 2. Access the bucket details to retrieve the `Bucket Name`. | ||
|
|
||
|  | ||
|
|
||
| 3. Scroll down to find the `Region` (omit `.aliyuncs.com`). | ||
|
|
||
|  | ||
|
|
||
| 4. Retrieve the `Endpoint` and add `https://` as a prefix. | ||
|
|
||
|  | ||
|
|
||
| ### Tencent COS | ||
|
|
||
| Refer to the configurations above. The process is largely similar. | ||
|
|
||
| ### MinIO | ||
|
|
||
| For MinIO, note the following: | ||
|
|
||
| 1. MinIO deployments lack the `Region` concept. Set this to "auto." | ||
|
|
||
| 2. Use the deployment's domain or IP address for the `Endpoint`. | ||
|
|
||
| 3. Ensure `Force path style` is set to `Path-Style`, resulting in file URLs like `https://serverAddress/bucket-name/fileKey`. | ||
|
|
||
| ### Cloudflare R2 | ||
|
|
||
| Refer to the configurations above. | ||
|
|
||
| ## User Guide | ||
|
|
||
| Refer to the [file-manager plugin documentation](https://docs.nocobase.com/handbook/file-manager/). |
Oops, something went wrong.