Editing the configuration file

Open the configuration file in the text-editor of your choice and update the [resilient] section with your Resilient platform host name/IP, credentials and the absolute path to the logs directory you created. The following table describes all the required and optional values that can be included in this section.

NOTE: If on a Windows system and you edit the file with Notepad, please ensure that you save it as type All Files to avoid a new extension being added to the filename, and use UTF-8 encoding.

Parameter Description
logfile Name of rotating logfile that is written to logdir. Default is app.log.
logdir Path to directory to write log files. If not specified, program checks environment variable DEFAULT_LOG_DIR for path. If that is not set, then defaults to a directory called “log” located wherever Resilient Circuits is launched.
log_level Level of log messages written to stdout and the logfile. Levels are: CRITICAL, ERROR, WARN, INFO (default), and DEBUG.
host Required. IP or hostname for the Resilient platform.
org Name of the Resilient organization. Required only if the user account is used with more than one Resilient organization.
email Resilient user account for authenticating to the Resilient platform. It is recommended that this account is dedicated to extensions. This is required unless using a Resilient API key account.
password Password for the Resilient user account.
api_key_id

Resilient API key account for authenticating to the Resilient platform. It is only available with V33 or later of the Resilient platform and Resilient Circuits. The ID is a long string, which is provided by the Resilient system administrator. This is required unless using a Resilient user account.

Not valid for integration servers connected to a Resilient platform with the MSSP add-on.

api_key_secret Secret for the Resilient API key account. It is also provided by the Resilient system administrator. The secret must be entered in app.config.
no_prompt_password

If set to False (default) and the “password” value is missing from this config file, the user is prompted for a password.

If set to True, the user is not prompted.

stomp_port Port number for STOMP. Default is 65001.
componentsdir Path to directory containing additional Python modules. Resilient Circuits can load custom components from this directory. Typically this option is only used by extension developers.
noload
Optional. Comma-separated list of:
  • Installed components that should not be loaded.
  • Module names in the componentsdir that should not be loaded.

Example: my_module, my_other_module, InstalledComponentX

proxy_host IP or Host for Proxy to use for STOMP connection. By default, no proxy is used.
proxy_port Port number for Proxy to use for STOMP connection. By default, no proxy is used.
proxy_user Username for authentication to Proxy to use for STOMP connection. If a proxy_host is specified and no proxy_user specified, then assumed no authentication is required.
proxy_password Password for authentication to Proxy to use for STOMP connection. Used in conjunction with proxy_user.
cafile

Path and file name of the PEM file to use as the list of trusted Certificate Authorities for SSL verification when the Resilient platform is using untrusted self-signed certificates.

If not using a trusted certificate, cafile must be set to False.

If there is a PEM file, use a second instance of cafile to set to True or False. If set to False, certificate verification is not performed and the PEM file is used. If set to True (default), allow only trusted certs.

NOTE: If you enter values for the Resilient user account fields and the API Key account fields, the API key account is used by default.

If you wish to pull an environment value that you previously defined, enter $<key> in the app.config file. For example, you could define “resilient_secret” as an environment variable using export resilient_secret=Passw0rd at the command line or in a shell script. You would then add the following to the app.config file, where the $ indicates to Resilient Circuits that it needs to translate the environment variable and use its set value to set the value of api_key_secret in this example.
[resilient]
api_key_secret=$resilient_secret