Merge pull request #172 from stianst/master

Misc
This commit is contained in:
Stian Thorgersen 2017-08-30 07:25:03 +02:00 committed by GitHub
commit 02a6a6c1ec
4 changed files with 74 additions and 17 deletions

9
build-auto.sh Executable file
View file

@ -0,0 +1,9 @@
#!/bin/bash
DIR=`dirname $0`/src/web
while true; do
CHANGED=`inotifywait -r -e modify,move,create,delete server_installation --format %w`
GUIDE=`dirname $CHANGED`
mvn install -f $GUIDE
done

View file

@ -61,7 +61,7 @@
</goals>
<configuration>
<tasks>
<echo>OUTPUT: file://${project.build.directory}/generated-docs/index.html</echo>
<echo>OUTPUT: file://${project.build.directory}/generated-docs/${masterFile}.html</echo>
</tasks>
</configuration>
</execution>

View file

@ -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.<feature name>=disabled
----
For example to enable Docker use `-Dkeycloak.profile.feature.docker=enabled`.
To disable a specific feature start the server with:
[source]

View file

@ -6,26 +6,26 @@
:project_versionNpm: 3.3.0-cr.1
:project_versionDoc: 3.3
:project_images: keycloak-images
:project_doc_base_url: https://keycloak-docs.github.io/
:project_doc_base_url: http://www.keycloak.org/docs/{project_versionDoc}
:quickstartRepo_link: https://github.com/keycloak/keycloak-quickstarts
:quickstartRepo_name: Keycloak Quickstarts Repository
:quickstartRepo_dir: keycloak-quickstarts
:authorizationguide_name: Authorization Services Guide
:authorizationguide_link: {project_doc_base_url}/{project_versionDoc}/authorization_services_guide/
:authorizationguide_link: {project_doc_base_url}/authorization_services/
:adapterguide_name: Securing Applications and Services Guide
:adapterguide_link: {project_doc_base_url}/{project_versionDoc}/securing_applications_and_services_guide/
:adapterguide_link: {project_doc_base_url}/securing_apps/
:adminguide_name: Server Administration Guide
:adminguide_link: {project_doc_base_url}/{project_versionDoc}/server_administration_guide/
:adminguide_link: {project_doc_base_url}/server_admin/
:apidocs_name: API Documentation
:apidocs_link: {project_doc_base_url}/{project_versionDoc}/api-documentation/
:apidocs_link: {project_doc_base_url}/api-documentation/
:developerguide_name: Server Developer Guide
:developerguide_link: {project_doc_base_url}/{project_versionDoc}/server_developer_guide/
:developerguide_link: {project_doc_base_url}/server_development/
:gettingstarted_name: Getting Started Guide
:gettingstarted_link: {project_doc_base_url}/{project_versionDoc}/getting_started_guide/
:gettingstarted_link: {project_doc_base_url}/getting_started/
:installguide_name: Server Installation and Configuration Guide
:installguide_link: {project_doc_base_url}/{project_versionDoc}/server_installation_and_configuration_guide/
:installguide_link: {project_doc_base_url}/server_installation/
:installguide_profile_name: Profiles
:installguide_profile_link: {installguide_link}/#profiles