keycloak-scim/docbook/auth-server-docs/reference/en/en-US/modules/cache.xml

<!--
  ~ Copyright 2016 Red Hat, Inc. and/or its affiliates
  ~ and other contributors as indicated by the @author tags.
  ~
  ~ Licensed under the Apache License, Version 2.0 (the "License");
  ~ you may not use this file except in compliance with the License.
  ~ You may obtain a copy of the License at
  ~
  ~ http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing, software
  ~ distributed under the License is distributed on an "AS IS" BASIS,
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  -->

<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>Eviction and Expiration</title>

        <para>
            By default the user cache contains a maximum of 10000 entries. This is not 10000 users, but 10000 entries in the cache. You can change the maximum
            number of entries by editing the server configuration <literal>standalone.xml</literal> or <literal>standalone-ha.xml</literal>.
            Locate the element <literal>cache-container name="keycloak"</literal> and change the eviction policy for the <literal>users</literal> cache. For
            more information see <ulink url="https://docs.jboss.org/author/display/WFLY10/Infinispan+Subsystem">Infinispan Subsystem documentation</ulink>.
        </para>
    </section>

    <section>
        <title>Disabling Caches</title>
        <para>
            To 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[
    "userCache": {
        "infinispan" : {
            "enabled": true
        }
    },

    "realmCache": {
        "infinispan" : {
            "enabled": true
        }
    },
]]></programlisting>
        </para>
        <para>To disable the cache set the enabled field to false for the cache you want to disable:
            <programlisting><![CDATA[
    "userCache": {
        "infinispan" : {
            "enabled": false
        }
    },

    "realmCache": {
        "infinispan" : {
            "enabled": false
        }
    },
]]></programlisting>
        </para>
    </section>

    <section>
        <title>Clear Caches</title>
        <para>
            To clear the realm or user cache, go to the Keycloak admin console Realm Settings->Cache Config page. On this page you can clear the realm cache
            or the user cache. This will clear the caches for all realms and not only the selected realm.
        </para>
    </section>
</chapter>