Skip to content
This repository has been archived by the owner on Aug 2, 2020. It is now read-only.

Commit

Permalink
Update docs for v4.12.3
Browse files Browse the repository at this point in the history
  • Loading branch information
stdrc committed Nov 16, 2019
1 parent 06c6fa8 commit a990a16
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/4.12/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ port = 5701
| `secret` || 上报数据签名密钥,如果不为空,则会在 HTTP 上报时对 HTTP 正文进行 HMAC SHA1 哈希,使用 `secret` 的值作为密钥,计算出的哈希值放在上报的 `X-Signature` 请求头,例如 `X-Signature: sha1=f9ddd4863ace61e64f462d41ca311e3d2c1176e2` |
| `post_message_format` | `string` | 上报消息格式,`string` 为字符串格式,`array` 为数组格式,具体见 [消息格式](/Message) |
| `serve_data_files` | `false` | 是否提供请求 `data` 目录的文件的功能 |
| `update_source` | `github` | 更新源,默认使用托管在 GitHub 的 [richardchien/coolq-http-api-release](https://github.com/richardchien/coolq-http-api-release) 仓库,对于 酷Q 运行在国内的情况,可以换成 `coding` `china` |
| `update_source` | v4.12.3 之前 `github`<br>v4.12.3 及之后 `china` | 更新源,可选 `global`/`github` `china`/`coding` |
| `update_channel` | `stable` | 更新通道,目前有 `stable``beta``alpha` 三个 |
| `auto_check_update` | `false` | 是否自动检查更新(每次启用插件时检查),不启用的情况下,仍然可以在 酷Q 应用菜单中手动检查更新 |
| `auto_perform_update` | `false` | 是否自动执行更新,仅在 `auto_check_update` 启用时有效,若启用,则插件将在自动检查到更新后,自动下载新版本(需要手动重启 酷Q 以生效) |
Expand Down Expand Up @@ -142,13 +142,15 @@ port = 5701

```json
{
"update_source": "github",
"update_source": "china",
"update_channel": "stable",
"auto_check_update": true,
"auto_perform_update": true
}
```

现不再支持自动更新后自动重启 酷Q,需手动重载应用以生效。

### 生产环境

```json
Expand Down
1 change: 1 addition & 0 deletions docs/4.12/Post.md
Original file line number Diff line number Diff line change
Expand Up @@ -408,5 +408,6 @@ ctx.assert(ctx.request.headers['x-signature'] === `sha1=${sig}`, 403);
| `post_type` | string | `meta_event` | 上报类型 |
| `meta_event_type` | string | `heartbeat` | 元事件类型 |
| `status` | object | - | 状态信息 |
| `interval` | number (int64) | - | 到下次心跳的间隔,单位毫秒 |

其中 `status` 字段的内容和 [`get_status` 接口的响应数据](/API#响应数据27) 相同。

0 comments on commit a990a16

Please sign in to comment.