The documentation you're currently reading is for version 3.8dev. Click here to view documentation for the latest stable version.
Ready to install StackStorm? Here’s an overview of how to get your system up and running.
StackStorm is distributed as RPMs and Debs for RedHat/CentOS and Ubuntu Linux systems, and as Docker images. You can either use a script to automatically install and configure all components on a single system, or you can follow the manual instructions for your OS.
Here’s an overview of the options:
One-line Install: Run our installation script for an opinionated install of all components on a single system. This is a our recommended way to get started. See the Quick Install section below for details.
Manual Installation: Have custom needs? Maybe no Internet access from your servers? Or just don’t like using scripted installs? Read the manual installation instructions for your OS (Ubuntu 18, Ubuntu 20, RHEL/CentOS 7, RHEL/RockyLinux/CentOS 8) and adapt them to your needs. Here’s some additional guidance for setting up an internal mirror for the StackStorm repos.
Vagrant / Virtual Appliance: Vagrant / OVA is a quick and easy way to try StackStorm. It’s already pre-installed, tested and shipped as a virtual image and so saves your time going through time-consuming installation and configuration steps. Works best as a testing, pack development or demo system and recommended to get familiar with StackStorm platform.
vagrant init stackstorm/st2 && vagrant upis all you need to get started. See Vagrant for more detailed instructions.
Docker: StackStorm is supported on Docker - check out our Docker instructions. It’s one of the quickest way to get StackStorm running and useful for trying the platform and development.
Ansible Playbooks: If you are an Ansible user, check these Ansible Playbooks for installing StackStorm. Ideal for repeatable, consistent, idempotent installation of StackStorm.
Puppet Module: For Puppet users, check this Puppet Module for installing StackStorm. A robust and idempotent method of installing and configuring StackStorm.
Kubernetes (HA) Entrusting business critical automation tasks to a system like StackStorm leads to higher demands on that system. StackStorm can run in a High Availability mode to ensure these needs. StackStorm HA Cluster in Kubernetes - BETA automates entire complex infrastructure as a reproducible blueprint.
Choose the option that best suits your needs.
Upgrading to Extreme Workflow Composer? This is installed as a set of additional packages on top of StackStorm. You can either install StackStorm + Extreme Workflow Composer in one go, or add the Extreme Workflow Composer packages to an existing StackStorm system. If you are using Extreme Workflow Composer, you can also add Network Automation Suites. Read the Installing Extreme Workflow Composer documentation for more.
Grab a clean 64-bit Linux system that fits the system requirements. Make sure that
curl is up to date using
sudo apt-get install curl
on Ubuntu, or
sudo yum install curl nss on RHEL/RockyLinux/CentOS. Then run this command:
bash <(curl -sSL https://stackstorm.com/packages/install.sh) --user=st2admin --password=[email protected]
This is an opinionated installation of StackStorm. It will download and install all components, as per the single host reference deployment. It assumes that you have a clean, basic installation of Ubuntu or RHEL/RockyLinux/CentOS.
If you are trying to install StackStorm on a server with other applications, or local customisations, you may run into problems. In that case, you should use one of the manual installation methods.
The script itself is not idempotent. If you try to re-run the script on top of a failed installation, it will fail. Start again with a clean system, or switch to a manual install.
If you’re installing behind a proxy, just export the proxy ENV variables
no_proxy before running the script.
export http_proxy=http://proxy.server.io:port export https_proxy=http://proxy.server.io:port export no_proxy=localhost,127.0.0.1
In case of MITM proxy, you may need to export additional
proxy_ca_bundle_path, see Installing Packs from Behind a Proxy.
If you have problems accessing the Web UI on a RHEL 7/CentOS 7 system, check the system firewall settings.
For security reasons, the installer script enables authentication and generates random passwords for dependent services such as MongoDB.
If for some reason (e.g. debugging), you need to access those services directly you can find
passwords in the config files -
/etc/st2/st2.conf for MongoDB and RabbitMQ password.
Other Installation Options
For more details on reference deployments, or OS-specific installation instructions, see below: