diff --git a/docs/Lagrange.OneBot/Config/index.md b/docs/Lagrange.OneBot/Config/index.md
index 0d511cde..b04567a0 100644
--- a/docs/Lagrange.OneBot/Config/index.md
+++ b/docs/Lagrange.OneBot/Config/index.md
@@ -1,55 +1,80 @@
# 快速部署&配置
-Lagrange.OneBot.exe 会在第一次运行之后会自动生成默认配置的 appsettings.json
+## 下载安装
-
+下载 Lagrange.OneBot 可执行文件并解压。
-在配置文件按需要正确修改后,在命令行中按任意键,Lagrange 将正式运行。在同一文件夹下会出现一张登录二维码图片 qr-0.png,在二维码过期前尽快使用手机 QQ 扫码连接。
+1. 可以从 [Releases](https://github.com/LagrangeDev/Lagrange.Core/releases) 下载对应系统版本。
+2. 还可以从 [Actions](https://github.com/LagrangeDev/Lagrange.Core/actions) 中获得当前最新的构建。
+
+::: warning 注意
+
+从 Actions 下载的 Lagrange.OneBot 需要手动安装 .Net,你应当自行安装对应版本的 [.Net SDK](https://dotnet.microsoft.com/zh-cn/download)。
+
+:::
+
+## 运行
+
+::: code-group
+
+```text [Windows]
+双击 Lagrange.OneBot.exe 运行即可。
+```
+
+```shell [Linux/MacOS]
+# 可执行权限(可选)
+chmod +x ./Lagrange.OneBot
+# 运行
+./Lagrange.OneBot
+```
-::: tip 提示
-推荐勾选「下次登录无需确认」来简化登陆流程
:::
+第一次运行时,会在同级目录下自动生成默认的 `appsettings.json` 配置文件,你需要正确 [修改配置文件](#配置文件) 以设置 Lagrange。
+
+在配置文件按需修改后(推荐使用扫码登录),在命令行中按任意键,Lagrange 将正式运行。在同一文件夹下会出现一张登录二维码图片 qr-0.png,在二维码过期前尽快使用手机 QQ 扫码连接。
+
::: tip 提示
-NTQQ的SignServer不可与Android协议混用(如unidbg-fetch-qsign)
-本项目不主动提供SignServer 请前往README.md加入Telegram群聊以获取有效信息
+手机扫描登录二维码时,推荐勾选「下次登录无需确认」。
+
:::
-### 关于验证码
-::: warning 警告
-如果出现验证码登录的情况 推荐删除Keystore进行扫码登录
+::: danger Sign
+
+NTQQ 的 SignServer **不可与 Android 协议混用**。(如 unidbg-fetch-qsign)
+
+本项目不主动提供 SignServer,请前往 README.md 搜索加入 Telegram 群聊以获取有效信息。
-验证码登录因为未知原因成功率较低
:::
-NTQQ的验证码拥有两个参数 ticket与randomStr
-首先复制ticket参数到输入框内 按下回车确认
+如果出现验证码登录,见 [关于验证码](#关于验证码)。
-再次复制randomStr参数到输入框内 按下回车确认
+## 配置文件
-### 默认配置
-```json5
+请注意几个重要的设置项需要手动配置:
+
+```json5{9,11-12,20-37}
{
"Logging": {
"LogLevel": {
- "Default": "Information", # 提Issue时请切换到Trace
+ "Default": "Information", // 提Issue时请切换到Trace
"Microsoft": "Warning",
"Microsoft.Hosting.Lifetime": "Information",
},
},
- "SignServerUrl": "", # 寻求国外网友帮助.png
+ "SignServerUrl": "", // Sign 地址,必填,请寻求国外网友帮助.png
"Account": {
- "Uin": 0, # Uin填写0以使用扫码连接
- "Password": "", # 不填写密码以使用扫码连接
- "Protocol": "Linux", #推荐使用Linux协议
+ "Uin": 0, // Uin 填写 0 以使用扫码连接
+ "Password": "", // 不填写密码以使用扫码连接
+ "Protocol": "Linux", // 使用 Linux 协议
"AutoReconnect": true,
"GetOptimumServer": true,
},
"Message": {
- "IgnoreSelf": true, # 忽略Bot自身的消息
+ "IgnoreSelf": true, // 忽略Bot自身的消息
},
- "Implementations": [ # 服务实现 支持多链接
+ "Implementations": [ // 服务实现 支持多链接
{
"Type": "ReverseWebSocket",
"Host": "127.0.0.1",
@@ -69,10 +94,19 @@ NTQQ的验证码拥有两个参数 ticket与randomStr
],
}
```
+
::: warning 注意
-复制粘贴前请删除所有#开头的注释
+
+以 `//` 开头的为注释,试图复制粘贴到实际的配置文件中时务必删除。
+
:::
+服务实现目前支持以下多种方式,请根据需要添加到配置文件中的 `Implementations` 中。
+
+- [反向 WebSocket](#反向-websocket-配置)
+- [正向 WebSocket](#正向-websocket-配置)
+- [HTTP POST](#http-post-配置)
+- [正向 HTTP](#正向-http-配置)
### 反向 WebSocket 配置
@@ -88,8 +122,6 @@ NTQQ的验证码拥有两个参数 ticket与randomStr
}
```
-
-
### 正向 WebSocket 配置
```json5
@@ -101,9 +133,8 @@ NTQQ的验证码拥有两个参数 ticket与randomStr
"AccessToken": "",
}
```
-
-### Http POST配置
+### HTTP POST 配置
```json5
{
@@ -116,9 +147,8 @@ NTQQ的验证码拥有两个参数 ticket与randomStr
}
```
-
+### 正向 HTTP 配置
-### 正向Http配置
```json5
{
"Type": "Http",
@@ -126,4 +156,20 @@ NTQQ的验证码拥有两个参数 ticket与randomStr
"Port": 8083,
"AccessToken": ""
}
-```
\ No newline at end of file
+```
+
+## 关于验证码
+
+::: warning 警告
+
+如果出现验证码登录的情况 推荐删除 `Keystore` 进行扫码登录。
+
+验证码登录因为未知原因成功率较低。
+
+:::
+
+NTQQ 的验证码拥有两个参数 `ticket` 与 `randomStr`。
+
+首先复制 `ticket` 参数到输入框内,按下回车确认。
+
+再次复制 `randomStr`参数到输入框内,按下回车确认。