docs: add oauth doc

suyuan32 · Oct 8, 2022 · 42e4b4d · 42e4b4d
1 parent 297ada5
commit 42e4b4d
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 1 deletion.
diff --git a/docs/simple-admin/assets/oauth_add_provider.png b/docs/simple-admin/assets/oauth_add_provider.png
diff --git a/docs/simple-admin/assets/oauth_add_provider_en.png b/docs/simple-admin/assets/oauth_add_provider_en.png
diff --git a/docs/simple-admin/en/_sidebar.md b/docs/simple-admin/en/_sidebar.md
@@ -17,4 +17,5 @@
     * [Swagger](simple-admin/en/docs/swagger.md)
     * [GORM](simple-admin/en/docs/gorm.md)
     * [Authorization](simple-admin/en/docs/authorization.md)
-    * [Error Handling](simple-admin/en/docs/error_handling.md)
+    * [Error Handling](simple-admin/en/docs/error_handling.md)
+    * [Oauth](simple-admin/en/docs/oauth.md)
diff --git a/docs/simple-admin/en/docs/oauth.md b/docs/simple-admin/en/docs/oauth.md
@@ -0,0 +1,25 @@
+# Oauth
+
+## The system offer google and github Oauth log in by default
+
+### How to get clientID and client secret?
+[google](https://developers.google.com/identity/protocols/oauth2)
+[github](https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps)
+
+### Add provider
+
+![picture](../../assets/oauth_add_provider_en.png)
+
+### Edit src/views/sys/login/LoginForm.vue
+
+```html
+<div class="flex justify-evenly enter-x" :class="`${prefixCls}-sign-in-way`">
+  <GithubFilled @click="oauthLoginHandler('github')" />
+  <WechatFilled />
+  <AlipayCircleFilled />
+  <GoogleCircleFilled @click="oauthLoginHandler('google')" />
+  <TwitterCircleFilled />
+</div>
+```
+
+Add icon and click event with the provider name。
diff --git a/docs/simple-admin/zh-cn/_sidebar.md b/docs/simple-admin/zh-cn/_sidebar.md
@@ -19,4 +19,5 @@
   * [GORM](simple-admin/zh-cn/docs/gorm.md)
   * [权限验证](simple-admin/zh-cn/docs/authorization.md)
   * [错误处理](simple-admin/zh-cn/docs/error_handling.md)
+  * [第三方登录](simple-admin/zh-cn/docs/oauth.md)
 * [常见问题](simple-admin/zh-cn/docs/FAQ.md) 
diff --git a/docs/simple-admin/zh-cn/docs/oauth.md b/docs/simple-admin/zh-cn/docs/oauth.md
@@ -0,0 +1,25 @@
+# Oauth
+
+## 目前系统已默认提供 google 和 github Oauth 登录功能
+
+### 如何获取 clientID 和 client secret?
+[google](https://developers.google.com/identity/protocols/oauth2)
+[github](https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps)
+
+### 添加第三方
+
+![picture](../../assets/oauth_add_provider.png)
+
+### 编辑 src/views/sys/login/LoginForm.vue
+
+```html
+<div class="flex justify-evenly enter-x" :class="`${prefixCls}-sign-in-way`">
+  <GithubFilled @click="oauthLoginHandler('github')" />
+  <WechatFilled />
+  <AlipayCircleFilled />
+  <GoogleCircleFilled @click="oauthLoginHandler('google')" />
+  <TwitterCircleFilled />
+</div>
+```
+
+添加对应的provider名称即可。