swederik / keycloak

Keycloak Docker image

This is a Dockerfile for standalone Keycloak server which could be used for securing the DICOM Archive dcm4chee-arc-light.

Supported tags and respective Dockerfile links

• 4.0.0-13.3 (4.0.0-13.3/Dockerfile)
• 4.0.0-13.3-logstash (4.0.0-13.3-logstash/Dockerfile)

How to use this image

See Running on Docker at the dcm4che Archive 5 Wiki.

Environment Variables

Below explained environment variables can be set as per one's application to override the default values if need be. An example of how one can set an env variable in docker run command is shown below :

-e KEYCLOAK_DEVICE_NAME=my-keycloak

Note : If default values of any environment variables were overridden in startup of slapd container, then ensure that the same values are also used for overriding the defaults during startup of keycloak container.

LDAP_HOST

This environment variable sets the host name for LDAP. Default value is ldap.

LDAP_PORT

This environment variable sets the port for LDAP. Default value is 389.

LDAP_BASE_DN

This environment variable sets the base domain name for LDAP. Default value is dc=dcm4che,dc=org.

LDAP_ROOTPASS

This environment variable sets the root password for LDAP. Default value is secret.

LDAP_CONFIGPASS

This environment variable sets the password for users who wish to change the schema configuration in LDAP. Default value is secret.

KEYCLOAK_DEVICE_NAME

This is the name of keycloak device that is configured in LDAP. Default value is keycloak

HTTP_PORT

This environment variable sets the Http port of Wildfly. Default value is 8080.

HTTPS_PORT

This environment variable sets the Https port of Wildfly. Default value is 8443.

MANAGEMENT_HTTP_PORT

This environment variable sets the Management Http port of Wildfly. Default value is 9990.

WILDFLY_ADMIN_USER

This environment variable sets the admin user name for Wildfly. Default value is admin.

WILDFLY_ADMIN_PASSWORD

This environment variable sets the password for the WILDFLY_ADMIN_USER. Default value can be viewed in LDAP, it is set to admin.

KEYCLOAK_ADMIN_USER

This environment variable sets the admin user name for Keycloak master realm. Default value is not set, will use the default WILDFLY_ADMIN_USER to create an admin user for Keycloak master realm.

KEYCLOAK_ADMIN_PASSWORD

This environment variable sets the password for the KEYCLOAK_ADMIN_USER. Default value is not set.

SUPER_USER_ROLE

This environment variable sets the user role to identify super users, which have unrestricted access to all UI functions of the Archive, bypassing the verification of user permissions. Login/Logout of such users will emit an Audit Message for Security Alert with EventTypeCode (110127,DCM,"Emergency Override Started")/(110138,DCM,"Emergency Override Stopped"). Default value is admin.

KEYSTORE

This environment variable sets the keystore used in ssl server identities in Wildfly configuration. Default value is dcm4chee-arc/key.jks.

KEYSTORE_PASSWORD

This environment variables sets the password of the keystore used in ssl server identities in Wildfly configuration. Default value is secret.

KEY_PASSWORD

This environment variables sets the password of the key used in ssl server identities in Wildfly configuration. Default value is secret.

KEYSTORE_TYPE

This environment variable sets the type of keystore that is used above. Default value is JKS.

TRUSTSTORE

This environment variable sets the truststore which will be used to verify archive's certificate and/or keycloak-proxy's certificate in Https communication. Default value is keycloak/cacerts.jks.

TRUSSTORE_PASSWORD

This environment variable sets the password of the above truststore. Default value is secret.

SSL_REQUIRED

This environment variable defines the SSL/HTTPS requirements for interacting with the realm. Default value is external. Values which are accepted are : external, none or all.

REALM_NAME

This is the name of the realm configured in Keycloak for securing archive UI and RESTful services. Default value is dcm4che.

HOSTNAME_VERIFICATION_POLICY

This environment variable sets the verification policy for the hostname to be validated/authenticated. Default value set is ANY. Values which are accepted are : ANY, WILDCARD or STRICT.

SYSLOG_HOST

This environment variable is the host name of logstash container used in wildfly configuration. Default value is logstash.

GELF_FACILITY

This environment variable sets the facility name needed by GELF logging used in wildfly configuration. Default value is dcm4chee-arc.

GELF_LEVEL

This environment variable sets the level of GELF logging used in wildfly configuration. Default value is WARN.

JAVA_OPTS

This environment variable is used to set the JAVA_OPTS during archive startup. Default value is "-Xms64m -Xmx512m -XX:MetaspaceSize=96M -XX:MaxMetaspaceSize=256m -Djava.net.preferIPv4Stack=true -Djboss.modules.system.pkgs=org.jboss.byteman -Djava.awt.headless=true"