# Rasa X Installation Guide

## Compatibility

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](https://legacy-docs-rasa-x.rasa.com/docs/rasa-x/changelog/compatibility-matrix) for a compatible version.

## License Terms

For the use of Rasa X the [Rasa X License Terms](https://storage.googleapis.com/rasa-x-releases/rasa_x_ce_license_agreement.pdf) apply. For the use of Rasa Enterprise the [Rasa Enterprise License Terms](https://storage.googleapis.com/rasa-x-releases/rasa_x_ee_license_agreement.pdf) apply.

## Installation Steps

The simplest and quickest way to install Rasa X on a server or cluster is to use our quick-install script.

To install Rasa X, simply run the command below in a compatible environment:

```bash
curl -s get-rasa-x.rasa.com \| sudo bash
```

### Installing Edge vs. Stable

By default, the quick-install script will install the latest stable release of Rasa X. To install the latest edge release of Rasa X, run the following instead:

```bash
export RASA_X_VERSION="latest"

# -E flag applies environment variables from the current user for `sudo`
curl -s get-rasa-x.rasa.com \| sudo -E bash
```

When done, the script will print the URL to access Rasa X:

```bash
You can now access Rasa X on this URL: <--URL-->
```

The script will perform the following steps:

1. Install an [embedded Kubernetes cluster](https://legacy-docs-rasa-x.rasa.com/docs/rasa-x/0.42.x/installation-and-setup/install/quick-install-script/#embedded-cluster-installation). If the Kubernetes command-line interface `kubectl` is already configured, it will use the configured cluster. Please see [Existing Cluster Installation](https://legacy-docs-rasa-x.rasa.com/docs/rasa-x/0.42.x/installation-and-setup/install/quick-install-script/#existing-cluster-installation) for more details.
2. Install the Helm command-line interface.
3. Install Rasa X using the [Rasa X Helm Chart](https://legacy-docs-rasa-x.rasa.com/docs/rasa-x/0.42.x/installation-and-setup/install/helm-chart).

## Requirements

### Hardware & OS Requirements

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

The installation script is officially supported on the following operating systems:

- Ubuntu 18.04 / 20.04
- Debian 9 / 10
- Red Hat 7 / 8
- CentOS 7 / 8

You can also use this script to run Rasa X on [Windows or MacOS](https://legacy-docs-rasa-x.rasa.com/docs/rasa-x/0.42.x/installation-and-setup/install/quick-install-script/#windows--macos-installation) using Multipass.

For any other Linux operating systems, please follow the [Docker Compose Manual Installation](https://legacy-docs-rasa-x.rasa.com/docs/rasa-x/0.42.x/installation-and-setup/install/docker-compose#docker-compose-manual-install) instructions.

### Embedded Cluster Requirements

To run Rasa X on your machine, it should have the following hardware specs:

**vCPUs**
- Minimum: 2 vCPUs
- Recommended: 2-6 vCPUs

**RAM**
- Minimum: 4 GB RAM
- Recommended: 8 GB RAM

**Disk Space**
- Recommended: 50 GB disk space available

## Supported Browsers

The web interface aims to support [browsers that meet the following criteria](https://browserl.ist/?q=%3E0.2%25%2Cnot+ie+%3C%3D+11%2Cnot+op_mini+all):
- > 0.2% market share
- not Internet Explorer
- not Opera Mini

## Uninstalling

To uninstall Rasa X, run the script with the `--uninstall` flag.

```bash
curl -s get-rasa-x.rasa.com \| sudo bash -s -- --uninstall
```

## Next Steps
- [Connect a custom action server](https://legacy-docs-rasa-x.rasa.com/docs/rasa-x/0.42.x/installation-and-setup/customize#adding-a-custom-action-server) if you are using custom actions.
- [Set up Integrated Version Control](https://legacy-docs-rasa-x.rasa.com/docs/rasa-x/0.42.x/installation-and-setup/deploy#integrated-version-control) to connect your Rasa X instance to a remote Git repository.
- [Deploy your assistant](https://legacy-docs-rasa-x.rasa.com/docs/rasa-x/0.42.x/installation-and-setup/deploy#how-to-deploy) using Rasa X.