You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,13 +15,13 @@
15
15
---
16
16
17
17
## Introduction
18
-
**hapi-auth-keycloak** is a plugin for [hapi.js](hapijs) which enables to protect your endpoints in a smart but professional manner using [Keycloak](keycloak) as authentication service. It is inspired by the related [express.js middleware](keycloak-node). The plugin validates the passed [`Bearer` token](bearer) online with help of the [Keycloak](keycloak) server and optionally caches successfully validated tokens and the related user data using [`catbox`](catbox). The caching enables a fast processing although the user data don't get changed until the token expires. It plays well with the [hapi.js](hapijs)-integrated [authentication feature](hapi-route-options). Besides the authentication strategy it is possible to validate tokens by yourself, e.g. to authenticate incoming websocket or queue messages.
18
+
**hapi-auth-keycloak** is a plugin for [hapi.js](hapijs] which enables to protect your endpoints in a smart but professional manner using [Keycloak][keycloak] as authentication service. It is inspired by the related [express.js middleware][keycloak-node]. The plugin validates the passed [`Bearer` token][bearer] online with help of the [Keycloak][keycloak] server and optionally caches successfully validated tokens and the related user data using [`catbox`][catbox]. The caching enables a fast processing although the user data don't get changed until the token expires. It plays well with the [hapi.js][hapijs]-integrated [authentication feature][hapi-route-options]. Besides the authentication strategy it is possible to validate tokens by yourself, e.g. to authenticate incoming websocket or queue messages.
19
19
20
20
This plugin is implemented in ECMAScript 6 without any transpilers like `babel`.<br/>
21
-
Additionally [`standard`](standardjs) and [`ava`](avajs) are used to grant a high quality implementation.<br/>
21
+
Additionally [`standard`][standardjs] and [`ava`][avajs] are used to grant a high quality implementation.<br/>
22
22
23
23
## Installation
24
-
For installation use the [Node Package Manager](npm):
24
+
For installation use the [Node Package Manager][npm]:
Alternatively use the [Yarn Package Manager](yarn):
34
+
Alternatively use the [Yarn Package Manager][yarn]:
35
35
```
36
36
$ yarn add hapi-auth-keycloak
37
37
```
@@ -75,7 +75,7 @@ server.register({
75
75
```
76
76
77
77
#### Route Configuration & Scope
78
-
Define your routes and add `keycloak-jwt` when necessary. It is possible to define the necessary scope like documented by the [express.js middleware](keycloak-node):
78
+
Define your routes and add `keycloak-jwt` when necessary. It is possible to define the necessary scope like documented by the [express.js middleware][keycloak-node]:
79
79
80
80
- To secure a resource with an application role for the current app, use the role name (e.g. `editor`).
81
81
- To secure a resource with an application role for a different app, prefix the role name (e.g. `other-app:creator`)
@@ -105,15 +105,15 @@ server.route([
105
105
## API
106
106
#### Plugin Options
107
107
108
-
-`client {Object}`: The configuration of [`keycloak-auth-utils`](keycloak-auth-utils) its [`GrantManager`](keycloak-auth-utils-gm).<br/>
108
+
-`client {Object}`: The configuration of [`keycloak-auth-utils`][keycloak-auth-utils] its [`GrantManager`][keycloak-auth-utils-gm].<br/>
109
109
Required.
110
110
111
-
-`cache {Object|false}`: The configuration of the [hapi.js cache](https://hapijs.com/api#servercacheoptions) powered by [catbox](catbox). If `false` the cache is disabled. Use an empty object to use the built-in default cache.<br/>
111
+
-`cache {Object|false}`: The configuration of the [hapi.js cache](https://hapijs.com/api#servercacheoptions) powered by [catbox][catbox]. If `false` the cache is disabled. Use an empty object to use the built-in default cache.<br/>
0 commit comments