diff --git a/docbook/reference/en/en-US/master.xml b/docbook/reference/en/en-US/master.xml index 0fe428fc57..b8785dff6c 100755 --- a/docbook/reference/en/en-US/master.xml +++ b/docbook/reference/en/en-US/master.xml @@ -30,6 +30,7 @@ + ]> @@ -117,6 +118,7 @@ This one is short &Authentication; &Ldap; &ExportImport; + &ServerCache; &Migration; diff --git a/docbook/reference/en/en-US/modules/MigrationFromOlderVersions.xml b/docbook/reference/en/en-US/modules/MigrationFromOlderVersions.xml index cc713f5690..c881b617a7 100755 --- a/docbook/reference/en/en-US/modules/MigrationFromOlderVersions.xml +++ b/docbook/reference/en/en-US/modules/MigrationFromOlderVersions.xml @@ -1,5 +1,13 @@ Migration from older versions + + Migrating from 1.0 Beta 1 to Beta 4 + + + DB Schema has changed again. + + + Migrating from 1.0 Alpha 4 to Beta 1 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 0000000000..6632e3a3b0 --- /dev/null +++ b/docbook/reference/en/en-US/modules/cache.xml @@ -0,0 +1,68 @@ + + Server Cache + + 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. + + +
+ Disabling Caches + + 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 keycloak-server.json file + in your distribution. Here's what the config looks like initially. + + + + + You must then change it to: + + + + 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 keycloak-server.json file. + +
+
+ Clear Caches + + 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. + +
+
+ Cache Config + + Cache configuration is done within keycloak-server.json. 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. + + +
+
\ No newline at end of file