plugin-s3

为 Halo 2.0 提供 S3 协议的对象存储策略，支持阿里云、腾讯云、七牛云等兼容 S3 协议的对象存储服务商

使用方法

1. 下载，目前提供以下两个下载方式：
   • GitHub Releases：访问 Releases 下载 Assets 中的 JAR 文件。
   • Halo 应用市场：https://halo.run/store/apps/app-Qxhpp
2. 安装，插件安装和更新方式可参考：https://docs.halo.run/user-guide/plugins
3. 进入后台附件管理。
4. 点击右上角的存储策略，在存储策略弹框的右上角可新建 S3 Object Storage 存储策略。
5. 创建完成之后即可在上传的时候选择新创建的 S3 Object Storage 存储策略。

配置指南

Endpoint 访问风格

请根据下方表格中的兼容访问风格选择，若您的服务商不在表格中，请自行查看服务商的 s3 兼容性文档或自行尝试。

风格说明：
当Endpoint填写s3.example.com时
Path Style：SDK将访问s3.example.com/<bucket-name>/<object-key>
Virtual Hosted Style：SDK将访问<bucket-name>.s3.example.com/<object-key>

Endpoint

此处统一填写不带 bucket-name 的 Endpoint，SDK 会自动处理访问风格。

想了解 s3 协议的 Endpoint 的配置可在服务商的文档中搜索 s3、Endpoint 或访问域名等关键词，一般与服务商自己的 Endpoint 相同。

例如百度云提供 s3.bj.bcebos.com 和 <bucket-name>.s3.bj.bcebos.com 两种 Endpoint，请填写s3.bj.bcebos.com。

Access Key & Access Secret

与服务商自己 API 的 Access Key 和 Access Secret 相同，详情查看对应服务商的文档。

Bucket 桶名称

一般与服务商控制台中的空间名称一致。

注意部分服务商 s3 空间名 ≠ 空间名称，若出现“Access Denied”报错可检查 Bucket 是否正确。

可通过 S3Browser 查看桶列表，七牛云也可在“开发者平台-对象存储-空间概览-s3域名”中查看 s3 空间名。

Region

一般留空即可。

若确认过其他配置正确又不能访问，请在服务商的文档中查看并填写英文的 Region，例如 cn-east-1。

Cloudflare 需要填写均为小写字母的 auto。

部分对象存储服务商兼容性

服务商	文档	兼容访问风格	兼容性
阿里云	https://help.aliyun.com/document_detail/410748.html	Virtual Hosted Style	✅
腾讯云	https://cloud.tencent.com/document/product/436/41284	Virtual Hosted Style / Path Style	✅
七牛云	https://developer.qiniu.com/kodo/4088/s3-access-domainname	Virtual Hosted Style / Path Style	✅
百度云	https://cloud.baidu.com/doc/BOS/s/Fjwvyq9xo	Virtual Hosted Style / Path Style	✅
京东云	https://docs.jdcloud.com/cn/object-storage-service/api/regions-and-endpoints	Virtual Hosted Style	✅
金山云	https://docs.ksyun.com/documents/6761	Virtual Hosted Style	✅
青云	https://docsv3.qingcloud.com/storage/object-storage/s3/intro/	Virtual Hosted Style / Path Style	✅
网易数帆	https://sf.163.com/help/documents/89796157866430464	Virtual Hosted Style	✅
Cloudflare	Cloudflare S3 兼容性API https://developers.cloudflare.com/r2/data-access/s3-api/	Virtual Hosted Style / Path Style	✅
Oracle Cloud	https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm	Virtual Hosted Style / Path Style	✅
自建minio	-	Path Style	✅
华为云	文档未说明是否兼容，工单反馈不保证兼容性，实际测试可以使用	Virtual Hosted Style	❓
Ucloud	只支持 8MB 大小的分片，本插件暂不支持 https://docs.ucloud.cn/ufile/s3/s3_introduction	-	❌
又拍云	暂不支持 s3 协议	-	❌

开发环境

./gradlew build

修改 Halo 的配置文件

plugin:
  runtime-mode: development # development, deployment
  classes-directories:
    - "build/classes"
    - "build/resources"
  lib-directories:
    - "libs"
  fixedPluginPath:
    - "path/to/plugin-s3"

启动 Halo 之后即可在后台插件管理看到此插件。

生产构建

./gradlew build

构建完成之后，可以在 build/libs 目录得到插件的 JAR 包，在 Halo 后台的插件管理上传即可。