Configuring an app

Use the app's Configuration tab to set any configuration settings needed for the app to run successfully.

The app's Configuration tab provides a list of the configuration files for the app. At a minimum, the app.config file contains the settings that allow communication with the SOAR Platform and is mandatory. You can edit but not delete the app.config file. If needed by the app, you can create other files, such as a certificate file for communication to the SOAR Platform from the container, jinja templates, and ansible playbooks.

fn_utlities configuration screenshot

After you install an app, you configure it.
  1. If not done already, select Administrator Settings in the system menu then select the Apps tab.
  2. Click the app in the Apps page to open the app's Details tab. The Details tab provides the App Status. The completed steps have a green checkmark. For the app that you installed, the next step is to Configure and Test.
  3. Click the Configuration tab to open the App Settings page.
  4. Click app.config to open the configuration page. The File Annotations field displays the comments and any variables to be defined in the app.config file. This information was installed with the app.
  5. Edit the File Content field.

    For example, the File Annotations field displays #app_name_https_proxy=http://0.0.0.0:03128/. Add the line (without the #) to the File Content field and replace the IP address with the IP address of your proxy server.

    Refer to the app's documentation for details about any modifications needed in the app.config file.

  6. When done, click Test Configuration at the end of the page to verify that the settings are valid. If the test has an error, you see a red block at the end of the page, as shown in the following example. Click the Details link to review and correct any errors before proceeding.

    test_configuration_screenshot

  7. If your app stores its login credentials in the app.config file, you can place these login credentials in a secret for extra security.
    1. Click Add Secret.
    2. Enter the name of the secret you want to use for the password.
    3. Enter the password for the account in the Value field.
    4. Click Create.
    5. In the Secrets table, click the copy icon next to the secret name, as shown by the arrow in the following image.

    6. Paste the label in the app.config file where the password was located.
  8. If your app contains other files that are listed in the App Settings page, you can click the file name and edit its settings as necessary.
  9. Your app might need extra settings, such as certificate files for communication to the SOAR Platform from the container, jinja templates, and ansible playbooks. Check the app's document for information. If another configuration file is needed, click New File in the app's Configuration tab and follow the procedure.
    1. Enter a descriptive and unique name for the file.
    2. Enter a path where the file is to be located.
    3. Enter the purpose of the file in the File Description field.
    4. Enter or paste in the file's contents in the File Content field.

    You can add as many files as needed.

  10. Click Save and Push Changes.
  11. Go to the Details tab and click Deploy to deploy the app.