From 403d17ab433c45095afb8c060dcb79ad402cf717 Mon Sep 17 00:00:00 2001 From: hackallan Date: Wed, 11 Oct 2023 22:27:10 +0800 Subject: [PATCH] [Improve] Improve lark alarm docs (#273) * Add flying book alarm information --------- Co-authored-by: qinjiyong --- docs/development/alert-conf.md | 7 ++++--- .../current/development/alert-conf.md | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/development/alert-conf.md b/docs/development/alert-conf.md index a7bd6ef1f..b0680357c 100644 --- a/docs/development/alert-conf.md +++ b/docs/development/alert-conf.md @@ -104,9 +104,10 @@ Then, Enter robot `Lark Tokens` and other configurations, click `Submit`. **Configuration description：** -1. `Lark Token`：`Required`.1. It is the default address of the group robot, intercept the content behind `/hook/`. -2. `At All User`：`optional` .2.After it is turned on, the alarm message will be @ everyone in the group. -3. `Secret Enable`：`optional` .3.If `encryption signature verification` is enabled, the `Secret Token` signature verification key information needs to be configured. +1. `streampark.proxy.lark-url`：We need to add the `streampark.proxy.lark-url` property to the configuration file. Example: yaml file adds streampark.proxy.lark-url: https://open.feishu.cn . +2. `Lark Token`：`Required`.1. It is the default address of the group robot, intercept the content behind `/hook/`. +3. `At All User`：`optional` .2.After it is turned on, the alarm message will be @ everyone in the group. +4. `Secret Enable`：`optional` .3.If `encryption signature verification` is enabled, the `Secret Token` signature verification key information needs to be configured. :::info Lark robot application Please refer to the [official Lark official](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bot-v3/bot-overview ) for robot application and configuration diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/alert-conf.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/alert-conf.md index 7bc99e51a..96182e154 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/alert-conf.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/alert-conf.md @@ -94,9 +94,10 @@ import TabItem from '@theme/TabItem'; **配置项说明：** -1. `Lark Token`：`必填项`。为群机器人默认地址，截取 `/hook/` 后面内容。 -2. `At All User`：选填项 。开启后，报警消息会@群内所有人。 -3. `Secret Enable`：选填项 。如果开启机器人请求 `加密验签`，则需要配置，并且需要配置 `Lark Secret Token` 验签密钥信息。 +1. `streampark.proxy.lark-url`：添加 `streampark.proxy.lark-url`属性到配置文件中，例：在yaml文件中添加 streampark.proxy.lark-url: https://open.feishu.cn 。 +2. `Lark Token`：`必填项`。为群机器人默认地址，截取 `/hook/` 后面内容。 +3. `At All User`：选填项 。开启后，报警消息会@群内所有人。 +4. `Secret Enable`：选填项 。如果开启机器人请求 `加密验签`，则需要配置，并且需要配置 `Lark Secret Token` 验签密钥信息。 :::info 飞书群机器人申请 请参考 `飞书官方文档` https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bot-v3/bot-overview 进行机器人申请和配置