Installation Modes

The installer supports two primary modes and a set of component flags for fine-grained control.

Non-interactive mode

Runs a full installation without prompts. Installs Energy SOAR Base, Energy SOAR Automation, and Energy Logserver Data Node, then loads all sample data.

# ./install.sh -n

Interactive mode

Launches a wizard that asks which components to install and whether to initialize sample data.

# ./install.sh -i

Example session:

====> Do You wish to install the Energy Logserver data-node? [y/n] y
[..]
====> Do You wish to install the ENERGY SOAR Base, as well as the other Base dependencies? [y/n] y
[..]
====> Do You wish to install the ENERGY SOAR Automation, as well as the other Automation dependencies? [y/n] y
[..]
====> Do You wish to initialize Automation data? [y/n] y
[..]
====> Do You wish to initialize Base data? [y/n] y
[..]

Note

Initializing Energy SOAR Automation data creates an API user and configures it in Energy SOAR Base. This step is required for the two services to integrate.

Minimal mode

Installs with BerkeleyJE instead of Cassandra and Lucene instead of Elasticsearch. Suitable for resource-constrained single nodes.

# ./install.sh -M

Component flags

Use these flags with -n to select individual components instead of the full stack:

Flag

Effect

-a / --automation

Install Energy SOAR Automation node

-b / --base

Install Energy SOAR Base node

-e / --elasticsearch

Install Elasticsearch

-c / --cassandra

Install Cassandra

Database backend flags

Flag

Effect

-B / --berkeley

Use BerkeleyJE instead of Cassandra

-L / --lucene

Use Lucene index instead of Elasticsearch

Other flags

Flag

Effect

-u / upgrade

Update installed packages

-s / systeminfo

Print a basic system information report

-v / --verbose

Run all commands with verbose output