The documentation you're currently reading is for version 2.6.0. Click here to view documentation for the latest stable version.
One of the quickest ways to get StackStorm running is using Docker. This page will show you the basics of how to use StackStorm with Docker.
We require at least version 1.13.0 of Docker engine. If you choose to use
docker-composeit must also be at least version 1.13.0.
If you use Kubernetes, check the Kubernetes README for more information.
stackstorm/stackstorm image comes pre-installed with the
We use version tags, so if you install the image
stackstorm/stackstorm:2.3.2, then it has the
StackStorm 2.3.2 release packages. Similarly, if you install image
then it has the StackStorm 2.2.1 release packages. The
stackstorm/stackstorm:latest image simply
references the image with the highest version number. Don’t worry, this will still be a stable GA
release, not a nightly build.
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, getting started is easy.
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. Prior to doing so, you
may want to change some variables as necessary. 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.
To stop the containers, run: