Skip to content

Commit bb7ce87

Browse files
committed
update deps
1 parent f773144 commit bb7ce87

File tree

6 files changed

+2552
-3007
lines changed

6 files changed

+2552
-3007
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,15 @@
1717
## Introduction
1818
**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] offline with a provided public key or online with help of the [Keycloak][keycloak] server. Optionally, the successfully validated tokens and the related user data get cached using [`catbox`][catbox]. The caching enables a fast processing even though the user data don't get changed until the token expires. Furthermore it is possible to enable an api key interceptor proxying the request to an api key service which returns the temporary bearer token. It plays well with the [hapi.js][hapijs]-integrated [authentication/authorization 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

20-
The modules [`standard`][standardjs] and [`ava`][avajs] are used to grant a high quality implementation.<br/>
20+
The modules [`standard`][standardjs] and [`ava`][avajs] are used to grant a high quality implementation.
2121

2222
#### Compatibility
2323
| Major Release | [hapi.js](https://github.com/hapijs/hapi) version | node version |
2424
| --- | --- | --- |
25-
| `v4` | `>=18` | `>=8` |
26-
| `v3` | `>=17` | `>=8` |
27-
| `v2` | `>=12` | `>=6` |
25+
| `v4.1` | `>=18.3.1 @hapi/hapi` | `>=8` |
26+
| `v4` | `>=18 hapi` | `>=8` |
27+
| `v3` | `>=17 hapi` | `>=8` |
28+
| `v2` | `>=12 hapi` | `>=6` |
2829

2930
## Installation
3031
For installation use the [Node Package Manager][npm]:
@@ -47,7 +48,7 @@ const authKeycloak = require('hapi-auth-keycloak');
4748
#### Create hapi server
4849
Afterwards create your hapi server if not already done:
4950
``` js
50-
const hapi = require('hapi');
51+
const hapi = require('@hapi/hapi');
5152

5253
const server = hapi.server({ port: 8888 });
5354
```
@@ -210,7 +211,7 @@ module.exports = {
210211

211212
#### `index.js`
212213
``` js
213-
const hapi = require('hapi');
214+
const hapi = require('@hapi/hapi');
214215
const authKeycloak = require('hapi-auth-keycloak');
215216
const routes = require('./routes');
216217

0 commit comments

Comments
 (0)