File Storage: S3 (Pro)

Giới thiệu

Trên cơ sở plugin file management, hỗ trợ thêm kiểu file storage tương thích với giao thức S3. Bất kỳ dịch vụ object storage nào hỗ trợ giao thức S3 đều có thể dễ dàng tích hợp, ví dụ Amazon S3, Aliyun OSS, Tencent COS, MinIO, Cloudflare R2, v.v., nâng cao hơn nữa tính tương thích và linh hoạt của dịch vụ storage.

Đặc điểm chức năng

Upload phía client: Quá trình upload file không cần đi qua server NocoBase, kết nối trực tiếp với dịch vụ file storage, đem lại trải nghiệm upload hiệu quả và nhanh hơn.
Truy cập riêng tư: Khi truy cập file, tất cả URL đều là địa chỉ ủy quyền tạm thời được ký, đảm bảo tính bảo mật và thời hạn của việc truy cập file.

Tình huống sử dụng

Quản lý File Collection: Quản lý và lưu trữ tập trung tất cả file được upload, hỗ trợ nhiều kiểu file và cách lưu trữ, thuận tiện cho việc phân loại và tìm kiếm file.
Lưu trữ Field Attachment: Dùng để lưu trữ dữ liệu attachment được upload trong form hoặc bản ghi, hỗ trợ liên kết với bản ghi dữ liệu cụ thể.

Cấu hình Plugin

Bật plugin plugin-file-storage-s3-pro
Nhấn "Setting -> FileManager" để vào cài đặt File Manager
Nhấn nút "Add new", chọn "S3 Pro"

Sau khi popup hiện ra, bạn sẽ thấy nội dung form cần điền khá nhiều. Có thể tham khảo tài liệu sau, lấy thông tin tham số liên quan đến dịch vụ file tương ứng, và điền đúng vào form.

Cấu hình nhà cung cấp dịch vụ

Amazon S3

Tạo Bucket

Mở https://ap-southeast-1.console.aws.amazon.com/s3/home để vào S3 Console
Nhấn nút "Create bucket" bên phải

Điền Bucket Name (tên bucket), các field khác có thể giữ cài đặt mặc định, cuộn xuống cuối trang, nhấn nút "Create" để hoàn tất việc tạo.

Cấu hình CORS

Vào danh sách buckets, tìm và nhấn vào Bucket vừa tạo để vào trang chi tiết của nó

Nhấn tab "Permission", sau đó cuộn xuống tìm phần cấu hình CORS

Điền cấu hình sau (có thể tinh chỉnh chi tiết), và lưu

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

Lấy AccessKey, SecretAccessKey

Nhấn nút "Security credentials" ở góc trên bên phải trang

Cuộn xuống, tìm phần "Access Keys", nhấn nút "Create Access Key".

Nhấn Đồng ý (đây là demo cho main account, khuyến nghị sử dụng IAM trong môi trường chính thức).

Lưu Access key và Secret access key được hiển thị trên trang

Lấy và cấu hình tham số

AccessKey ID và AccessKey Secret là các giá trị tương ứng bạn đã lấy được trong bước trước, vui lòng điền chính xác
Vào panel properties của trang chi tiết bucket, bạn có thể lấy được thông tin Bucket name và Region.

Truy cập công khai (tùy chọn)

Đây là cấu hình không bắt buộc, hãy cấu hình khi bạn cần công khai hoàn toàn file đã upload

Vào panel Permissions, cuộn xuống Object Ownership, nhấn edit, bật ACLs

Cuộn đến Block public access, nhấn edit, đặt thành cho phép ACLs control

Trong NocoBase tích chọn Public access

Cấu hình Thumbnail (tùy chọn)

Cấu hình này là tùy chọn, dùng khi cần tối ưu kích thước hoặc hiệu ứng preview hình ảnh. Lưu ý, phương án triển khai này có thể phát sinh chi phí phụ, chi phí cụ thể vui lòng tham khảo các điều khoản liên quan của AWS.

Truy cập Dynamic Image Transformation for Amazon CloudFront.
Nhấn nút Launch in the AWS Console ở cuối trang, bắt đầu triển khai phương án.
Hoàn tất cấu hình theo hướng dẫn, các tùy chọn sau cần đặc biệt chú ý:
1. Khi tạo stack, bạn cần chỉ định một tên Amazon S3 bucket chứa hình ảnh nguồn. Vui lòng điền tên bucket bạn đã tạo trước đó.
2. Nếu bạn chọn triển khai demo UI, sau khi triển khai xong có thể test chức năng xử lý hình ảnh thông qua giao diện này. Trong AWS CloudFormation Console, chọn stack của bạn, vào tab "Outputs", tìm giá trị tương ứng với key DemoUrl, nhấn link đó để mở giao diện demo.
3. Phương án này sử dụng thư viện sharp Node.js để xử lý hình ảnh hiệu quả. Bạn có thể tải mã nguồn từ GitHub repo, tùy chỉnh theo nhu cầu.
Sau khi cấu hình xong, đợi trạng thái triển khai chuyển thành CREATE_COMPLETE là được.
Trong cấu hình NocoBase, có một số lưu ý sau:
1. Thumbnail rule: Điền tham số liên quan đến xử lý hình ảnh, ví dụ ?width=100. Cụ thể có thể tham khảo Tài liệu AWS.
2. Access endpoint: Điền giá trị Outputs -> ApiEndpoint sau khi triển khai.
3. Full access URL style: Cần tích chọn Ignore (vì đã điền tên bucket khi cấu hình, không cần khi truy cập).

Ví dụ cấu hình