Skip to content

Commit afb1d82

Browse files
committed
fix references
1 parent 58d02eb commit afb1d82

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@
1515
---
1616

1717
## 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.
1919

2020
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/>
2222

2323
## Installation
24-
For installation use the [Node Package Manager](npm):
24+
For installation use the [Node Package Manager][npm]:
2525
```
2626
$ npm install --save hapi-auth-keycloak
2727
```
@@ -31,7 +31,7 @@ or clone the repository:
3131
$ git clone https://github.com/felixheck/hapi-auth-keycloak
3232
```
3333

34-
Alternatively use the [Yarn Package Manager](yarn):
34+
Alternatively use the [Yarn Package Manager][yarn]:
3535
```
3636
$ yarn add hapi-auth-keycloak
3737
```
@@ -75,7 +75,7 @@ server.register({
7575
```
7676

7777
#### 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]:
7979

8080
- To secure a resource with an application role for the current app, use the role name (e.g. `editor`).
8181
- 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([
105105
## API
106106
#### Plugin Options
107107

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/>
109109
Required.
110110

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/>
112112
Optional.<br/>
113113
Default: `false`.
114114

115115
#### `server.kjwt.validate(field <string>, done <Function>)`
116-
Uses internally [`GrantManager.prototype.validateAccessToken()`](keycloak-auth-utils-gm-validate).
116+
Uses internally [`GrantManager.prototype.validateAccessToken()`][keycloak-auth-utils-gm-validate].
117117

118118
- `field {string}`: The `Bearer` field, including the scheme itself.<br/>
119119
Example: `bearer 12345.abcde.67890`.<br/>

0 commit comments

Comments
 (0)