Installation

Rasa X version 0.33.0 or higher is only compatible with Rasa Open Source 2.x. If you are on Rasa Open Source 1.x, please check the compatibility matrix for a compatible version.

This page describes how to use Rasa Ephemeral Installer to install Rasa X.

Before You Start

Note
You will need sudo access on your machine to use REI for installation. The installer will prompt you for your password.

REI installs rasactl. rasactl deploys Rasa X without a Rasa Open Source server. To connect a Rasa Open Source server, see the Connect Rasa Open Source to Rasa X section. You can learn more about rasactl in the rasactl CLI docs section.

The Quickstart section assumes you will be connecting to a remote Git repository. To start Rasa X with a local Rasa project mounted, see Starting Rasa X with a Local Rasa Project.

Quickstart

Download and run Rasa Ephemeral Installer:

curl -O https://rei.rasa.com/rei.sh && bash rei.sh -y

The command above will prepare the environment and install the following components:

Use rasactl to deploy Rasa:

   $ rasactl start

Ready!

╭ Rasa X ───────────────────────────────────────────────╮
│ │
│ URL: http://agitated-goldberg.rasactl.localhost │
│ Rasa X version: 1.1.0 │
│ Rasa X password: rasaxlocal │
│ │
╰───────────────────────────────────────────────────────╯

By default, rasactl will deploy the latest stable release of Rasa X.
To use the latest edge release of Rasa X, run the following instead:

rasactl start --rasa-x-edge-release

Check the status of your deployment.

   $ rasactl status

Output:

Name: pink-moldorf
Status: Running
URL: http://pink-moldorf.rasactl.localhost
Version: 1.1.0
Enterprise: active
Rasa production version: 0.0.0
Rasa worker version: 0.0.0
Project path: not defined

Use the rasactl open command to view Rasa X in a web browser. From there you can connect Rasa X to your bot's git repository.

Starting Rasa X with a Local Rasa Project

Note
Starting a Rasa X deployment with a local Rasa project is supported for Rasa X / Enterprise ≥ 1.0.0.

The following instruction describes how to deploy Rasa X with a mounted local Rasa project.

Requirements

kind. Using a local Rasa project is only supported with kind as the k8s platform. kind is installed along with other tools if you use the REI to install all components.
A local Rasa project. If you don't have one yet, there are two easy ways to create a Rasa project:
- use the rasa init command.
- use the Rasa Playground to create and download a project.

Starting Rasa X

After downloading and installing REI:

Start Rasa X in your local Rasa project directory:
```
$ cd <rasa-project-dir>
$ rasactl start --project
```
You can use the --project-path flag to define a Rasa project directory explicitly, in which case you don't have to run the command from your project directory.
Check the status of your deployment - it should reflect your local project path:

   $ rasactl status