Skip to main content

Administering the ADF Server with the ADF.properties File

The ADF.properties file contains configurable parameters of an ADF installation in a key-value format. Updating the file allows you to customize and control ADF.

Procedure. Update the ADF.properties File

  1. Find the ADF.properties file at opt/ADF/WEB-INF/classes.

    The file contains the configuration options you specified during the installation or upgrade process together with other settings relevant to your ADF installation such as database and logging configuration. You can find an overview below.

  2. Update the parameter values as required.

  3. Restart the ADF server for the changes to take effect.

. ADF.properties File: Reference

Here is an overview of the most important parameters controlling your ADF installation.

  • PoolParty

    • pp.url – the URL of the PoolParty instance ADF works on top of. The API calls to PoolParty are protected with OAuth 2.0.

    • pp.user-group – the PoolParty user group that will permit access to the areas in ADF that are protected with authentication. Only users that are members of this PoolParty group will be able to log in to the ADF configuration interface and access the configurations on the main user interface that require login.

  • Authentication (Keycloak)

    • adf.requireUiAuthentication – Set to true to enforce authentication for all configurations on the main user interface regardless whether they are public or private.

    • spring.security.oauth2.client.registration.ppt.clientSecret – the client secret of the Keycloak client ppt

    • Keycloak Oauth2 URLs – Update these parameters if Keycloak URL or realm name changes.

  • General configuration

    • server.servlet.context-path – the base path where ADF will be accessible at. It must start with a slash.

      For instance if you specify /search as a base path, the main user interface will be accessible at servername/search and the configuration interface at servername/search/configurations.

      Important

      If you want to change the base path, you also need to update the Context path value in the Tomcat Server.xml file.

      For instance if you want to change the base path to search, the path parameter in the Server.xml file will look like this:

      ADF_tomcat_server_xml_basepath.png
In this section: