From 41a599144deaec4e4436a34ada5fa3898711015e Mon Sep 17 00:00:00 2001 From: Stian Thorgersen Date: Tue, 11 Jul 2023 12:59:10 +0200 Subject: [PATCH] Add documentation for configuring KeycloakServer (#21591) --- docs/tests.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/tests.md b/docs/tests.md index bdce0a63e4..22b3763602 100644 --- a/docs/tests.md +++ b/docs/tests.md @@ -47,6 +47,25 @@ and https port, optionally setting the truststore. -Djavax.net.ssl.keyStorePassword=CHANGEME \ -Dkeycloak.port.https=8443 +### Configuration + +KeycloakServer can be configured with system properties, or through the file `~/.keycloak-server.properties`. Using the +file allows persisting the settings and can also be more convenient when running from an IDE. + +Available options include: + +|Key| Description | +|---|------------------------------------------------------------------------------------| +|keycloak.port| Set the HTTP port for the server | +|keycloak.port.https| Set the HTTPS port for the server | +|keycloak.bind.address| Set the bind address for the server | +|resources| Loads theme resources directly from the workspace and disables caching | +|keycloak.theme.dir| Specifies an alternative location to load custom themes from | +|keycloak.theme.cacheTemplates| Disables theme template caching | +|keycloak.theme.cacheThemes| Disables theme caching | +|keycloak.theme.staticMaxAge| Sets the client-side caching max-age for theme resources | +|import| Imports a realm from json at startup | + ### Default admin account The default admin within the master realm are created with credentials: