Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents
stylenone

...

Excerpt
nameInstallTimeProperties

Installation Specific Properties

These properties are required for installation to succeed and are populated in the database. After installation is complete the values are not used any further.

Property

Requires Configuration

Default Value

Explanation

install.customer_name

Always

<none>

The customer name as provided with your licence.

install.licence_key

Always

<none>

Licence key as provided with your licence.

install.user.password

Often

<autogenerated>

Initial password of the default administrator user created during installation. If no value is configured a password is autogenerated and written to the security.log file.

It is strongly recommended this is changed immediately after installation.

install.user.username

Often

admin

Username of the default administrator user created during installation.

install.user.email

Often

<none>

Email address of the default administrator user created during installation. Can be updated after installation in the User Details screen.

install.user.firstname

Often

admin

First name of the default administrator user created during installation. Can be updated after installation in the User Details screen.

install.user.lastname

Often

admin

Last name of the default administrator user created during installation. Can be updated after installation in the User Details screen.

install.data.base

Often

${install.application_loc}/data

Base location for the default data directory paths. This will commonly be configured to be “/opt/phixflow/data”

install.data.temp

Occasionally

${install.data.base}/temp

Populates an initial value in the System Configuration Temporary File Location

install.data.upload

Occasionally

${install.data.base}/upload

Populates an initial value in the System Configuration File Upload Directory

install.data.import

Occasionally

${install.data.base}/import

Populates an initial value in the System Configuration Import File Location

install.data.export

Occasionally

${install.data.base}/export

Populates an initial value in the System Configuration Export File Location

install.data.template

Occasionally

${install.data.base}/template

Populates an initial value in the System Configuration Template Location

install.data.archive

Occasionally

${install.data.base}/archive

Populates an initial value in the System Configuration Archive Directory

install.data.restore

Occasionally

${install.data.base}/restore

Populates an initial value in the System Configuration Restore Directory

install.data.driver

Occasionally

${install.data.base}/driver

Populates an initial value in the System Configuration Data Driver Directory

install.data.download

Occasionally

${install.data.base}/download

Populates an initial value in the System Configuration Download Location

install.data.plugin

Occasionally

${install.data.base}/plugin

Populates an initial value in the System Configuration Plugin Location

install.data.file

Occasionally

${install.data.base}/file

Populates an initial value in the System Configuration File Table Upload Location

install.application_loc

Rarely

<autodetected>

Base application install location, e.g.

ZB example missing here

Base application install location

install.pepperKey

Rarely

<none>

Externally defined value for the pepperKey. If not specified and a pepper key isn’t configured in the keystore then a value is autogenerated.

install.phixflow_api_key

Rarely

<none>

Externally defined value for the PhixFlow API credential signing key. If not specified and the API key isn’t configured in the keystore then a value is autogenerated.

...

Excerpt
nameLoginActiveDirectory

Login - Active Directory Configuration

PhixFlow supports multiple modes of supporting authentication users. Users can be authenticated either with local credentials, native active directory based credentials, or using SAML to authenticate with active directory or other services, such as Okta.

Property

Requires Configuration

Default Value

Explanation

login.activeDirectory.enabled

Often

false

Whether Active Directory integration is enabledenabled.

login.activeDirectory.domain

Often

http://example.com

The domain being logged into

login.activeDirectory.url

Often

ldaps://ldap.example.com

Space separated list of domain LDAP servers.

login.activeDirectory.domain

Often

http://example.com

The domain being logged intodn

Often

ou=user accounts,dc=example,dc=com

If you have a large AD tree, searches may take some time, and this could lead to slow authentication for users. Therefore it is possible to specify a root DN (Distinguished name) at which PhixFlow will begin searching for the user. The Distinguished Name format is standard and further details can be found on the web.

login.activeDirectory.url

Often

ldaps://ldap.example.com

Space separated list of domain LDAP servers.

login.activeDirectory.dn

Often

ou=user accounts,dc=example,dc=com

The root distinguished name to search under.

login.activeDirectory.timeout

Rarely

5000

Timeout for attempt to authenticate against each servertimeout

Rarely

5000

You can specify a timeout. For each server specified, if the server does not respond within the limit specified by the timeout, it will try the next server. If the last server in the list times out, then the authentication will fail.

The timeout is specified in milliseconds.

login.activeDirectory.authenticationOnly

Occasionally

falseWhether

only authentication is used from active directory, with user permissions and details being stored in PhixFlowIf this is true Active Directory is used for authentication when logging in, but not authorisation. This is a mixed user.

The user must be configured in PhixFlow before logging in and user groups must be configured for the user. External groups will not be used to determine access rights.

Excerpt
nameLogging

Logging Configuration

valid Where a level is required this can be one of level values: OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL

Property

Requires Configuration

Default Value

Explanation

logging.file.directory

Occasionally

logs

The directory logs are written into, relative to the Tomcat root directory.

logging.file.phixflow.base

Occasionally

phixflow

Base name of the standard PhixFlow log file.

logging.file.security.base

Occasionally

security

Base name of the security log file.

logging.stdout.level

Occasionally

OFF

Used to control the minimum log message level permitted to be output to stdout.ZB is “stdout” a typo?standard output.

logging.root.level

Rarely

INFO

Configures the default minimum log level that can be generated.

logging.file.phixflow.main

Rarely

${logging.file.directory}/${logging.file.phixflow.base}.log

Defines the path and name of the standard PhixFlow log file

logging.file.phixflow.archive

Rarely

${logging.file.directory}/${logging.file.phixflow.base}.%d{yyyy-MM-dd}.log

Defines the path and name of archived standard PhixFlow log files.

logging.file.security.main

Rarely

${logging.file.directory}/${logging.file.security.base}.log

Defines the path and name of the security log file.

logging.file.security.archive

Rarely

${logging.file.directory}/${logging.file.security.base}.%d{yyyy-MM-dd}.log

Defines the path and name of archived security log files.

logging.file.phixflow.level

Rarely

ALL

Used to control the minimum log message level permitted to be output to standard log file.

logging.file.security.level

Rarely

ALL

Used to control the minimum log message level permitted to be output to security log file.