Installing Resilient Circuits

Install and configure the Resilient Circuits framework as follows:
  1. Use SSH to access the command line interface on the Resilient integration server.
  2. If you do not have an OS user for the service, create one now. To create an OS user called integration on RHEL Linux, use the following command:
    sudo adduser integration --home /home/integration
  3. Install Resilient Circuits using the following command. This command also installs its dependent modules.
    pip install --upgrade resilient-circuits
  4. Verify that the Python modules, resilient and resilient-circuits, are installed.
    pip list
  5. Auto-generate the app.config file as follows. This creates a directory, .resilient, in your home directory with a file in it called app.config, which is the default and preferred option. The Resilient Circuits configurations are maintained in the app.config file.
    resilient-circuits config -c
    The output of the command shows the directory where it installed the config file. By default, this directory is:
     /home/integration/.resilient/app.config
    If you require the configuration file to be in a different location or have a different name, you need to store the full path to the environment variable, APP_CONFIG_FILE.
    resilient-circuits config -c /path/to/<filename>.config
  6. Open the app.config file in your text editor. If using nano, the command would be:
    nano /home/integration/.resilient/app.config
  7. Replace the contents with the following settings. Your actual path names may be different.
    [resilient] 
    host=localhost 
    port=443 
    email=resilient_account@example.com 
    password=ResilientPassword 
    org=Dev 
    # componentsdir=/home/resadmin/.resilient/components 
    logdir=/home/resadmin/.resilient 
    logfile=app.log 
    loglevel=INFO

    For authentication, determine if you are using a Resilient user account or API key account then enter the actual email and password, or api_key_id and api_key_secret, but not both. See Editing the configuration file for a details.

    Use the actual Resilient organization name for the org name.

    See Editing the configuration file for a detailed description of all the app.config settings, especially cafile if your Resilient platform does not have a valid certificate.

  8. Save the file.
  9. Test your installation by running the following command:
    resilient-circuits run
    Resilient Circuits starts, loads its components, and continues to run until interrupted. If it stops immediately with an error message, check your configuration values and retry.

You are ready to download and deploy extension packages.