Docker Compose Installation

License Terms

For the use of Rasa X the Rasa X License Terms apply. For the use of Rasa Enterprise the Rasa Enterprise License Terms apply.

In this installation method, Rasa X is deployed on a server as a set of Docker containers.

An install script is available for servers that meet the hardware and OS requirements. For other operating systems, you can install Rasa X via Docker Compose manually.

Requirements
#

note

Rasa X is intended to be deployed on a server and not to a personal/local machine. Deploying on a server is recommended because Rasa X is designed to stay up continuously, and not to be frequently stopped or restarted.

Hardware & OS Requirements
#

Here are the minimum and recommended hardware specs and OS requirements:

Port Requirements
#

When creating the server, make sure the following ports of are open:

Supported Browsers
#

The web interface aims to support browsers that meet the following criteria:

• 0.2% market share

• not Internet Explorer
• not Opera Mini

Docker Compose Install Script
#

Watch the Rasa Masterclass video below to follow along with the install script instructions:

(Ep #9 - Rasa Masterclass) Improving the assistant: Setting up the Rasa X | Rasa 1.8.0 - YouTube

(Ep #9 - Rasa Masterclass) Improving the assistant: Setting up the Rasa X | Rasa 1.8.0 Rasa

1. Download
#

Download the install script on the server:

curl -sSL -o install.sh https://storage.googleapis.com/rasa-x-releases/1.0.4/install.sh

installing edge vs. stable

The above command downloads the install script for the latest stable release of Rasa X. To download the install script for the latest edge release of Rasa X, run the following instead:

curl -sSL -o install.sh https://storage.googleapis.com/rasa-x-releases/latest/install.sh

2. Install
#

To install all of the files into the default folder, /etc/rasa, run:

sudo bash ./install.sh

note

To choose your own installation folder instead of /etc/rasa, set the RASA_HOME environment variable:

export RASA_HOME=~/rasa/dir
sudo -E bash ./install.sh # -E will preserve the environment variable you set

Replace /etc/rasa with ${RASA_HOME} in further commands.

3. Start
#

Start up Rasa X and wait until all containers are running (-d will run Rasa X in the background):

cd /etc/rasa
sudo docker-compose up -d

4. Access
#

Set your admin password:

cd /etc/rasa
sudo python rasa_x_commands.py --update create admin <USER><PASSWORD>

Unless the RASA_X_USERNAME environment variable was configured, the value of <USER> should be set to `admin.

While using Rasa Enterprise, you can use this command on the server to create a new admin account at any time, by removing the --update argument. See Role-Based Access Control for more information about assigning and configuring user permissions.

Navigate to the hostname or IP where your server is reachable and log in using your newly created password.

5. Optional: Activate Rasa Enterprise
#

Rasa X can be upgraded to Rasa Enterprise by uploading a valid license. To learn how to do this, please visit the Product Activation section.

Docker Compose Manual Install
#

We provide template docker-compose files which you can use directly. The Docker images for Rasa X are freely available via Docker Hub. The images for Rasa Enterprise are hosted on a private registry and are accessible with an enterprise license. If you have a Rasa Enterprise license, please see the Enterprise instructions where applicable.

1. Prerequisites
#

Make sure python3, docker, and docker-compose are installed on your server. Detailed instructions can be found in the Docker documentation.

You should be able to run the following command(s):

python3 --version && docker -v && docker-compose -v

Note that your python version should be above 3.6 to use Rasa and Rasa X.

2. Set Project Directory
#

Create the project directory and switch to it:

mkdir /etc/rasa
cd /etc/rasa

3. Download
#

Download the Rasa X docker-compose and commands files:

wget -qO docker-compose.yml https://storage.googleapis.com/rasa-x-releases/1.0.4/docker-compose.yml
wget -qO rasa_x_commands.py https://storage.googleapis.com/rasa-x-releases/1.0.4/rasa_x_commands.py

Also download the Nginx configuration files:

mkdir nginx-config-files
wget -qO nginx-config-files/nginx.conf https://storage.googleapis.com/rasa-x-releases/1.0.4/nginx-config-files/nginx.conf
wget -qO nginx-config-files/ssl.conf.template https://storage.googleapis.com/rasa-x-releases/1.0.4/nginx-config-files/ssl.conf.template
wget -qO nginx-config-files/rasax.nginx.template https://storage.googleapis.com/rasa-x-releases/1.0.4/nginx-config-files/rasax.nginx.template

4. Configure
#

Docker Environment File
#

Create the docker environment file .env in your project directory with the following content:

# rasax specific settings
RASA_X_VERSION="1.0.4"
RASA_VERSION="2.8.31-full"
RASA_TOKEN=<random_string>
RASA_X_TOKEN=<random_string>
PASSWORD_SALT=<random_string>
JWT_SECRET=<random_string>
RABBITMQ_PASSWORD=<random_string>
DB_PASSWORD=<random_string>
REDIS_PASSWORD=<random_string>
RASA_TELEMETRY_ENABLED=false

installing edge vs. stable

The RASA_X_VERSION="1.0.4" tag will install the lastest stable release of Rasa X. If you prefer the latest edge release of Rasa X, set RASA_X_VERSION="latest".

You can also choose any compatible Rasa X and Rasa Open source versions according to the Compatibility Matrix.

For each <random_string> please use a distinct, randomly generated, secure character sequence for each variable. A convenient way of generating random strings is using openssl:

openssl rand -base64 16

For more information about these environment variables and others used by Rasa X, see Environment Variables.

note

The PASSWORD_SALT is used to hash passwords. If you change this variable after setting it, you will have to create new logins for each of your users.

Credentials
#

Create a credentials file credentials.yml in your project directory containing:

rasa:
  url: ${RASA_X_HOST}/api

These are the credentials used for messaging with the bot via the Rasa X UI. You can also add credentials for other messaging and voice channels such as your custom connector or the REST input channel.

Endpoints
#

Create an endpoints file endpoints.yml in your project directory containing:

models:
  url: ${RASA_MODEL_SERVER}
  token: ${RASA_X_TOKEN}
  wait_time_between_pulls: ${RASA_MODEL_PULL_INTERVAL}

tracker_store:
  type: sql
  dialect:"postgresql"
  url: ${DB_HOST}
  port: ${DB_PORT}
  username: ${DB_USER}
  password: ${DB_PASSWORD}
  db: ${DB_DATABASE}
  login_db: ${DB_LOGIN_DB}

lock_store:
  type:"redis"
  url: ${REDIS_HOST}
  port: ${REDIS_PORT}
  password: ${REDIS_PASSWORD}
  db: ${REDIS_DB}

cache:
  type:"redis"
  url: ${REDIS_HOST}
  port: ${REDIS_PORT}
  password: ${REDIS_PASSWORD}
  db: ${REDIS_CACHE_DB}

event_broker:
  type:"pika"
  url: ${RABBITMQ_HOST}
  username: ${RABBITMQ_USERNAME}
  password: ${RABBITMQ_PASSWORD}
  queues:
    - ${RABBITMQ_QUEUE}

action_endpoint:
  url: ${RASA_USER_APP}/webhook
token:""

If you want to know more about the environment variables used here, see Environment Variables.

Deployment Environments
#

Create an environments file at environments.yml in your project directory containing:

rasa:
  production:
    url: http://rasa-production:5005
    token: ${RASA_TOKEN}
  worker:
    url: http://rasa-worker:5005
    token: ${RASA_TOKEN}

If you plan on using Rasa Enterprise, you can also add further environments as described in Deployment Environments.

Mounted Directories
#

Create a few empty folders that we will mount into the containers:

mkdir /etc/rasa/auth
mkdir /etc/rasa/certs
mkdir /etc/rasa/credentials
mkdir /etc/rasa/models
mkdir /etc/rasa/logs
mkdir /etc/rasa/db

Permissions on Mounted Directories
#

Set group and permissions of the mounted directories:

The Rasa containers are following Docker’s best practices and are not running as root user. Hence, please make sure that the root group has read and write access to the following directories and their content:

• /etc/rasa/credentials.yml
• /etc/rasa/endpoints.yml
• /etc/rasa/environments.yml
• /etc/rasa/auth
• /etc/rasa/certs
• /etc/rasa/credentials
• /etc/rasa/models
• /etc/rasa/logs

To set the permissions and group for everything in /etc/rasa you can use this command, but make sure to correct it for the /etc/rasa/db directory as described in the next step:

sudo chgrp -R root /etc/rasa/* && sudo chmod -R 770 /etc/rasa/*

If you are mounting different or extra directories, please adapt their permissions accordingly.

Postgres Database Storage
#

Configure persistent Postgres database storage

On Linux, a local directory is used for persistent Postgres database storage.

You must set the correct owner and permissions of the database persistence directory using this command:

sudo chown -R 1001 /etc/rasa/db && sudo chmod -R 750 /etc/rasa/db

(Optional) Custom Action Server
#

If you are using custom actions, make sure to follow the instructions to connect a custom action server.

If you don’t want to configure custom actions yet, make sure to add this variable to your .env to use the demo app image:

RASA_X_DEMO_VERSION=<rasa_x_version>

5. Start
#

Start up Rasa X and wait until all containers are running (-d will run Rasa X in the background):

sudo docker-compose up -d

6. Access
#

Set your admin password with this command from your project directory:

sudo python rasa_x_commands.py create --update admin <USER><PASSWORD>

Unless the RASA_X_USERNAME environment variable was configured, the value of <USER> should be set to `admin.

While using Rasa Enterprise, you can use this command on the server to create a new admin account at any time, by removing the --update argument. See Role-Based Access Control for more information about assigning and configuring user permissions.

Navigate to the hostname or IP where your server is reachable and log in using your newly created password.

7. Optional: Activate Rasa Enterprise
#

Next Steps
#

• Deploy your assistant using Rasa X.
• Set up Integrated Version Control to connect your Rasa X instance to a remote Git repository.