更新Dashboard和设置页中、英文文档,新增使用Gitlab和Jihulab作为登录账号的介绍

This commit is contained in:
hhhkkk520
2022-05-26 19:56:59 +02:00
parent f6505fbf54
commit 690ef0e777
4 changed files with 24 additions and 13 deletions
+13 -6
View File
@@ -7,15 +7,18 @@
如果你想使用CDN,请准备两个域名,一个配置好CDN用作公开访问,CDN需要支持WebSocket协议;另一个域名不要使用CDN,用作Agent端与Dashboard的通信
本文档分别以 "cdn.example.com" 和 "data.example.com" 两个域名来演示
:::
3. 一个Github/Gitee账号
3. 一个Github账号(或:Gitlab、Jihulab、Gitee
::: tip
如果您位于中国大陆,访问 Github 有困难,我们建议您选择 Jihulab 作为OAuth提供商
:::
**本文档将以宝塔面板反代面板的过程作为范例,随着未来版本的变化,部分功能的入口可能会发生改变,本文档仅供参考**
<br/>
<br/>
## 获取Github的Client ID和密钥
## 获取Github/Jihulab的Client ID和密钥
哪吒监控接入GithubGitee作为后台管理员账号
哪吒监控接入Github、Gitlab、Jihulab、Gitee作为后台管理员账号
+ 首先我们需要新建一个验证应用,以Github为例,登录Github后,打开 https://github.com/settings/developers ,依次选择“OAuth Apps” - “New OAuth App”
`Application name` - 随意填写
`Homepage URL` - 填写面板的访问域名,如:"http://cdn.example.com"
@@ -23,7 +26,11 @@
+ 点击“Register application”
+ 保存页面中的Client ID,然后点击 “Generate a new client secret“,创建一个新的Client Secret,新建的密钥仅会显示一次,请妥善保存
<br/>
<br/>
<br/>
+ JihuLab的应用创建入口为:https://jihulab.com/-/profile/applications
+ `Redirect URL` 中应填入回调地址
+ 在下方`范围`中勾选 `read_user``read_api`
+ 创建完成后,保存好应用程序ID和密码
## 在服务器中安装Dashboard
@@ -37,10 +44,10 @@ curl -L https://jihulab.com/nezha/nezha/-/raw/master/script/install.sh -o nezha.
````
* 等待Docker安装完毕后,分别输入以下值:
`OAuth提供商` - Github或Gitee
`OAuth提供商` - GithubGitlabJihulabGitee中选择一个
`Client ID` - 之前保存的Client ID
`Client Secret` - 之前保存的密钥
`用户名` - Github或Gitee的用户名
`用户名` - OAuth提供商中的用户名
`站点标题` - 自定义站点标题
`访问端口` - 公开访问端口,可自定义,默认8008
`Agent的通信端口` - Agent与Dashboard的通信端口,默认5555
+1 -1
View File
@@ -3,7 +3,7 @@
<br/>
## 管理员列表
+ 如果你修改了自己的Github/Gitee用户名,可以在此项中同步修改,否则无法登录,多个用户请用逗号隔开: `user1,user2`
+ 如果你修改了自己的Github, Gitlab, Jihulab或Gitee用户名,可以在此项中同步修改,否则无法登录,多个用户请用逗号隔开: `user1,user2`
+ 如需更改管理员账户,请前往 `/opt/nezha/dashboard/data/config.yaml` ,重新设置新的管理员 `Client ID``Client Secret`
<br/>