KEYCLOAK-8979 Updates to profiles.adoc to reflect unification of features in community and product
This commit is contained in:
stianst
Stian Thorgersen
parent
8b81106dec
commit
4aa5b24b0f
1 changed files with 45 additions and 59 deletions
|
|
@ -2,42 +2,65 @@
|
||||||
|
|
||||||
== Profiles
|
== Profiles
|
||||||
|
|
||||||
ifeval::[{project_community}==true]
|
There are features in {project_name} that are not enabled by default, these include features that are not fully
|
||||||
{project_name} has a single profile, community, that enables most features by default, including features that
|
supported. In addition there are some features that are enabled by default, but that can be disabled.
|
||||||
are considered less mature. It is however possible to disable individual features.
|
|
||||||
|
|
||||||
The features that can be enabled and disabled are:
|
The features that can be enabled and disabled are:
|
||||||
|
|
||||||
[cols="3*", options="header"]
|
[cols="4*", options="header"]
|
||||||
|===
|
|===
|
||||||
|Name
|
|Name
|
||||||
|Description
|
|Description
|
||||||
|Enabled by default
|
|Enabled by default
|
||||||
|
|Support level
|
||||||
|
|
||||||
|authorization
|
|account2
|
||||||
|Authorization Services
|
|New Account Management Console
|
||||||
|Yes
|
|No
|
||||||
|
|Experimental
|
||||||
|
|
||||||
|
|account_api
|
||||||
|
|Account Management REST API
|
||||||
|
|No
|
||||||
|
|Preview
|
||||||
|
|
||||||
|
|admin_fine_grained_authz
|
||||||
|
|Fine-Grained Admin Permissions
|
||||||
|
|No
|
||||||
|
|Preview
|
||||||
|
|
||||||
|
|authz_drools_policy
|
||||||
|
|Drools Policy for Authorization Services
|
||||||
|
|No
|
||||||
|
|Preview
|
||||||
|
|
||||||
|docker
|
|docker
|
||||||
|Docker Registry protocol
|
|Docker Registry protocol
|
||||||
|No
|
|No
|
||||||
|
|Supported
|
||||||
|
|
||||||
|impersonation
|
|impersonation
|
||||||
|Ability for admins to impersonate users
|
|Ability for admins to impersonate users
|
||||||
|Yes
|
|Yes
|
||||||
|
|Supported
|
||||||
|
|
||||||
|
|openshift_integration
|
||||||
|
|Extension to enable securing OpenShift
|
||||||
|
|No
|
||||||
|
|Preview
|
||||||
|
|
||||||
|script
|
|script
|
||||||
|Write custom authenticators using JavaScript
|
|Write custom authenticators using JavaScript
|
||||||
|Yes
|
|Yes
|
||||||
|
|Preview
|
||||||
|
|
||||||
|
|token_exchange
|
||||||
|
|Token Exchange Service
|
||||||
|
|No
|
||||||
|
|Preview
|
||||||
|===
|
|===
|
||||||
endif::[]
|
|
||||||
|
|
||||||
ifeval::[{project_product}==true]
|
To enable all preview features start the server with:
|
||||||
{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]
|
[source]
|
||||||
----
|
----
|
||||||
|
|
@ -53,32 +76,6 @@ the file:
|
||||||
profile=preview
|
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
|
|
||||||
|===
|
|
||||||
endif::[]
|
|
||||||
|
|
||||||
To enable a specific feature start the server with:
|
To enable a specific feature start the server with:
|
||||||
|
|
||||||
[source]
|
[source]
|
||||||
|
|
@ -88,6 +85,13 @@ bin/standalone.sh|bat -Dkeycloak.profile.feature.<feature name>=enabled
|
||||||
|
|
||||||
For example to enable Docker use `-Dkeycloak.profile.feature.docker=enabled`.
|
For example to enable Docker use `-Dkeycloak.profile.feature.docker=enabled`.
|
||||||
|
|
||||||
|
You can set this permanently in the `profile.properties` file by adding:
|
||||||
|
|
||||||
|
[source]
|
||||||
|
----
|
||||||
|
feature.docker=enabled
|
||||||
|
----
|
||||||
|
|
||||||
To disable a specific feature start the server with:
|
To disable a specific feature start the server with:
|
||||||
|
|
||||||
[source]
|
[source]
|
||||||
|
|
@ -102,22 +106,4 @@ You can set this permanently in the `profile.properties` file by adding:
|
||||||
[source]
|
[source]
|
||||||
----
|
----
|
||||||
feature.impersonation=disabled
|
feature.impersonation=disabled
|
||||||
----
|
----
|
||||||
|
|
||||||
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
|
|
||||||
----
|
|
||||||
endif::[]
|
|
||||||
Loading…
Reference in a new issue