notice

This is documentation for Rasa X/Enterprise Documentation v1.1.x, which is no longer actively maintained.
For up-to-date documentation, see the latest version (1.4.x).

Version: 1.1.x

Installation

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

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 Enterprise without a Rasa Open Source server. To connect a Rasa Open Source server, see the Connect Rasa Open Source to Rasa Enterprise 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 Enterprise with a local Rasa project mounted, see Starting Rasa Enterprise with a Local Rasa Project.

Quickstart

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

  1. Use rasactl to deploy Rasa :

    $ rasactl start
    ∙∙∙ Ready!
    ╭ Rasa X ───────────────────────────────────────────────╮
    │ │
    │ URL: http://agitated-goldberg.rasactl.localhost │
    │ Rasa X version: 1.1.3 │
    │ Rasa X password: rasaxlocal │
    │ │
    ╰───────────────────────────────────────────────────────╯

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

    rasactl start --rasa-x-edge-release
note

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

  1. Check the status of your deployment.
$ rasactl status
Name: pink-moldorf
Status: Running
URL: http://pink-moldorf.rasactl.localhost
Version: 1.1.3
Enterprise: active
Rasa production version: 0.0.0
Rasa worker version: 0.0.0
Project path: not defined
  1. Use the rasactl open command to view Rasa Enterprise in a web browser. From there you can connect Rasa Enterprise to your bot's git repository.

Starting Rasa Enterprise with a Local Rasa Project

note

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

The following instruction describes how to deploy Rasa Enterprise 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:

Starting Rasa Enterprise

After downloading and installing REI:

  1. Start Rasa Enterprise 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.

  1. Check the status of your deployment - it should reflect your local project path:
$ rasactl status
Name: hungry-lewin
Status: Running
URL: http://hungry-lewin.rasactl.localhost
Version: 1.1.3
Enterprise: inactive
Rasa production version: 0.0.0
Rasa worker version: 0.0.0
Project path: /path/to/rasa_project

Next Steps