Webhooks 通知设置
此页面记录了配置 Webhook 服务作为 Bucket Notifications 的目标的服务设置。 有关使用这些设置的教程,请参阅 将事件发布至Webhook 。
您可以通过定义以下内容来建立或修改设置:
在启动或重新启动 MinIO 服务器之前,在宿主系统上定义一个 环境变量。 请参阅您的操作系统的文档,了解如何定义环境变量。
使用
mc admin config set
命令来设置一个 配置项。使用 MinIO控制台 的 管理员 > 设置 页面来设置一个 配置项。
如果您同时定义了环境变量和类似的配置设置,MinIO 将使用环境变量的值。
有些设置只有环境变量或配置设置,而不是两者都有。
重要
每个配置设置都控制着MinIO的基本行为和功能。 MinIO 强烈建议 在较低的环境中,如DEV或QA,测试配置更改,然后再将其应用到生产环境中。
多个 Webhook 服务目标
您可以通过在顶级键后附加每个相关 Webhook 设置集的唯一标识符 _ID
来指定多个 Webhook 服务端点。
例如,以下命令分别将两个不同的 Webhook 服务端点设置为 PRIMARY
和 SECONDARY
:
export MINIO_NOTIFY_WEBHOOK_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_WEBHOOK_ENDPOINT_PRIMARY="https://webhook1.example.net"
export MINIO_NOTIFY_WEBHOOK_ENABLE_SECONDARY="on"
export MINIO_NOTIFY_WEBHOOK_ENDPOINT_SECONDARY="https://webhook1.example.net"
mc admin config set notify_webhook:primary \
endpoint="https://webhook1.example.net"
[ARGUMENT=VALUE ...]
mc admin config set notify_webhook:secondary \
endpoint="https://webhook2.example.net
[ARGUMENT=VALUE ...]
设置
Enable
必需的
用于定义与 MinIO 存储桶通知 一起使用的 Webhook 服务端点的顶级配置键。
使用 mc admin config set
命令来设置或更新一个 Webhook 服务端点。
对于每个目标,endpoint
参数是 必需 的。
指定额外的可选参数作为一个由空格分隔的列表( " "
)。
mc admin config set notify_webhook \
endpoint="https://webhook.example.net"
[ARGUMENT="VALUE"] ... \
端点
必需的
指定 Webhook 服务的 URL。
在 RELEASE.2023-05-27T05-56-19Z 版本发生变更: 在添加目标之前,MinIO会检查指定URL的健康状况(如果其能被解析并可以访问)。 如果现有目标离线,MinIO不再阻止添加新的通知目标。
身份验证令牌
必需的
一个适合端点的适当类型的身份验证令牌。 对于不需要身份验证的端点,请省略。
为了适应各种令牌类型,MinIO 会使用与指定 完全相同 的值来创建请求身份验证头。 根据端点的不同,你可能需要包含额外的信息。
例如,对于不记名令牌,请在前面添加 Bearer
:
export MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_myendpoint="Bearer 1a2b3c4f5e"
根据端点要求修改值。 自定义身份验证格式可能类似于以下形式:
export MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_xyz="ServiceXYZ 1a2b3c4f5e"
查阅所需服务的文档以获取更多详细信息。
- notify_webhook auth_token
适合端点的适当类型的认证令牌。 对于不需要认证的端点,请省略。
为了支持多种令牌类型,MinIO 使用与指定 完全相同 的值来创建请求认证头。 根据端点的不同,您可能需要包含额外的信息。
例如,对于不记名令牌,请在前面添加
Bearer
:mc admin config set myminio notify_webhook \ endpoint="https://webhook-1.example.net" \ auth_token="Bearer 1a2b3c4f5e"
根据端点要求修改该值。 自定义身份验证格式可能类似于以下内容:
mc admin config set myminio notify_webhook \ endpoint="https://webhook-1.example.net" \ auth_token="ServiceXYZ 1a2b3c4f5e"
请查阅所需服务的文档以获取更多详细信息。
在 RELEASE.2023-06-23T20-26-00Z 版本发生变更.
当作为
mc admin config get
命令的一部分返回时,MinIO 会删除这个值。
队列目录
可选
指定目录路径以启用MinIO的持久化事件存储,例如 /opt/minio/events
。
当webhook服务离线时,MinIO将未投递的事件存储在指定的存储中,并在连接恢复时重新播放存储的事件。
队列限制
可选
指定未发送消息的最大限制。
默认为 100000
。
客户证书
可选
指定客户端证书的路径,以用于对webhook服务执行mTLS身份验证。
客户端密钥
可选
指定客户端私钥的路径,以用于对webhook服务执行mTLS身份验证。