更新以匹配 Dashboard v0.18.0 的新功能和特性变化
This commit is contained in:
Kris
@@ -77,11 +77,11 @@ systemctl status docker
|
||||
出现此错误说明没有在服务页中设置 TCP-Ping 和 ICMP-Ping 类型的监控或者监控数据还未生成。
|
||||
如已经设置完毕，可以等待一段时间后再查看。
|
||||
|
||||
### 启用 HTTPS 后 /terminal 或 /ws 不能正常连接
|
||||
## 启用 HTTPS 后 /terminal 或 /ws 不能正常连接
|
||||
|
||||
常常是由于证书不完整造成的，请在 agent 运行参数中添加 -d，若 log 中有 `x509:certificate signed by unknown authority`，更换完整证书则可解决该问题。
|
||||
|
||||
### 对面板提供的数据修改/增加功能不满意，想要修改/增加数据
|
||||
## 对面板提供的数据修改/增加功能不满意，想要修改/增加数据
|
||||
|
||||
常见于批量新建 Agent 等需求中，可以直接修改数据库。
|
||||
请注意，数据库中并非什么都可以修改，错误的修改会导致数据混乱无法启动 Dashboard，**请勿随意修改数据库！**
|
||||
@@ -91,6 +91,11 @@ systemctl status docker
|
||||
如需要在数据库中修改数据，请先**停止**面板容器再修改。
|
||||
数据库类型是 sqlite3，位于 `/opt/nezha/dashboard/data/sqlite.db`，修改前请备份。
|
||||
|
||||
### Dashboard 会自动更新吗？
|
||||
## Dashboard 会自动更新吗？
|
||||
|
||||
Agent 通常情况下会自动更新，但 Dashboard 并不会，需要手动更新。
|
||||
Agent 通常情况下会自动更新，但 Dashboard 并不会，需要手动更新。
|
||||
|
||||
## 连接在线终端时提示：`Agent 信令下发失败`
|
||||
|
||||
当 Agent 离线，或与 Dashboard 之间的连接不稳定时，可能会导致在线终端无法正常连接。
|
||||
请检查 Agent 是否正常运行，是否与 Dashboard 保持稳定的连接。
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
# 内网穿透功能配置
|
||||
|
||||
哪吒服务器监控提供内置的内网穿透功能，允许用户通过设定 Dashboard 作为服务端，将运行在 Agent 上的内网服务（如家庭 OpenWrt 路由器、NAS 设备等）映射到公网上，便于外部访问。目前仅支持 HTTP 协议的穿透。
|
||||
|
||||
## 准备工作
|
||||
|
||||
在配置内网穿透前，请确保完成以下准备工作：
|
||||
|
||||
- 确认已在您的设备上安装并运行哪吒监控的 Agent，并保持其与 Dashboard 的连接状态。
|
||||
- 准备一个公网域名，推荐使用子域名进行操作，如`service-1.example.com`。将此域名解析指向 Dashboard 服务器的公网 IP 地址。
|
||||
- 请注意，一个域名只能映射到一个 Agent 的内网服务。若需映射多个服务，请分别使用不同的域名，例如 `service-2.example.com`。
|
||||
|
||||
::: warning
|
||||
如果您的 Dashboard 服务器使用宝塔面板或其他管理工具，请确保所用域名，如 `service-1.example.com` 已在该面板中正确绑定至 Dashboard 站点，否则可能导致无法访问。
|
||||
:::
|
||||
|
||||
## 内网穿透配置步骤
|
||||
|
||||
1. 登录至 Dashboard 管理页面，选择菜单栏中的“内网穿透”选项。
|
||||
2. 点击“添加”按钮，并填写以下所需信息：
|
||||
- **穿透名称**：为此穿透配置自定义一个名称，如`OpenWrt 登录页`。
|
||||
- **Agent ID**：填写需要进行穿透的 Agent 的 ID。
|
||||
- **内网服务地址**：填写需穿透的内网服务地址，格式为 `IP:端口`，例如 `127.0.0.1:80`。
|
||||
- **绑定域名**：填写已准备的公网域名，如 `service-1.example.com`。
|
||||
3. 完成填写后，点击“新增”按钮，等待穿透生效。
|
||||
4. 尝试访问 `http://service-1.example.com`，以验证是否成功映射至 Agent 上的内网服务。
|
||||
|
||||
## 使用须知
|
||||
|
||||
- 保持 Agent 与 Dashboard 之间的连接是内网穿透功能正常运作的前提。若 Agent 连接中断，已配置的穿透将暂时失效。
|
||||
- 考虑到内网穿透隧道本身不加密数据，建议在 Agent 与 Dashboard 之间以及 Dashboard 与客户端浏览器之间**使用 HTTPS 协议**，以确保数据传输过程的安全性。
|
||||
Regular → Executable
+23
-17
@@ -1,22 +1,28 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
# 使用OIDC认证
|
||||
修改`config.ymal`的内容来配置OIDC
|
||||
# 配置OIDC认证
|
||||
|
||||
修改 `config.yaml` 文件的内容来配置 OIDC（OpenID Connect）认证。OIDC 是建立在 OAuth 2.0 协议之上的认证层，允许应用程序通过授权服务器执行的认证来验证用户的身份。这种方法广泛用于实现现代应用程序的单点登录。
|
||||
|
||||
## 配置详细信息
|
||||
|
||||
以下是在 `config.yaml` 中配置 OIDC 设置的逐步指南：
|
||||
|
||||
```yaml
|
||||
oauth2:
|
||||
type: oidc # (必填) 指定验证类型为OIDC
|
||||
oidcDisplayName: OIDC # (可选，默认值为OIDC) 登录页面按钮显示的名字
|
||||
admin: "" # (与adminGroups至少填写一项; 默认值为空) 管理员用户名，多个用户名用半角逗号分隔。如果用户在这些用户名列表中，则视为管理员
|
||||
adminGroups: "" # (与admin至少填写一项; 默认值为空) 管理员组，多个组名用半角逗号分隔。如果用户属于这些组，则视为管理员。如果不使用组管理，此项可省略
|
||||
clientid: # (必填) OIDC客户端ID
|
||||
clientsecret: # (必填) OIDC客户端密钥
|
||||
oidcIssuer: https://auth.example.com/realms/master # (必填) OIDC提供商的issuer地址，可从OIDC提供商查询
|
||||
# oidcLogoutUrl: https://auth.example.com/realms/master/protocol/openid-connect/logout # (有bug，目前不能使用)
|
||||
# oidcRegisterUrl: # (可选) OIDC提供商的注册链接
|
||||
oidcScopes: openid,profile,email # (可选，默认值为openid,profile,email) OIDC请求的scope，多个scope用半角逗号分隔
|
||||
oidcLoginClaim: sub # (可选，默认值为sub) 从OIDC返回的用户名字段，可以是preferred_username、sub或email
|
||||
oidcGroupsClaim: groups # (如果使用adminGroups，则必填，默认值为groups) 从OIDC返回的用户组信息字段，可以是groups或roles
|
||||
oidcAutoCreate: false # (可选，默认值为false) 如果用户不存在，是否自动创建用户
|
||||
oidcAutoLogin: false # (可选，默认值为false) 当地址是/login时，是否自动跳转到OIDC登录页面
|
||||
```
|
||||
type: oidc # （必填）指定认证类型为 OIDC
|
||||
oidcDisplayName: OIDC # （可选，默认值为 OIDC）登录页面显示的名称
|
||||
admin: "" # （至少填写 admin 或 adminGroups 中的一个；默认为空）管理员用户名，用逗号分隔。列在此处的用户被视为管理员
|
||||
adminGroups: "" # （至少填写 admin 或 adminGroups 中的一个；默认为空）管理员组，用逗号分隔。属于这些组的用户被视为管理员。如果不使用组管理，可以省略此项
|
||||
clientid: # （必填）OIDC 客户端 ID
|
||||
clientsecret: # （必填）OIDC 客户端密钥
|
||||
oidcIssuer: https://auth.example.com/realms/master # （必填）OIDC 提供商的 issuer URL，可以从您的OIDC 提供商处获取
|
||||
# oidcLogoutUrl: https://auth.example.com/realms/master/protocol/openid-connect/logout # （因 bug 目前不能使用）
|
||||
# oidcRegisterUrl: # （可选）OIDC 提供商的注册链接
|
||||
oidcScopes: openid,profile,email # （可选，默认值为 openid,profile,email ）OIDC 请求的 scope，用逗号分隔
|
||||
oidcLoginClaim: sub # （可选，默认值为 sub）OIDC 返回的用户名字段，可以是 preferred_username、sub 或email
|
||||
oidcGroupsClaim: groups # （如果使用 adminGroups，则必填，默认值为 groups ）OIDC 返回的用户组信息字段，可以是 groups 或 roles
|
||||
oidcAutoCreate: false # （可选，默认值为 false）如果用户不存在，是否自动创建用户
|
||||
oidcAutoLogin: false # （可选，默认值为 false）当地址是 /login 时，是否自动跳转到OIDC登录页面
|
||||
```
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# 实时通道断开/在线终端连接失败
|
||||
# 实时通道断开
|
||||
|
||||
- 如果你使用了 CDN，请确认 CDN 服务商提供 WebSocket 服务，并且已开启 WebSocket。
|
||||
- 确认你的反代规则中针对 `/ws`, `/terminal` 路径的 WebSocket 进行了特别配置，你可以 [点击这里](/guide/dashboard.html#配置反向代理) 查看反向代理配置。
|
||||
Reference in New Issue
Block a user