/monitor web application

Start

To install service.monitor, follow the steps below:

  1. Optionally, you can first adjust the name of the WAR file monitor.war.

  2. Make sure that the Tomcat service is started.

  3. Then copy the WAR file into the %TOMCAT%\webapps folder. The file will now be unpacked automatically.

    Alternatively, you can use the Tomcat Manager to install the WAR file. If the Tomcat service is started, you can usually reach the Tomcat Manager at http://<yourserver>:8080/manager/html.

  4. When Tomcat unpacks the file, it will then attempt to start the web application. Due to missing configuration this initial start will fail.

Configuration adjustment

The following configuration files are processed by map.apps:

  • WEB-INF/classes/default-application.properties (DO NOT EDIT)
    This file contains all configuration options of map.apps with their default values.

  • WEB-INF/classes/custom-application.properties
    If a change to the working directory (data.directory.location) or config directory (config.directory.location) is required, the change has to be made in this file. Any further changes have to be made in the following file.

  • [config.directory.location]/application.properties
    Make changes to the configuration by editing this file.
    The default config directory (config.directory.location) of map.apps is ${user.home}/.mapapps. This file is not created automatically, the file WEB-INF/classes/config-template/application.properties can be used as a template. Only keep settings in the file that have been changed or those that refer to values from the secrets.properties, if you do not want to use the secrets.properties file.

  • [config.directory.location]/secrets.properties
    You should store sensitive data such as passwords or API keys in this file and reference them as described in the sample.

The format of the configuration files must correspond to the Java Properties file format .

After making the changes, restart the servlet container or refresh the context.

Environment variables

You can also set the value of all configuration parameters using environment variables. These always override the values you set in the application.properties. This allows to easily customize {product-name} configuration in containerized environments, for example.

You need to translate the names of the configuration properties when using them as environment variables: Only use uppercase letters and replace any dot . by an underscore _.

Example: security.oauth.provider becomes SECURITY_OAUTH_PROVIDER. This pattern applies to all configuration parameters.

Configuration of passwords and secrets

Sensitive data such as passwords or API keys should be stored in the file [config.directory.location]/secrets.properties following the pattern secretKey=value. Unlike previous software versions, default passwords are no longer provided. All required passwords must be set during installation. The password encoding is set to SHA-512 by default and can be adjusted using the security.user.pwenc property. For instance, you can define the password for administration access as follows:

secrets.properties
# Password for administrative access
secret.admin.pw=mySecretValue

You then refer to the entry in the application.properties file:

application.properties
# Reference to entry in secrets.properties
security.user.admin.pw=${secret.admin.pw}

Storing the secrets separately in the secrets.properties file prevents gaining knowledge of configured secrets by retrieving the application’s configuration.

Secure the secrets.properties file by assigning appropriate access authorization and encrypt them using the operating system’s tools, if necessary.

In dynamic deployment scenarios, like the operation in a Docker container, the secrets.properties file can also be generated or managed externally.

Configuring application.properties

All changes that need to be adjusted to the installation system or infrastructure are made in the application.properties file in the data.directory.

You need to adjust the following parameters. See the Common configuration page for an overview of the most commonly used parameters.

Internal account

security.user.admin.pw

Password for the internal default account monitor.

It is strongly recommended to set a new password for the internal default account monitor for operation. This is part of the built-in authentication procedure, which is the default after installation. A new password hash can be generated using the script resources\tools\createPassword.bat or resources\tools\createPassword.sh from the command line. The call is createPassword.bat SHA-512 <password>. Copy the output value of the tool into the file as a configuration value.

Public base URL

basehost.url

The public base URL for external communication without the context name.

Please also make sure to specify the correct protocol, e.g. https://[public.domain.tld].

Database connection

db.use

Specifies whether a direct database connection (JDBC) or a container-managed database connection (JNDI) is established.

In the case of JDBC, the other parameters described here must be configured. In the case of JNDI, follow the section JNDI.

Allowed Values: jdbc, jndi

db.type

Type of database.

Allowed Values: postgresql, oracle, oracle10, sqlserver

db.jdbc.url

Database connection URL.

db.jdbc.username

Name of db user.

db.jdbc.password

Password of db user.

Mail server

mailing.host

Mail server host.

mailing.port

Mail server port.

mailing.user

Name of SMTP user.

mailing.password

Password of SMTP user.

mailing.sender

Sender address.

Further information