Keycloak

1
<#import "/templates/guide.adoc" as tmpl>
2
<#import "/templates/kc.adoc" as kc>
3

4
<@tmpl.guide
5
title="Enabling and disabling features"
6
summary="Understand how to configure {project_name} to use optional features"
7
includedOptions="features features-*">
8

9
{project_name} has packed some functionality in features, including some disabled features, such as Technology Preview and deprecated features. Other features are enabled by default, but you can disable them if they do not apply to your use of {project_name}.
10

11
== Enabling features
12

13
Some supported features, and all preview features, are disabled by default. To enable a feature, enter this command:
14

15
<@kc.build parameters="--features=\"<name>[,<name>]\""/>
16

17
For example, to enable `docker` and `token-exchange`, enter this command:
18

19
<@kc.build parameters="--features=\"docker,token-exchange\""/>
20

21
To enable all preview features, enter this command:
22

23
<@kc.build parameters="--features=\"preview\""/>
24

25
Enabled feature may be versioned, or unversioned.  If you use a versioned feature name, e.g. feature:v1, that exact feature version will be enabled as long as it still exists in the runtime.  If you instead use an unversioned name, e.g. just feature, the selection of the particular supported feature version may change from release to release according to the following precedence:
26

27
1. The highest default supported version
28
1. The highest non-default supported version
29
1. The highest deprecated version
30
1. The highest preview version
31
1. The highest experimental version
32

33
== Disabling features
34

35
To disable a feature that is enabled by default, enter this command:
36

37
<@kc.build parameters="--features-disabled=\"<name>[,<name>]\""/>
38

39
For example to disable `impersonation`, enter this command:
40

41
<@kc.build parameters="--features-disabled=\"impersonation\""/>
42

43
You can disable all default features by entering this command:
44

45
<@kc.build parameters="--features-disabled=\"default\""/>
46

47
This command can be used in combination with `features` to explicitly set what features should be available.
48
It is not allowed to have a feature in both the `features-disabled` list and the `features` list.
49

50
When a feature is disabled all versions of that feature are disabled.
51

52
== Supported features
53

54
The following list contains supported features that are enabled by default, and can be disabled if not needed.
55

56
<@showFeatures ctx.features.supported/>
57

58
=== Disabled by default
59

60
The following list contains supported features that are disabled by default, and can be enabled if needed.
61

62
<@showFeatures ctx.features.supportedDisabledByDefault/>
63

64
== Preview features
65

66
Preview features are disabled by default and are not recommended for use in production.
67
These features may change or be removed at a future release.
68

69
<@showFeatures ctx.features.preview/>
70

71
== Deprecated features
72

73
<#if ctx.features.deprecated?has_content>
74

75
The following list contains deprecated features that will be removed in a future release. These features are disabled by default.
76

77
<@showFeatures ctx.features.deprecated/>
78

79
<#else>
80

81
There are no deprecated features in this {project_name} release.
82

83
</#if>
84

85
</@tmpl.guide>
86

87
<#macro showFeatures features>
88
<#list features as feature>
89
[.features-name]#${feature.name}#::
90
[.features-description]#${feature.description}#
91
</#list>
92
</#macro>