keycloak-scim/server_installation/topics/profiles.adoc

124 lines
2.6 KiB
Text
Raw Normal View History

2017-06-01 13:05:37 +00:00
[[_profiles]]
== Profiles
2017-08-28 12:50:14 +00:00
ifeval::[{project_community}==true]
{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
|===
2017-08-28 12:50:14 +00:00
endif::[]
2017-08-28 12:50:14 +00:00
ifeval::[{project_product}==true]
{project_name} has two profiles, product and preview. The product profile is enabled by default, which disables
some tech preview features. To enable the features you can either switch to the preview profile or enable individual
features.
To enable the preview profile start the server with:
[source]
----
bin/standalone.sh|bat -Dkeycloak.profile=preview
----
You can set this permanently by creating the file `standalone/configuration/profile.properties`
(or `domain/servers/server-one/configuration/profile.properties` for `server-one` in domain mode). Add the following to
the file:
[source]
----
profile=preview
----
The features that can be enabled and disabled are:
[cols="3*", options="header"]
|===
|Name
|Description
|Enabled by default
|authorization
|Authorization Services
|No
|docker
|Docker Registry protocol
|No
|impersonation
|Ability for admins to impersonate users
|Yes
|script
|Write custom authenticators using JavaScript
|No
|===
2017-08-28 12:50:14 +00:00
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:
[source]
----
bin/standalone.sh|bat -Dkeycloak.profile.feature.<feature name>=disabled
----
For example to disable Impersonation use `-Dkeycloak.profile.feature.impersonation=disabled`.
You can set this permanently in the `profile.properties` file by adding:
[source]
----
feature.impersonation=disabled
----
2017-08-28 12:50:14 +00:00
ifeval::[{project_product}==true]
To enable a specific feature without enabling the full preview profile you can start the server with:
[source]
----
bin/standalone.sh|bat -Dkeycloak.profile.feature.<feature name>=enabled`
----
For example to enable Authorization Services use `-Dkeycloak.profile.feature.authorization=enabled`.
You can set this permanently in the `profile.properties` file by adding:
[source]
----
feature.authorization=enabled
----
2017-08-28 12:50:14 +00:00
endif::[]