https://github.com/chf007/egg-qywx-login
企业微信扫码登陆 Egg 插件
https://github.com/chf007/egg-qywx-login
egg egg-plugin egg-qywx-login eggjs eggplugin qywx qywx-login
Last synced: 3 months ago
JSON representation
企业微信扫码登陆 Egg 插件
- Host: GitHub
- URL: https://github.com/chf007/egg-qywx-login
- Owner: chf007
- License: mit
- Created: 2018-09-07T02:55:05.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-28T06:08:21.000Z (over 2 years ago)
- Last Synced: 2024-12-17T10:05:49.890Z (over 1 year ago)
- Topics: egg, egg-plugin, egg-qywx-login, eggjs, eggplugin, qywx, qywx-login
- Language: JavaScript
- Homepage:
- Size: 5.86 KB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# egg-qywx-login
企业微信扫码登陆 Egg 插件，日前只持 Egg2.x 以上版本
## 安装
```
npm install egg-qywx-login
```
## 启用
```
// config/plugin.js
exports['qywx-login'] = {
enable: true,
package: 'egg-qywx-login',
};
```
## 配置说明
```
// config/config.default.js
config['qywx-login'] = {
returnDomainName: 'https://admin.xxx.com', // 扫码回跳域名 必填
loginPath: '/login', // 登陆处理
logoutPath: '/logout', // 登出处理
loginSuccPath: '/', // 登陆成功后跳转地址
loginFailPath: '/login-fail.html', // 登陆失败后跳转地址，可以应用中自定义
noRedirectPath: '/api/', // 哪些地址不直接跳转而是将控制权交给前端
ignore: [ // 不需要校验登陆url名单，支持字符串，正则，回调函数(会传入ctx，返回true/false)
'/login-fail.html',
/abc/g,
function(ctx) {
return true;
}
],
};
```
## 目前支持
- 基于 Cookie/Session 的扫码登陆校验
- 登陆成功后用户信息会写入 ctx.userInfo 中
- 暂时没有每次校验拉取用户信息，如果用户信息在企业微信中有变更，重新扫码登陆后才能更新