https://github.com/anthinkingcoder/egg-keycloak
egg plugin for keycloak
https://github.com/anthinkingcoder/egg-keycloak
Last synced: 8 months ago
JSON representation
egg plugin for keycloak
- Host: GitHub
- URL: https://github.com/anthinkingcoder/egg-keycloak
- Owner: anthinkingcoder
- License: mit
- Created: 2019-07-02T07:58:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-07-16T06:27:20.000Z (over 6 years ago)
- Last Synced: 2025-02-06T20:44:30.401Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# egg-keycloak
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/egg-keycloak.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-keycloak
[travis-image]: https://img.shields.io/travis/eggjs/egg-keycloak.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-keycloak
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-keycloak.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-keycloak?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-keycloak.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-keycloak
[snyk-image]: https://snyk.io/test/npm/egg-keycloak/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-keycloak
[download-image]: https://img.shields.io/npm/dm/egg-keycloak.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-keycloak
## Install
```bash
$ npm i egg-keycloak --save
```
## Usage
```js
// {app_root}/config/plugin.js
exports.keycloak = {
enable: true,
package: 'egg-keycloak'
};
// router.js
router.get('/login', app.keycloak.protect(), controller.page.login)
router.get('/*', app.keycloak.checkSso(), controller.page.index)
```
## Configuration
```js
// {app_root}/config/config.default.js
exports.keycloak = {
middleware: {
logout: '/logout',
admin: '/',
},
base: {
store: true,
cookies: false,
idpHint: null,
scope: null
},
kcConfig: { //keycloak.json
clientId: '',
serverUrl: '',
realm: '',
bearerOnly: false
}
};
```
Support all configurations in [keycloak-koa-connect](https://github.com/anthinkingcoder/keycloak-koa-connect).
see [config/config.default.js](config/config.default.js) for more detail.
## Example
## Questions & Suggestions
Please open an issue [here](https://github.com/eggjs/egg/issues).
## License
[MIT](LICENSE)