Skip to content

Commit 52e3150

Browse files
committed
[Doc] Update vitepress, add autoupdate doc to Lagrange.Doc.OneBot
1 parent 6f4ef87 commit 52e3150

File tree

5 files changed

+1073
-590
lines changed

5 files changed

+1073
-590
lines changed

docs/.vitepress/catalogue.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,10 @@ export const oneBotSidebar = {
142142
text: "生成配置文件",
143143
link: "https://lagrangedev.github.io/lagrange-config-generator/",
144144
},
145+
{
146+
text: "自动更新",
147+
link: "/Lagrange.OneBot/AutoUpdate/",
148+
},
145149
{
146150
text: 'Apifox 上的 API 文档',
147151
link: 'https://lagrange-onebot.apifox.cn/',

docs/.vitepress/nav.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ export const oneBotNav = {
4949
text: "生成配置文件",
5050
link: "https://lagrangedev.github.io/lagrange-config-generator/",
5151
},
52+
{
53+
text: "自动更新",
54+
link: "/Lagrange.OneBot/AutoUpdate/",
55+
},
5256
{
5357
text: 'Apifox',
5458
link: 'https://lagrange-onebot.apifox.cn/',
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# 自动更新
2+
3+
[#810](https://github.com/LagrangeDev/Lagrange.Core/commit/7ce94a451347e893a60d347ae38270180b61805f)以来,Lagrange.OneBot已实装了自动从GitHub Releases更新的功能, 该功能会在启动时检查更新, 如果有新版本, 会自动下载并替换当前版本.
4+
默认情况下, 自动更新功能是关闭的, 你可以在配置文件中设置`EnableAutoUpdate``true`来启用它.
5+
6+
## 配置文件
7+
8+
每次启动时,如果当前目录不存在AutoUpdaterConfig.json文件, Lagrange会在当前目录下创建一个json文件, 你可以在其中设置自动更新的相关配置.
9+
10+
```json
11+
{
12+
"EnableAutoUpdate": false, // 启用自动更新
13+
"CheckInterval": 360, // 每360s检查一次更新,单位为秒
14+
"ProxyUrl": "", //访问Github的代理地址, 为空则不使用代理,和SignServer的ProxyUrl一样只接受http协议
15+
"LastUpdateTime": "2025-04-24T17:00:00Z" //由程序自动生成的上次更新时间, 一般情况下请勿修改
16+
}
17+
```
18+
19+
::: warning 注意
20+
21+
`//` 开头的为注释, 试图复制粘贴到实际的配置文件中时务必删除
22+
23+
:::
24+
25+
## Tips
26+
- 如果你在使用自动更新功能时遇到问题, 请检查你的网络连接和代理设置.
27+
- 更新的配置文件不支持热重载, 你需要重启Lagrange才能使更改生效.
28+
- 更新下载完毕后会自动强制重启Lagrange. 此举可能导致Docker容器内的Lagrange无法正常重启, 丢失生命周期等, 在Dockerfile中添加`--restart=always`参数可能可以解决该问题.
29+
- MacOS更新完毕需要手动信任新的二进制文件.
30+
- 更新的临时文件放置在系统Temp目录下Lagrange.OneBot.AutoUpdate中, 你可以在更新完成后手动删除, 在每次自动更新后会自动删除上一次的更新文件.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"private": false,
99
"devDependencies": {
1010
"prettier": "^3.3.3",
11-
"vitepress": "^1.0.0-rc.29",
11+
"vitepress": "^1.6.3",
1212
"vue": "^3.3.8"
1313
},
1414
"scripts": {

0 commit comments

Comments
 (0)