libre.sh/keycloak-scim
4
0
Fork 0
Code Issues 15 Pull requests Releases 1 Activity Actions

Move Node.js adapter to guides

Browse source 
Closes #31696

Signed-off-by: Giuseppe Graziano <g.graziano94@gmail.com>
This commit is contained in:
Giuseppe Graziano 2024-07-30 11:00:14 +02:00 committed by Alexander Schwartz
parent 5b52117351
commit ca2b6dc754
2 changed files with 19 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/documentation/securing_apps/topics.adoc
View file

@ -10,8 +10,6 @@ include::topics/oidc/oidc-overview.adoc[]
include::topics/oidc/javascript-adapter.adoc[] include::topics/oidc/javascript-adapter.adoc[]
include::topics/oidc/nodejs-adapter.adoc[]
ifeval::[{project_community}==true] ifeval::[{project_community}==true]
include::topics/oidc/mod-auth-openidc.adoc[] include::topics/oidc/mod-auth-openidc.adoc[]
endif::[] endif::[]

25
docs/documentation/securing_apps/topics/oidc/nodejs-adapter.adoc → docs/guides/securing-apps/nodejs-adapter.adoc
View file

@ -1,5 +1,10 @@
[[_nodejs_adapter]] <#import "/templates/guide.adoc" as tmpl>
=== {project_name} Node.js adapter <#import "/templates/links.adoc" as links>
<@tmpl.guide
title="{project_name} Node.js adapter"
priority=40
summary="Node.js adapter to protect server-side JavaScript apps">
{project_name} provides a Node.js adapter built on top of https://github.com/senchalabs/connect[Connect] to protect server-side JavaScript apps - the goal was to be flexible enough to integrate with frameworks like https://expressjs.com/[Express.js]. {project_name} provides a Node.js adapter built on top of https://github.com/senchalabs/connect[Connect] to protect server-side JavaScript apps - the goal was to be flexible enough to integrate with frameworks like https://expressjs.com/[Express.js].
@ -12,7 +17,7 @@ To use the Node.js adapter, first you must create a client for your application
Once the client is created, click *Action* at the top right and choose *Download adapter config*. For *Format, choose *Keycloak OIDC JSON* and click *Download*. The downloaded `keycloak.json` file is at the root folder of your project. Once the client is created, click *Action* at the top right and choose *Download adapter config*. For *Format, choose *Keycloak OIDC JSON* and click *Download*. The downloaded `keycloak.json` file is at the root folder of your project.
==== Installation == Installation
Assuming you have already installed https://nodejs.org[Node.js], create a folder for your application: Assuming you have already installed https://nodejs.org[Node.js], create a folder for your application:
@ -42,7 +47,7 @@ ifeval::[{project_product}==true]
endif::[] endif::[]
==== Usage == Usage
Instantiate a Keycloak class:: Instantiate a Keycloak class::
The `Keycloak` class provides a central point for configuration The `Keycloak` class provides a central point for configuration
@ -146,7 +151,7 @@ By default, the scope value `openid` is passed as a query parameter to {project_
[source,javascript] [source,javascript]
const keycloak = new Keycloak({ scope: 'offline_access' }); const keycloak = new Keycloak({ scope: 'offline_access' });
==== Installing middleware == Installing middleware
Once instantiated, install the middleware into your connect-capable app: Once instantiated, install the middleware into your connect-capable app:
@ -180,7 +185,7 @@ Last but not least, let's set up our server to listen for HTTP requests on port
}); });
---- ----
==== Configuration for proxies == Configuration for proxies
If the application is running behind a proxy that terminates an SSL connection If the application is running behind a proxy that terminates an SSL connection
Express must be configured per the link:https://expressjs.com/en/guide/behind-proxies.html[express behind proxies] guide. Express must be configured per the link:https://expressjs.com/en/guide/behind-proxies.html[express behind proxies] guide.
@ -198,7 +203,7 @@ Example configuration:
app.use( keycloak.middleware() ); app.use( keycloak.middleware() );
---- ----
==== Protecting resources == Protecting resources
Simple authentication:: Simple authentication::
@ -336,7 +341,7 @@ For example, this override checks if the URL contains /api/ and disables login r
}; };
---- ----
==== Additional URLs == Additional URLs
Explicit user-triggered logout:: Explicit user-triggered logout::
@ -368,6 +373,8 @@ to the `middleware()` call:
[source,javascript] [source,javascript]
app.use( keycloak.middleware( { admin: '/callbacks' } ); app.use( keycloak.middleware( { admin: '/callbacks' } );
==== Complete example == Complete example
A complete example using the Node.js adapter usage can be found in {quickstartRepo_link}/tree/latest/nodejs/resource-server[Keycloak quickstarts for Node.js] A complete example using the Node.js adapter usage can be found in {quickstartRepo_link}/tree/latest/nodejs/resource-server[Keycloak quickstarts for Node.js]
</@tmpl.guide>