Skip to main content

Install a Local App

There are multiple ways to get a local app installed on a configured environment.

  • with a VS Code Task (recommended)
  • using the Editor bar button
  • with the File Explorer context menu
  • Packaged upload via the Apps view

Which one works best for you depends on your usual workflow. We recommend the VS Code Task workflow as it can be used with keybindings and offers the best developer experience after initial setup.

caution

By default, it is expected that the directory name of the SOAR App corresponds to the name of the App Metadata file.
For example the app with the root folder windowsdefenderatp has a corresponding windowsdefenderatp.json. If that is not the case, only the VS Code Task is supported as a deployment method.

VS Code Task​

The extension provides a custom SOAR App Build Task that allows to install a local app to the configured SOAR instance via REST API. This procedure works for both on-prem and cloud SOAR. The task will transparently create a tar bundle of the app code and upload it to the instance.

The example .vscode/tasks.json below configures the soarapp build task as default and indicates that the Checkphish app is not at the root of the workspace but in the checkphish subfolder.

{
    "version": "2.0.0",
    "tasks": [
        {
            "type": "soarapp",
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "problemMatcher": [],
            "label": "soarapp: Checkphish",
            "cwd": "./checkphish"
        }
    ]
}

Custom App Metadata File Name​

There can be cases in which the folder name of the app does not correspond to the name of the app metadata file. In this case, provide the name of the metadata file inside the tasks.json under the appMetadata key.

{
    "version": "2.0.0",
    "tasks": [
        {
            "type": "soarapp",
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "problemMatcher": [],
            "label": "soarapp: Checkphish",
            "appMetadata": "my_app.json"
        }
    ]
}

Editor Bar​

File Explorer Context Menu​

Apps View Upload​

caution

This works only if you already have your SOAR app packaged as a tar.gz file