Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
241 lines (153 sloc) 6.96 KB

Ubuntu Xenial (16.04)

System Requirements

Please check the :doc:`supported versions and system requirements <system_requirements>`.

Minimal Installation

Install Dependencies

Install MongoDB, RabbitMQ, and PostgreSQL:

sudo apt-get update
sudo apt-get install -y gnupg-curl
sudo apt-get install -y curl

# Add key and repo for the latest stable MongoDB (3.4)
wget -qO - | sudo apt-key add -
sudo sh -c "cat <<EOT > /etc/apt/sources.list.d/mongodb-org-3.4.list
deb $(lsb_release -c | awk '{print $2}')/mongodb-org/3.4 multiverse
sudo apt-get update

sudo apt-get install -y crudini
sudo apt-get install -y mongodb-org
sudo apt-get install -y rabbitmq-server
sudo apt-get install -y postgresql

For Ubuntu Xenial you may need to enable and start MongoDB.

sudo systemctl enable mongod
sudo systemctl start mongod

Setup Repositories

The following script will detect your platform and architecture and setup the appropriate |st2| repository. It will also add the the GPG key used for package signing.

curl -s | sudo bash

Install |st2| Components

sudo apt-get install -y st2 st2mistral

Setup Datastore Encryption

Setup Mistral Database

Configure SSH and SUDO

Start Services


Configure Authentication

The reference deployment uses a file-based authentication provider for simplicity. Refer to :doc:`/authentication` to configure and use PAM or LDAP authentication backends.

To set up authentication with file-based provider:

  • Create a user with a password:

    # Install htpasswd utility if you don't have it
    sudo apt-get install -y apache2-utils
    # Create a user record in a password file.
    echo 'Ch@ngeMe' | sudo htpasswd -i /etc/st2/htpasswd st2admin

Install WebUI and Setup SSL Termination

NGINX is used to serve WebUI static files, redirect HTTP to HTTPS, provide SSL termination, and reverse-proxy st2auth and st2api API endpoints. To set it up: install the st2web and nginx packages, generate certificates or place your existing certificates under /etc/ssl/st2, and configure nginx with |st2|'s supplied :github_st2:`site config file st2.conf <conf/nginx/st2.conf>`.

|st2| depends on Nginx version >=1.7.5. Ubuntu has an older version in the package repositories, so you will need to add the official Nginx repository:

# Add key and repo for the latest stable nginx
sudo apt-key adv --fetch-keys
sudo sh -c "cat <<EOT > /etc/apt/sources.list.d/nginx.list
deb $(lsb_release -c | awk '{print $2}') nginx
sudo apt-get update

# Install st2web and nginx
# note nginx should be > 1.4.6
sudo apt-get install -y st2web nginx

# Generate self-signed certificate or place your existing certificate under /etc/ssl/st2
sudo mkdir -p /etc/ssl/st2
sudo openssl req -x509 -newkey rsa:2048 -keyout /etc/ssl/st2/st2.key -out /etc/ssl/st2/st2.crt \
-days XXX -nodes -subj "/C=US/ST=California/L=Palo Alto/O=StackStorm/OU=Information \

# Remove default site, if present
sudo rm /etc/nginx/conf.d/default.conf
# Copy and enable the supplied nginx config file
sudo cp /usr/share/doc/st2/conf/nginx/st2.conf /etc/nginx/conf.d/

sudo service nginx restart

If you modify ports, or url paths in the nginx configuration, make the corresponding changes in the st2web configuration at /opt/stackstorm/static/webui/config.js.

Use your browser to connect to https://${ST2_HOSTNAME} and login to the WebUI.

Setup ChatOps

If you already run a Hubot instance, you can install the hubot-stackstorm plugin and configure |st2| environment variables, as described below. Otherwise, the easiest way to enable :doc:`StackStorm ChatOps </chatops/index>` is to use the st2chatops package.

  • Validate that the chatops pack is installed, and a notification rule is enabled:

    # Ensure chatops pack is in place
    ls /opt/stackstorm/packs/chatops
    # Create notification rule if not yet enabled
    st2 rule get chatops.notify || st2 rule create /opt/stackstorm/packs/chatops/rules/notify_hubot.yaml
  • Add NodeJS v10 repository:

    curl -sL | sudo -E bash -
  • Install the st2chatops package:

    sudo apt-get install -y st2chatops
  • Start the service:

    sudo service st2chatops start
  • Reload st2 packs to make sure chatops.notify rule is registered:

    sudo st2ctl reload --register-all
  • That's it! Go to your Chat room and begin ChatOps-ing. Read more in the :doc:`/chatops/index` section.

A Note on Security

Upgrade to |ewc|

# Set up Extreme Workflow Composer repository access
curl -s https://${EWC_LICENSE_KEY} | sudo bash
# Install Extreme Workflow Composer
sudo apt-get install -y bwc-enterprise
sudo st2ctl restart

What's Next?

You can’t perform that action at this time.