keycloak-aplcache
Changes
docbook/reference/en/en-US/modules/cache.xml 68(+68 -0)
Details
diff --git a/docbook/reference/en/en-US/master.xml b/docbook/reference/en/en-US/master.xml
index 0fe428f..b8785df 100755
--- a/docbook/reference/en/en-US/master.xml
+++ b/docbook/reference/en/en-US/master.xml
@@ -30,6 +30,7 @@
<!ENTITY Authentication SYSTEM "modules/authentication-spi.xml">
<!ENTITY Ldap SYSTEM "modules/ldap.xml">
<!ENTITY ExportImport SYSTEM "modules/export-import.xml">
+ <!ENTITY ServerCache SYSTEM "modules/cache.xml">
]>
<book>
@@ -117,6 +118,7 @@ This one is short
&Authentication;
&Ldap;
&ExportImport;
+ &ServerCache;
&Migration;
</book>
docbook/reference/en/en-US/modules/cache.xml 68(+68 -0)
diff --git a/docbook/reference/en/en-US/modules/cache.xml b/docbook/reference/en/en-US/modules/cache.xml
new file mode 100755
index 0000000..6632e3a
--- /dev/null
+++ b/docbook/reference/en/en-US/modules/cache.xml
@@ -0,0 +1,68 @@
+<chapter id="server_cache">
+ <title>Server Cache</title>
+ <para>
+ By default, Keycloak caches realm metadata and users. There are two separate caches, one for realm metadata
+ (realm, application, client, roles, etc...) and one for users. These caches greatly improves the performance of the server.
+ </para>
+
+ <section>
+ <title>Disabling Caches</title>
+ <para>
+ The realm and user caches can be disabled through configuration or through the management console. To
+ manally disable the realm or user cache, you must edit the <literal>keycloak-server.json</literal> file
+ in your distribution. Here's what the config looks like initially.
+ </para>
+ <para>
+ <programlisting><![CDATA[
+ "realmCache": {
+ "provider": "${keycloak.realm.cache.provider:mem}"
+ },
+
+ "userCache": {
+ "provider": "${keycloak.user.cache.provider:mem}",
+ "mem": {
+ "maxSize": 20000
+ }
+ },
+]]></programlisting>
+ </para>
+ <para>You must then change it to:
+ <programlisting><![CDATA[
+ "realmCache": {
+ "provider": "${keycloak.realm.cache.provider:none}"
+ },
+
+ "userCache": {
+ "provider": "${keycloak.user.cache.provider:none}"
+ },
+]]></programlisting>
+ </para>
+ <para>
+ You can also disable either of the caches at runtime through the Keycloak admin console Realm Settings page.
+ This will not permanently disable the cache. If you reboot the server, the cache will be re-enabled unless
+ you manualy disable the cache in the <literal>keycloak-server.json</literal> file.
+ </para>
+ </section>
+ <section>
+ <title>Clear Caches</title>
+ <para>
+ To clear the realm or user cache, go to the Keycloak admin console Realm Settings page. Disable the cache
+ you want. Save the settings. Then re-enable the cache. This will cause the cache to be cleared.
+ </para>
+ </section>
+ <section>
+ <title>Cache Config</title>
+ <para>
+ Cache configuration is done within <literal>keycloak-server.json</literal>. Changes to this file will not
+ be seen by the server until you reboot. Currently you can only configure the max size of the user cache.
+ <programlisting><![CDATA[
+ "userCache": {
+ "provider": "${keycloak.user.cache.provider:mem}",
+ "mem": {
+ "maxSize": 20000
+ }
+ },
+]]></programlisting>
+ </para>
+ </section>
+</chapter>
\ No newline at end of file
diff --git a/docbook/reference/en/en-US/modules/MigrationFromOlderVersions.xml b/docbook/reference/en/en-US/modules/MigrationFromOlderVersions.xml
index cc713f5..c881b61 100755
--- a/docbook/reference/en/en-US/modules/MigrationFromOlderVersions.xml
+++ b/docbook/reference/en/en-US/modules/MigrationFromOlderVersions.xml
@@ -1,6 +1,14 @@
<chapter id="Migration_from_older_versions">
<title>Migration from older versions</title>
<sect1>
+ <title>Migrating from 1.0 Beta 1 to Beta 4</title>
+ <itemizedlist>
+ <listitem>
+ DB Schema has changed again.
+ </listitem>
+ </itemizedlist>
+ </sect1>
+ <sect1>
<title>Migrating from 1.0 Alpha 4 to Beta 1</title>
<itemizedlist>
<listitem>