Installation

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

Before You Start#

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 Command Line Interface 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#

1. Download and run Rasa Ephemeral Installer:

   Copy

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

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

   • docker
   • kind
   • helm
   • kubectl
   • rasactl

2. Use rasactl to deploy Rasa :

   Copy

   $ rasactl start

   ∙∙∙ Ready!

   ╭ Rasa X ───────────────────────────────────────────────╮

   │ │

   │ URL: http://agitated-goldberg.rasactl.localhost │

   │ Rasa X version: 1.0.1 |

   │ 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

   note

   If you deploy Rasa X on a VM rasactl will expose the Rasa X deployment on one of the node ports (30000-30100).

3. Check the status of your deployment.

   Copy

   $ rasactl status

   Name: pink-moldorf

   Status: Running

   URL: http://pink-moldorf.rasactl.localhost

   Version: 1.0.1

   Enterprise: active

   Rasa production version: 0.0.0

   Rasa worker version: 0.0.0

   Project path: not defined

4. 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#

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

Requirements#

1. 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.

2. 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:

1. Start Rasa X in your local Rasa project directory:

   Copy

   $ 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.

2. Check the status of your deployment - it should reflect your local project path:

   Copy

   $ rasactl status

   Name: hungry-lewin

   Status: Running

   URL: http://hungry-lewin.rasactl.localhost

   Version: 1.0.1

   Enterprise: inactive

   Rasa production version: 0.0.0

   Rasa worker version: 0.0.0

   Project path: /path/to/rasa_project

Next Steps#

• Connect a Rasa Open Source server to a Rasa X deployment.
• Learn more about rasactl.