更新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
+9 -5
View File
@@ -6,12 +6,12 @@ To setup a Nezha monitorning Dashboard, you need these things:
If you want to use CDN, please prepare two domains, one connect to CDN for public access, CDN needs to support WebSocket protocol; the other domain should not connect to CDN, use it as Agent to send data to Dashboard.
This document uses "cdn.example.com" and "data.example.com" domains to demonstrate respectively
:::
3. A Github account
3. A Github or Gitlab account
**This document will use the aaPanel as an example, with future versions of the changes, some of the features may change, this document is for reference only**
<br/>
<br/>
## Get the Client ID and Client Secret on Github
## Get the Client ID and Client Secret on Github/Gitlab
Nezha Monitor uses a Github account as the login account for the admin panel
+ First we need to create a new authentication application, after logging into Github, open https://github.com/settings/developers and select "OAuth Apps" - "New OAuth App "
`Application name` - Fill in as you like
@@ -20,7 +20,11 @@ Nezha Monitor uses a Github account as the login account for the admin panel
+ Click on "Registration Application"
+ Remember the Client ID in the page, then click "Generate a new client secret" to create a new Client Secret, the new secret will be displayed only once, please save it properly
<br/>
<br/>
<br/>
+ If you're using Gitlab, you'll need to go to https://gitlab.com/-/profile/applications to create a new application
+ Fill in `Redirect URL` with the callback address
+ In `Scopes`, select `read_user` and `read_api`
+ Once created, save the Application ID and Secret
## Installing Dashboard on the server
* In the panel server, run the installation script:
```bash
@@ -28,10 +32,10 @@ curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.s
```
* After waiting for the Docker installation to complete, input the following settings:
`OAuth2 provider` - Github
`OAuth2 provider` - Github or Gitlab
`Client ID` - Previously saved Client ID
`Client Secret` - Previously saved secret
`GitHub/Gitee login name` - Github username
`GitHub/Gitee login name` - Github o Gitlab username
`Site title` - Custom site title
`Site access port` - Public access port, customizable, default 8008
`RPC port` - The communication port between Agent and Dashboard, default 5555
+1 -1
View File
@@ -3,7 +3,7 @@ You can customize your site title here
<br/>
## Admin List
+ If you have changed your Github/Gitee username, you can change it in this item, otherwise you can't log in, please separate multiple users with commas: `user1,user2`
+ If you have changed your Github, Gitlab, Jihulab, Gitee username, you can change it in this item, otherwise you can't log in, please separate multiple users with commas: `user1,user2`
+ To change your administrator account, please go to `/opt/nezha/dashboard/data/config.yaml` to set the new administrator `Client ID` and `Client Secret`.
<br/>