Docker-Compose Quick Install

Rasa X is deployed to a server as a set of Docker containers.

If you get stuck, email support@rasa.com with subject “deployment help” and we’ll jump on a call with you! We’re working to make deployment easier and would love your feedback.

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


Installation

Hardware & OS Requirements

We recommend 2-6 vCPUs and 8 GB RAM for optimal performance. 4 GB RAM is the bare minimum. Your server should also have at least 100 GB disk space available. You will need a server running a modern Linux distribution that can run Docker. The following OS’s work with the quick installation script below:

  • Debian 9
  • Ubuntu 16.04 / 18.04

and python3, docker, and docker-compose should be available for download (they will be installed via the script).

For any other Linux operating systems, please follow the Manual Installation instructions. As long as Docker is available for your operating system, Rasa X should run fine.

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

Port Service Description
22 SSH SSH access.
80 HTTP Web application access.
443 HTTPS Web application over HTTPS access (optional)

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

  • > 0.2% market share
  • not Internet Explorer
  • not Opera Mini

Quick Installation

  1. If you have an enterprise license, copy it to your server. Skip this step if you are using Rasa X Community Edition.

    $ scp rasa-x-ee-license.yml example.com:~/rasa-x-ee-license.yml
    

    Make sure the license is in your working directory on the server before proceeding to the next step.

  2. Download and run the install script on the server:

    To install all of the files into the default folder, /etc/rasa, run the following command, replacing <rasa_x_version> with the version of Rasa X you would like to install.

    $ curl -sSL -o install.sh https://storage.googleapis.com/rasa-x-releases/<rasa_x_version>/install.sh
    $ sudo bash ./install.sh
    

    To choose your own installation folder instead, set the RASA_HOME environment variable:

    $ curl -sSL -o install.sh https://storage.googleapis.com/rasa-x-releases/<rasa_x_version>/install.sh
    $ export RASA_HOME=~/rasa/dir
    $ sudo bash -E ./install.sh  # -E will preserve the environment variable you set
    

    You will be prompted to accept the terms and conditions. Read the terms, then hit return to continue. If installing CE, you will be asked whether you agree to metrics tracking; hit return to opt in, or type NO to disagree.

  3. Replace the default app image with the image of your custom action server. See this guide for more information on how to do so.

    To avoid your changes in the docker-compose file being overwritten when you update versions, you should not apply your changes to docker-compose.yml. Instead, create a new file called docker-compose.override.yml inside your ${RASA_HOME} and apply your changes there. Docker will automatically take that file into account and override any attributes in docker-compose.yml with changes from the override file.

    The contents of docker-compose.override.yml might look like this:

    version: '3.4'
    services:
      app:
        image: <your image>
    
  4. Start Rasa X:

    $ cd ${RASA_HOME}
    $ sudo docker-compose up -d
    
  5. Set your password:

    If you are using Rasa X CE, please set your admin password:

    $ cd ${RASA_HOME}
    $ sudo python rasa_x_commands.py create --update admin me <PASSWORD>
    

    Rasa X EE users should instead create an admin user with a username and a password:

    $ cd ${RASA_HOME}
    $ sudo python rasa_x_commands.py create admin <USER> <PASSWORD>
    
  6. Navigate to the hostname or IP where your server is reachable and log in using your newly created password.

    Once you’re logged in, you can set up Integrated Version Control to connect your Rasa X instance to a git repository for easy versioning of your assistant.