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
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

name	LoginSaml

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.saml.enabled=false	Often	false	Configures whether SAML login is enabled
login.saml.key= <none>	Often	<none>	Configures the identity provider's entity id .
login.saml.attribute.domain= <none>	Often	<none>	Configures the domain of the saml users.
login.saml.label=Single Sign In	Rarely	Single Sign In	The label to display
login.saml.attributeMap=authenticationOnly	Often	authenticationOnly	Configures the integration method. authenticationOnly - SAML used for authentication but PhixFlow manages user details and permissions. okta - configured to support Okta based authentication and details. userDetails - allows configuration of authentication and user details to be provided by saml.
login.saml.keystore.file	Often	classpath:keystore/samlKeystore.jks	Configures the location of the saml keystore
login.saml.keystore.password	Often	<none>	Configures the password to the saml keystore.
login.saml.keystore.key.password	Often	<none>	Configures the password to the secret in the saml keystore
login.saml.keystore.key.alias	Rarely	samlKey	Configures the alias of the secret stored in the saml keystore
login.saml.url.host	Often	localhost	Configures the externally resolvable hostname of the PhixFlow server. If behind a reverse proxy this will be the proxy’s hostname.
login.saml.url.port	Occasionally	443	Configures the port of the PhixFlow server, or that of the reverse proxy if it is being used.
login.saml.url.includePort	Rarely	false	Whether the port should be included in the generated url.
login.saml.url.path	Occasionally	/phixflow	Path that the webapp is installed under. If behind a reverse proxy this should be the path that the proxy forwards.
login.saml.metadata.entityId	Rarely	https://${login.saml.url.host}/${login.saml.url.path}	The value that globally identifies the PhixFlow instance.
login.saml.metadata.entityBaseUrl	Rarely	https://${login.saml.url.host}/${login.saml.url.path}	The public facing URL of the PhixFlow instance.
login.saml.metadata.file	Often	file:/opt/phixflow/data/saml-metadata/idp-metadata.xml	Path to the Identity Provider Metadata file.
login.saml.metadata.trustCheck	Rarely	true	Whether to validate incoming signatures.
login.saml.attribute.username	Occasionally	nameid	Used with the authenticationOnly and userDetails attribute map to define the appropriate mapping from the incoming metadata.
login.saml.attribute.fullname	Occasionally	displayname	Used with the userDetails attribute map to define the appropriate mapping from the incoming metadata.
login.saml.attribute.firstname	Occasionally	givenname	Used with the userDetails attribute map to define the appropriate mapping from the incoming metadata.
login.saml.attribute.lastname	Occasionally	surname	Used with the userDetails attribute map to define the appropriate mapping from the incoming metadata.
login.saml.attribute.phonenumber	Occasionally	phonenumber	Used with the userDetails attribute map to define the appropriate mapping from the incoming metadata.
login.saml.attribute.company	Occasionally	company	Used with the userDetails attribute map to define the appropriate mapping from the incoming metadata.
login.saml.attribute.department	Occasionally	department	Used with the userDetails attribute map to define the appropriate mapping from the incoming metadata.
login.saml.attribute.email	Occasionally	email	Used with the userDetails attribute map to define the appropriate mapping from the incoming metadata.
login.saml.attribute.groups	Occasionally	group	Used with the userDetails attribute map to define the appropriate mapping from the incoming metadata.
login.saml.attribute.globalLogout	Occasionally	false	Used with the authenticationOnly and userDetails attribute map to determine whether logging out of PhixFlow should also trigger a logout of the identity provider.

Excerpt

name	LoginLoginActiveDirectory

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 enabled.
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.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 server.
login.activeDirectory.authenticationOnly	Occasionally	false	Whether only authentication is used from active directory, with user permissions and details being stored in PhixFlow.

Excerpt

name	Logging

Logging Configuration

valid 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?
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.

Versions Compared

Old Version 11

New Version 12

Key

Table of Contents

Installation Specific Properties

Logging Configuration

Page Comparison

Versions Compared

Old Version 11

New Version 12

Key

Installation Specific Properties

Login - Saml Configuration

Login - Active Directory Configuration

Logging Configuration