Configuration
Introduction
The IdH service can be configured through the config/application.yml YAML configuration file.
If you have installed the service via packages this file can be found at /var/lib/identity-harmonization/config/application.yml. This file provides a basic set of parameters for configuring the service. In detail the parameters that can be configured are as following.
Basic Configuration
The IdH service comes with a built-in redis database and LDAP directory. To use an external redis DB or LDAP directory server, you have to change the according parameters as listed below.
The REST API of the IdH service is exposed via HTTP/HTTPS with the ports configurable as indicated below. You need to allow access to the ports you specify to make use of the REST API.
Configuration Parameters
server: Basic server configuration
address: The address for the server to listen to (e.g. localhost or 0.0.0.0)
port: The port for the server to listen to
ssl:
enabled: If SSL should be enabled
key-alias: The SSL key alias to use from the Java Key Store
key-password: The password for the SSL key (if any)
key-store: The path to the Java Key Store for the SSL key
key-store-password: The Java Key Store password
rest: HTTP Basic authentication configuration for the REST API
serviceUsername: The HTTP Basic authentication username
servicePassword: The HTTP Basic authentication password
spring: Java Spring specific configurations
profiles: Configuration profile to use
active: Default and only available profile at the moment
development
redis: Redis DB configuration
port: Port to the redis DB
ldap: LDAP specific configuration for the local user management
port: Port of the LDAP directory server
url: Connection url to the LDAP directory server
searchBase: LDAP search base
userBase: LDAP user base
groupBase: LDAP group base
bindDn: Bind domain name for LDAP lookup and modifications
bindPassword: Bind password
uidNumber:UID number specific configurations
start: The lowest UID number that can be assigned to new users
end: The highest UID number that can be assigned to new users
gidNumber:
start: The lowest GID number that can be assigned to new groups
end: The highest GID number that can be assigned to new groups
default: Default UID/GID configurations
gidNumber: The default GID number for new users
Java Spring
The configuration can also be modified via Spring Boot application supported ways, see Spring Boot - External config for more details.
Last updated