Make it obvious what profiles are enabled by default

This commit is contained in:
Stian Thorgersen 2017-08-30 07:24:43 +02:00
parent cb1e47bf8a
commit 3852cde1ef

View file

@ -3,8 +3,33 @@
== Profiles == Profiles
ifeval::[{project_community}==true] 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. 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::[] endif::[]
ifeval::[{project_product}==true] ifeval::[{project_product}==true]
@ -27,19 +52,42 @@ the file:
---- ----
profile=preview profile=preview
---- ----
endif::[]
The features that can be enabled and disabled are: The features that can be enabled and disabled are:
* Authorization - authorization services [cols="3*", options="header"]
* Docker - authentication protocol for Docker Registry |===
* Impersonation - ability for admins to impersonate users |Name
* Script - write custom authenticators using JavaScript |Description
|Enabled by default
ifeval::[{project_product}==true] |authorization
The product profile disables authorization and script. |Authorization Services
|No
|docker
|Docker Registry protocol
|No
|impersonation
|Ability for admins to impersonate users
|Yes
|script
|Write custom authenticators using JavaScript
|No
|===
endif::[] endif::[]
To enable a specific feature start the server with:
[source]
----
bin/standalone.sh|bat -Dkeycloak.profile.feature.<feature name>=disabled
----
For example to enable Docker use `-Dkeycloak.profile.feature.docker=enabled`.
To disable a specific feature start the server with: To disable a specific feature start the server with:
[source] [source]