adjust rp docs to clarify exposing js path

Closes #11041
This commit is contained in:
Dominik Guhr 2022-04-05 16:23:19 +02:00 committed by Bruno Oliveira da Silva
parent 034748ed0a
commit 52150cacfc

View file

@ -61,8 +61,8 @@ The following table shows the recommended paths to expose.
|/js/ |/js/
| - | -
|No |Yes (see note below)
|A good practice is to not use external js for the JavaScript client, but add it into your public client using a package manager like NPM or Yarn instead. |Access to keycloak.js needed for "internal" clients, e.g. the account console
|/welcome/ |/welcome/
| - | -
@ -95,6 +95,11 @@ The following table shows the recommended paths to expose.
|Exposed health checks lead to an unnecessary attack vector. |Exposed health checks lead to an unnecessary attack vector.
|=== |===
.Note:
[NOTE]
As it's true that the `js` path is needed for internal clients like the account console, it's good practice to use `keycloak.js` from a JavaScript package manager like npm or yarn for your external clients.
We assume you run Keycloak on the root path `/` on your reverse proxy/gateway's public API. We assume you run Keycloak on the root path `/` on your reverse proxy/gateway's public API.
If not, prefix the path with your desired one. If not, prefix the path with your desired one.