7x31/databasir
1
0
Fork 0
mirror of https://github.com/vran-dev/databasir.git synced 2025-08-08 06:21:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

feature: update docs (#56)

Browse Source
This commit is contained in:
vran
2022-03-21 12:21:47 +08:00
committed by GitHub
parent e1854b0b49
commit 9a3d32b206
69 changed files with 609 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/README/github-oauth2/github-oauth2.md
View File

@@ -1,51 +1,52 @@
# Databasir 配置 Github OAuth2 登录
# 启用 Github 第三方认证登录
1. **创建 Github OAuth Application**
## 一、创建 Github OAuth 应用
前往 Github 的配置页面创建 Github OAuth Application
![github-app-create](img/1-github-oauth2-app-create.png)
2. **填写 Github 应用资料**
Homepage URL 填写你部署 databasir 后，可访问的公网域名。
Authorization callback URL 你可以先填写 {{ databasir 域名 }}/login/oauth2/{{ registrationId }}，这里的 registrationId 你可以任意填写，只需要稍后在 Databasir 中配置时保持一致即可，我这里填写了 vran_github
点击 `New OAuth App` 就会进入应用创建页面
![github-oauth2](img/2-github-oauth2-create.png)
Homepage URL 填写你部署 databasir 后，可访问的公网域名。
Authorization callback URL 你可以先填写 {{ databasir 域名 }}/login/oauth2/{{ registrationId }}。
3. 申请 client secret
这里的 registrationId 你可以任意填写，只需要稍后在 Databasir 中配置时保持一致即可，我这里填写了 `vran_github`。
点击 `Generate a new client secret`，生成秘钥以后记得复制暂存一下，以后是看不见原始秘钥的了
填好信息以后点击 `Register application` 就能成功创建一个 OAuth Application 了并跳入下图所示页面
![oauth2-github](img/3-github-oauth2-create.png)
在点击 `Generate a new client secret`，生成秘钥以后记得复制暂存一下，以后是看不见原始秘钥的了
4. 保存 Client Id 和刚刚生成的 Client Secret
记得保存 Client Id 和刚刚生成的 Client Secret。
![oauth2-github](img/4-github-oauth2-create.png)
5. 进入 Databasir 系统管理 -> 登录设置
## 二、Databasir 登录设置
进入 Databasir 系统管理 -> 登录设置
![databasir](img/5-github-oauth-create.png)
进入到应用创建页面，填写表单信息。
![](img/6-github-oauth-create.png)
6. 最后一步，创建并保存登录应用
还记得前面提到的 `registrationId` 吗？那个就对应 databasir 中的 `应用 ID` ，只要两者保持一致就可以成功接受 github 的回调。
还记得我在第 2 步时候说的 `registrationId` 吗？那个就对应 databasir 中的 `应用 ID` ，只要两者保持一致就可以成功接受 github 的回调，要是前面配错了也可以在当前页面复制自动生成的 URL 去 github 重新填写 Authorization callback URL 就可以了。
要是前面配错了也没关系，可以在当前页面复制自动生成的 URL 去 github 重新填写 Authorization callback URL 就可以了。
注意授权地址和资源地址
- 授权地址：获取 access_token 的请求地址
- 资源地址：获取用户信息的请求地址
这里填写不一样是因为 github 官方将授权和资源地址分开的，如果你使用的时 github enterprise 版本，授权地址和资源地址其实是一样的。
![](img/6-github-oauth-create.png)
这里填写不一样是因为 github 官方将授权和资源地址分开的，**如果你使用的时 github enterprise 版本，授权地址和资源地址其实是一样的**。
## 三、登录验证
配置完成以后，注销登录后再次进入登录页面就会发现多了一个 github 的小图标，点击就可以使用 github 进行登录