The documentation you're currently reading is for version 2.4.1. Click here to view documentation for the latest stable version.
Likely the easiest and quickest method of setting up StackStorm is via:
This page provides detailed instructions to ensure a successful installation.
For further details with examples, please refer to https://github.com/StackStorm/st2-docker/blob/master/README.md.
- Install the latest versions of Docker engine, and optionally
docker-compose. The installation instructions are located at https://www.docker.com/community-edition and https://docs.docker.com/compose/install respectively.
We require at least version 1.13.0 of Docker engine. If you choose to use
it must also be at least version 1.13.0.
- If you use Kubernetes, refer to https://github.com/StackStorm/st2-docker/blob/master/runtime/kubernetes-1ppc/README.md for more information.
stackstorm/stackstorm image comes pre-installed with the
If you install the image
stackstorm/stackstorm:2.3.2, then it comes pre-installed with the
StackStorm 2.3.2 release packages. Similarly, if you install the image
stackstorm/stackstorm:2.2.1, then it comes pre-installed with the StackStorm 2.2.1 release
stackstorm/stackstorm:latest image simply references the image with the highest
The mongo, rabbitmq, postgres and redis containers store their data on persistent storage.
Additionally, the stackstorm container persists the contents of
/var/log. If you do not wish to
persist this data, then remove the appropriate entries from
Assuming Docker engine and
docker-compose are properly installed, it is easy to run StackStorm.
First, clone the
st2-docker repository and change directory to
st2-docker. Unless specified
otherwise, all subsequent commands assume they are run within
git clone https://github.com/stackstorm/st2-docker cd st2-docker
to create the environment files under
conf/ used by
docker-compose. You may want to change
the values of the variables as necessary, but the defaults should be okay if you are not using any
off-cluster services (e.g. mongo, redis, postgres, rabbitmq).
Below is the complete list of available options that can be used to customize your container.
||StackStorm account username|
||StackStorm account password|
||MongoDB server hostname|
||MongoDB server port (typically 27017)|
||(Optional) MongoDB dbname (will use st2 if not specified)|
||(Optional) MongoDB username (will connect without credentials if this and MONGO_PASS are not specified)|
||(Optional) MongoDB password|
||RabbitMQ server hostname|
||RabbitMQ server port (typically 5672)|
||PostgreSQL server hostname|
||PostgreSQL server port (typically 5432)|
||Redis server hostname|
||Redis server port|
||(Optional) Redis password|
Third, start the containers:
docker-compose up -d
This will pull the required images from docker hub, and then start them.
When the time comes for you to stop the docker environment, run: