Before you install an app

Before you install an app, review the following list. The details for each bullet are provided in the installation and configuration procedures.
  • Verify that there is at least one App Host available. The App Host must be configured before you can run any apps. If configured, you can see the App Host that is listed in the Apps tab. If no App Host is listed or if the status is not online, see your administrator or the App Host Deployment Guide. You can install an app without an available App Host, but you cannot configure and run it.
  • Each app must be associated to a single App Host. If you have multiple App Hosts, you need to know your organization's policy as to which App Host to use for each app. For example, your organization uses a private repository for custom apps; therefore, you need to associate that app to the App Host configured for that repository.
  • Make sure you have access to apps. The access can be to the IBM Security® App Exchange or to a location in your environment where apps were downloaded.
  • If you have an integration server that is used to deploy apps, it is important to not run the same app in the integration server and from an App Host. The same app that is deployed using the Apps tab and deployed from the integration server can cause conflicts and unexpected behavior. If you do install an app that is already running on an integration server, remove the app from the integration server by using the pip uninstall command.

    You can download apps that support the App Host Kubernetes-based container environment. The SOAR Platform prevents you from installing non-container-based apps. If you need to run an app in a non-container environment, you can download to and deploy the app from an integration server. For more information, see the Integration Server Guide.

  • After you install an app, you might need to define specific variables in the app's configuration file, called app.config. The File Annotations field displays the comments and any variables to be defined in the app.config file. Additionally, read the app's documentation to determine what else, if anything, needs to be configured.
  • If an app contains account credentials, such as a username and password, the credentials are stored in the app.config file by default. You can also store all passwords in secrets for extra security. A secret contains the password but is stored in the container environment where it is not easily accessible. The secret name is entered in the app.config file instead of the password. By default, the secret for the API key account that is assigned to the app is also stored in a secret. App Host must be version 1.3 or later.
  • If you have the SOAR for MSSPs add-on, install and pair one or more App Hosts to each child organization that is to run apps. You do not pair an App Host with the configuration organization or global dashboard. You install apps from the configuration organization only then use a configuration push to send the apps to all child organizations. Each child organization enables only those apps it needs and pairs it with an App Host.