From 3852cde1efbc4d33b1e7a03a8afd1cf1d15a14ee Mon Sep 17 00:00:00 2001 From: Stian Thorgersen Date: Wed, 30 Aug 2017 07:24:43 +0200 Subject: [PATCH] Make it obvious what profiles are enabled by default --- server_installation/topics/profiles.adoc | 64 +++++++++++++++++++++--- 1 file changed, 56 insertions(+), 8 deletions(-) diff --git a/server_installation/topics/profiles.adoc b/server_installation/topics/profiles.adoc index 148240e1b1..b644b604c7 100644 --- a/server_installation/topics/profiles.adoc +++ b/server_installation/topics/profiles.adoc @@ -3,8 +3,33 @@ == Profiles ifeval::[{project_community}==true] -{project_name} has a single profile, community, that enables all features by default, including features that +{project_name} has a single profile, community, that enables most features by default, including features that are considered less mature. It is however possible to disable individual features. + +The features that can be enabled and disabled are: + +[cols="3*", options="header"] +|=== +|Name +|Description +|Enabled by default + +|authorization +|Authorization Services +|Yes + +|docker +|Docker Registry protocol +|No + +|impersonation +|Ability for admins to impersonate users +|Yes + +|script +|Write custom authenticators using JavaScript +|Yes +|=== endif::[] ifeval::[{project_product}==true] @@ -27,19 +52,42 @@ the file: ---- profile=preview ---- -endif::[] The features that can be enabled and disabled are: -* Authorization - authorization services -* Docker - authentication protocol for Docker Registry -* Impersonation - ability for admins to impersonate users -* Script - write custom authenticators using JavaScript +[cols="3*", options="header"] +|=== +|Name +|Description +|Enabled by default -ifeval::[{project_product}==true] -The product profile disables authorization and script. +|authorization +|Authorization Services +|No + +|docker +|Docker Registry protocol +|No + +|impersonation +|Ability for admins to impersonate users +|Yes + +|script +|Write custom authenticators using JavaScript +|No +|=== endif::[] +To enable a specific feature start the server with: + +[source] +---- +bin/standalone.sh|bat -Dkeycloak.profile.feature.=disabled +---- + +For example to enable Docker use `-Dkeycloak.profile.feature.docker=enabled`. + To disable a specific feature start the server with: [source]