docs(egg-passport): add redirection desc while auth succeed (#3260)

eggjs · Dec 4, 2018 · 64e88ab · 64e88ab
1 parent 7ff98ab
commit 64e88ab
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/docs/source/en/core/security.md b/docs/source/en/core/security.md
@@ -526,7 +526,7 @@ Framework provides `.surl()` macro to do url filtering.It is Used to parse the u
 
 You can add `helper.surl($value)` in the template to output variable.
 
-**note: in places where you need to parse the url, you must add double quotes outside of surl, or you will result in XSS vulnerabilities.**
+**Note: in places where you need to parse the url, you must add double quotes outside of surl, or you will result in XSS vulnerabilities.**
 
 Do not use `surl`
 

diff --git a/docs/source/en/tutorials/passport.md b/docs/source/en/tutorials/passport.md
@@ -60,7 +60,7 @@ config.passportGithub = {
 };
 ```
 
-**note:**
+**Note:**
 
 * Create a [GitHub OAuth Apps](https://github.com/settings/applications/new) to get the `clientID` and `clientSecret` information.
 * Specify a `callbackURL`, such as `http://127.0.0.1:7001/passport/github/callback`
@@ -159,6 +159,10 @@ The API also be provided for:
     - `options.callbackURL` - callback address after authorization, defaults to `/passport/${strategy}/callback`
 * `app.passport.mount(strategy, options)` - Syntactic sugar for developers to configure routing
 
+
+**Note:**
+ - `app.passport.authenticate`, if `options.successRedirect` or `options.successReturnToOrRedirect` is null, it will redirect to `/` by default
+
 ## Using Passport Ecosystem
 
 [Passport](http://www.passportjs.org/) has many middleware and it is impossible to have the second encapsulation.

diff --git a/docs/source/en/tutorials/socketio.md b/docs/source/en/tutorials/socketio.md
@@ -82,7 +82,7 @@ exports.io = {
 > When `redis` is turned on, the program tries to connect to the redis server at startup
 > Here `redis` is only used to store connection instance information, see [# server.adapter](https://socket.io/docs/server-api/#server-adapter-value)
 
-**note:**
+**Note:**
 If the project also uses the `egg-redis`, please configure it separately. Do not share it.
 
 ### Deployment
@@ -145,7 +145,7 @@ Middleware has the following two scenarios:
 
 It is configured in each namespace, respectively, according to the scenarios given above.
 
-**note:**
+**Note:**
 
 If we enable the framework middleware, you will find the following directory in the project:
 
@@ -267,7 +267,7 @@ module.exports = app => {
 };
 ```
 
-**note:**
+**Note:**
 
 Nsp has the following system events:
 

diff --git a/docs/source/zh-cn/tutorials/passport.md b/docs/source/zh-cn/tutorials/passport.md
@@ -162,6 +162,9 @@ module.exports = app => {
   - `options.callbackURL` - 授权后回调地址，默认为 `/passport/${strategy}/callback`
 - `app.passport.mount(strategy, options)` - 语法糖，方便开发者配置路由
 
+**注意：**
+ - `app.passport.authenticate` 中，未设置 `options.successRedirect` 或者 `options.successReturnToOrRedirect` 将默认跳转 `/`
+
 ## 使用 Passport 生态
 
 [Passport] 的中间件很多，不可能都进行二次封装。