General guidance
Typically the IdP installation directory is /opt/shibboleth-idp
on Linux, or C:\Program Files\Shibboleth\IdP
or C:\Program Files (x86)\Shibboleth\IdP
on Windows. The installation directory is referred to in configuration files as %{idp.home}
, and we refer to it as such here. Configuration files are located in the conf
subdirectory of the IdP installation directory, that is to say %{idp.home}/conf
.
Take configuration a step at a time; work on a particular configuration task, and test and modify your configuration until you have achieved the desired result. Check the idp-process.log
and the container logs.
You can get more information by turning the logging level to DEBUG while you're configuring the IdP. To get details for many of the important processes in the IdP, set the following 3 parameters in %{idp.home}/conf/idp.properties
to DEBUG:
idp.loglevel.idp=DEBUG idp.loglevel.messages=DEBUG idp.loglevel.encryption=DEBUG
Reference documentation for logging configuration is available on the Shib wiki.
Generally we suggest the following order for configuring the IdP:
- user login, configuration usually in
ldap.properties
orjaas.config
- federation metadata
- register
- test
- attribute release in
attribute-filter.xml
andattribute-resolver.xml
- customise login page, configuration in
views/login.vm
,messages/messages.properties
,views/login-error.vm
,messages/error-messages.properties
. Refer to Login page Customisation - perform any tasks required for going into production