From 42a69442e4c2e7674c0aa4ca04d74da873abec75 Mon Sep 17 00:00:00 2001 From: icey-yu <1186114839@qq.com> Date: Tue, 24 Dec 2024 18:22:26 +0800 Subject: [PATCH] feat: doc --- docs/restapi/commonConfigs.mdx | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/restapi/commonConfigs.mdx b/docs/restapi/commonConfigs.mdx index ea1e140558..6eb759d433 100644 --- a/docs/restapi/commonConfigs.mdx +++ b/docs/restapi/commonConfigs.mdx @@ -14,6 +14,10 @@ title: 常用配置项修改说明 | `tokenPolicy.expire` | `openim-rpc-auth.yml` | token 过期时间设置 | expire 的单位为天，默认为 90 | | `friendVerify` | `openim-rpc-msg.yml` | 发送消息是否需要好友关系 | 默认为 false | | `enableHistoryForNewMembers` | `openim-rpc-group.yml` | 新入群用户是否可以查看历史消息 | 默认为 true | +| `remainLogLevel` | `log.yml` | 日志级别 | 6：带有调试信息的详细日志，建议开发环境使用；4：info及关键日志，建议生产环境使用； | +| `externalAddress` | `minio.yml` | minio外部访问地址 | | +| `url` | `webhook.yml` | webhook访问地址 | | +| `enable` | `openim-push.yml` | 离线推送配置 | 可选择`geTui`/`fcm`/`jpush`。具体参考[离线推送](#离线推送)。若不填写则不启用离线推送。 | | `object` | `openim-rpc-third.yml` | 选择不同的对象存储 | 参考 [Object](#object) | @@ -35,3 +39,23 @@ title: 常用配置项修改说明 | `publicRead` | 存储桶是否公开读取 | 需要填写存储桶是否公开读取（默认为 false） | | `secretID` | 腾讯云访问密钥 ID | 需要填写腾讯云访问密钥 ID | | `secretKey` | 腾讯云访问密钥 Secret | 需要填写腾讯云访问密钥 Secret | + +## 离线推送 + +| **配置选项** | **说明** | +| ------------------ | ------------------------------------------------------------ | +| **getui** | **个推（geTUi）推送配置相关参数** | +| getui.pushUrl | 个推 API 端点 URL，通常格式为 `https://restapi.getui.com/v2/{appId}`，用于发送推送请求。 | +| getui.masterSecret | 个推提供的主密钥，用于认证 API 请求，确保请求的合法性和安全性。 | +| getui.appKey | 个推分配的应用密钥，用于标识具体的应用程序。 | +| getui.intent | 个推推送通知的意图（Intent），用于定义推送通知的行为或动作。 | +| getui.channelID | 个推用于分类推送通知的渠道 ID，有助于管理和组织不同类型的推送消息。 | +| getui.channelName | 个推用于推送通知的渠道名称，便于识别和管理不同的推送渠道。 | +| **fcm** | **Firebase Cloud Messaging（FCM）推送配置相关参数** | +| fcm.filePath | FCM 配置文件的路径。优先使用文件路径，如果此项为空，则使用 `authURL`。文件路径为通过 `-c` 参数传入的路径的相对路径。建议将配置文件（假设为`fcm.json`）放入`config`目录下并将该项填写为`fcm.json`。 | +| fcm.authURL | FCM 的认证 URL，必须以 `https://` 或 `http://` 开头，用于通过 URL 方式进行认证。 | +| **jpush** | **极光推送（JPush）推送配置相关参数** | +| jpush.appKey | 极光推送分配的应用密钥，用于标识具体的应用程序并进行认证。 | +| jpush.masterSecret | 极光推送提供的主密钥，用于认证 API 请求，确保请求的合法性和安全性。 | +| jpush.pushURL | 极光推送的 API 端点 URL，用于发送推送请求到极光服务器。 | +| jpush.pushIntent | 极光推送通知的意图（Intent），用于定义推送通知的行为或动作。 |