Table of Contents
Table of Contents | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Configuration
...
Files
Excerpt | ||
---|---|---|
| ||
Configuration options can be specified in a number of different ways. These take precedence in the following order:
Keystore FilesOptionally, secrets such as database passwords can be kept encrypted in external secret files. Refer to Configure a Keystore and Aliases for instructions on how to configure this before proceeding with the installation. Environment form of property namesAs operating systems have stricter rules around valid characters in environment variable names, and prefer them to be in upper case, when using environment variables the property name should be converted as follows:
For instance “db.url” would be looked up as “DB_URL” when resolved from environment variables. Guidelines and advice for configuration
|
Configuration Properties
Note |
---|
Java properties files use the \ as an escape character. When configuring paths on Windows either use forward slashes (e.g. c:/apps/phixflow) or double up the backslashes (e.g. c:\\apps\\phixflow). Other properties can be referenced within a property value using the syntax ${property} |
Excerpt | |||
---|---|---|---|
| |||
Installation Specific PropertiesThese 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.
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 install in the User Details screen. |
install.user.firstname | Often | admin | First name of the default administrator user created during installation. Can be updated after install in the User Details screen. |
install.user.lastname | Often | admin | Last name of the default administrator user created during installation. Can be updated after install 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 |
Configuration Properties
Note |
---|
Java properties files use the backslash \ as an escape character. When configuring paths on Windows either use forward slashes (e.g. c:/apps/phixflow) or double backslashes (e.g. c:\\apps\\phixflow). Other properties can be referenced within a property value using the syntax ${property} |
Excerpt | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Installation Specific PropertiesThese properties are required for installation to succeed and are populated in the database. After installation is complete the values are not used any further.
|
Excerpt | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||
Database Connection ConfigurationThese are the basic settings to enable connection to the Phixflow database. Keystore ConfigurationThe keystore must be configured and populated during installation before Phixflow is first started. Using a keystore is optional. Property Requires Configuration Default Value Explanation keystore.file Optional /opt/secure/keystore.jks Location of the keystore file. Only used if the keystore password is provided, otherwise use of the keystore is disabled. | Optionalphixflow-keystore-password
| ||||||||||||||||||||||||
Excerpt | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Excerpt | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Logging Configuration
logging.file.phixflow.base=phixflow Occasionally Base name of the standard phixflow log file logging.file.security.base=security Occasionally Base name of the security log file logging.stdout.level=OFF Occasionally
Rarely
Name of the key containing the keystore password. pepper.key.name Rarely pepperKey Name of the key containing the pepper key which is used for encrypting passwords api.key.name Rarely phixflow-api-key Name of the key containing the api key which is used for signing api credentials. | |||||||||||||||||||||||||
Excerpt | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
|
Excerpt | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Keystore ConfigurationThe keystore must be configured and populated during installation before PhixFlow is first started. Using a keystore is optional.
|
Excerpt | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Login - Basic ConfigurationPhixFlow 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.
|
Excerpt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Login - Saml ConfigurationPhixFlow 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.
|
Excerpt | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
Login - Active Directory ConfigurationPhixFlow 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.
|
Excerpt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Logging Configuration
logging.root.level=INFO Rarely configures the default minimum log level that can be generated logging.file.phixflow.main=${
logging.file.security.main=${logging.file.directory}/${logging.file.security.base}.log Rarely Defines the path and name of the security log file. logging.file.security.archive=
logging.file.phixflow.level=ALL Rarely Used to control the minimum log message level permitted to be output to standard log file logging.file.security.level=ALL Rarely Used to control the minimum log message level permitted to be output to security log file
|