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

KEYCLOAK-11019 Offline sessions preloading docs

Browse source
This commit is contained in:
Martin Kanis 2021-05-31 20:05:04 +02:00 committed by Hynek Mlnařík
parent 02a09538ba
commit 485e802ad8
2 changed files with 39 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
server_admin/topics.adoc
View file

@ -96,6 +96,11 @@ include::topics/sessions/administering.adoc[]
include::topics/sessions/revocation.adoc[]
include::topics/sessions/timeouts.adoc[]
include::topics/sessions/offline.adoc[]
ifeval::[{project_community}==true]
include::topics/sessions/preloading.adoc[]
endif::[]
include::topics/sessions/transient.adoc[]
include::topics/user-federation.adoc[]
include::topics/user-federation/ldap.adoc[]

34
server_admin/topics/sessions/preloading.adoc Normal file
View file

@ -0,0 +1,34 @@
=== Offline Sessions Preloading
In addition to {jdgserver_name} caches, offline sessions are stored in a database which means they will be available even after server restart.
By default, the offline sessions are preloaded from the database into the {jdgserver_name} caches during the server startup.
However this approach has a drawback if there are many offline sessions to be preloaded. It can significantly slow down the server startup time.
To overcome this problem, {project_name} can be configured to fetch offline sessions into the {jdgserver_name} caches on demand.
It can be achieved by setting `preloadOfflineSessionsFromDatabase` property in `userSessions` SPI to `false`.
The following example shows how to configure lazy offline sessions loading.
[source,xml]
----
<subsystem xmlns="urn:jboss:domain:keycloak-server:1.1">
...
<spi name="userSessions">
<default-provider>infinispan</default-provider>
<provider name="infinispan" enabled="true">
<properties>
<property name="preloadOfflineSessionsFromDatabase" value="false"/>
</properties>
</provider>
</spi>
...
</subsystem>
----
Equivalent configuration using CLI commands:
[source,bash]
----
/subsystem=keycloak-server/spi=userSessions:add(default-provider=infinispan)
/subsystem=keycloak-server/spi=userSessions/provider=infinispan:add(properties={preloadOfflineSessionsFromDatabase => "false"},enabled=true)
----