Edit

WorkFusion configuration files

The complete configuration consists of two files: config.yml and secrets.yml. The files contain simple key-value pairs, so they are comprehensive and easy to edit:

• config.yml

  In this configuration file we define server hostnames, service ports, runtime user, home directory, execution parameters and change some other options. The configuration file is thoroughly commented to explain each of the parameters. The most important parameters are described below, and you will also find server-specific configuration explained in the relevant sections.

• secrets.yml

  This configuration file serves to store any sensitive data, such as database credentials, path to license file, paths to TLS certificates, and so on.

Configure parameters in config.yml

caution

The configuration file is filled in once during the preparation to the DB Server installation and used for all other servers, except for VDS Slave.

The configuration file contains a few common parameters shared by all servers. For example, wf_user (runtime user for all software), install_dir(installation directory), and server host names. While wf_user and install_diralready have reasonable defaults, the hostnames must be defined by the end user. config.yml has additional comments alongside these parameters.

Name	Description	Default
install_dir	Global path where all packages will be installed. Installation directory must not contain the dot character (.) due to limitations of UIMA library! For example, the following path cannot be processed correctly: /opt/worfusion-8.5.0 The path must be defined. Make sure, that the path defined is correct.	/opt/workfusion
automate_system_packages_install	Perform installation of required packages on preinstall phase. The value should be set to true.Do not change the value only if the installation will be performed without access to packages repository (for example, these components have been installed already)	false
automate_preinstall_steps	Perform root steps in preinstall phase, such as creating user, group, installation directory, adjusting system properties and others. The value should be set to true for unattended execution.Do not change the value only if you are going to do the root steps manually (see Run System Preparation Actions Manually instruction below )	false
https_enabled	Enable connection over HTTPS. Affects all components.	true
vds_master_hostname	DNS name of VDS Master server.
vds_slave_hostname	DNS name of VDS Slave server.
vds_nfs_hostname	Adjust this property if you use an external NFS server Set this option only if VDS server will be installed.
vds_nfs_share	Adjust this property if you use an external NFS server Set this option only if VDS server will be installed.
wf_s3_backend	Value has two possible options to choose s3 backend: 'minio' or 'riak' Since 9.1 default s3 object storage server is Minio.	riak
s3_external_endpoint	Link to an external S3 storage. The parameter should be specified only in case the customer wants to use own S3 storage, which is not provided as a component WorkFusion platform. In case of secure connection to S3 over https, the SSL certificates should be provided by the customer.
rpa_manager_nodes	Define RPA Nodes. And nodes host (hostname), port (port on which RPA will listen to), and count. This option is available in secrets.yml .	rpa_manager_nodes: - { host: "rpa-hub.example.com", port: "443", count: "2" }
rpa_manager_client_authorization	App Server Port-install check. Depends on whether RPA Manager configured in non-SSL mode or SSL mode. By default it expects SSL mode (true).	rpa_manager_client_authorization: true

Name	Description	Example
apm_hostname	DNS name of APM server.	apm.server.com
app_hostname	DNS name of WorkFusion host.	wf1.server.com
db_hostname	DNS name of database server.	db1.server.com
ocr_hostname	DNS name of OCR server.	ocr1.server.com
vds_master_hostname	DNS name of VDS master server.	ml1.server.com
vds_slave_hostname	DNS name of VDS slave server. If using clustered VDS, there may be multiple slaves, so you will need to override this for each of them. See installation guide for details. If using standalone VDS, set this to the same value as `vds_master_hostname`.	ml2.server.com
bi_hostname	DNS name of BI server.	bi.server.com

If one server has a few host roles, the server must have all domain names that match the host roles it performs.

All domain names must be specified in the config.yml configuration file.

Precautions are as follows:

• Make sure to use the same wf_user on all servers.
• Don't change wf_user and install_dir when upgrading an exisiting installation.

Configure parameters in secrets.yml

In secrets.yml, edit these parameters:

Name	Description	Default
s3_access_key	Access key for S3 server	-
s3_secret_key	Secret key for S3 server	-
marathon_web_user	Marathon is protected by HTTP authentication mechanism. Change this options to replace the default user (recommended).
marathon_web_password	Marathon is protected by HTTP authentication mechanism. Change this option to replace the default password (recommended).
mesos_web_user	Mesos is protected by HTTP authentication mechanism. Change this option to replace the default user (recommended).
mesos_web_password	Mesos is protected by HTTP authentication mechanism. Change this option to replace the default password (recommended).
wf_username	Default username for Control Tower	workfusion
wf_password	Default password bcrypt hash for Control Tower.	workfusion