Enabling & Disabling¶

KETE and all routes are enabled by default.

Disabling KETE¶

To disable KETE entirely (no events will be forwarded):

kete.enabled=false

Property	Default	Description
`kete.enabled`	`true`	Master switch for KETE

The unprefixed enabled=false key accepted by earlier releases is still honoured as a legacy alias; prefer kete.enabled.

When KETE is disabled it removes itself from the event-listener list of every realm at start-up, so no events are delivered to it.

Automatic Event Listener Registration¶

When KETE is enabled it registers itself at start-up: for every realm accepted by at least one route it adds the kete event listener, enables user events and admin events (with representation details) and enables all event types. Realms that no route accepts have the kete listener removed. No manual "Event Listeners" configuration in the Admin Console is required.

Realms that exist when Keycloak starts are processed at start-up. A realm created later is registered the moment it is created (KETE listens for realm-creation events) — no restart is needed; the route realm matchers are evaluated against the new realm's name.

Event storage is switched on as a side effect

Enabling user events, admin events and admin-event representations on a realm also makes Keycloak persist those events in its own database (the EVENT_ENTITY and ADMIN_EVENT_ENTITY tables) — one row per login, logout, token refresh, introspection and userinfo call, for every event type. KETE does not set an expiry, so configure Realm settings → Events → User events settings → Expiration (and prune admin events) on each realm KETE registers on to keep those tables bounded. This behaviour is unchanged from earlier releases; it is documented here so that it is not a surprise.

Disabling Routes¶

To disable a specific route while keeping others active:

kete.routes.my-route.enabled=false

See Routes for more on route configuration.

Restart Required¶

Restart Required

Configuration changes require a Keycloak restart to take effect. There is no hot-reload or on-the-fly configuration refresh.