Local Mode¶
Install and Run¶
You can install Rasa X on your local machine with
From your project directory, start it with
Configure Settings¶
By default, Rasa X will auto-generate a password for you that will be available in the
logs. You can set a specific password for Rasa X via the RASA_X_PASSWORD environment variable.
For example:
export RASA_X_PASSWORD="my-secure-password" rasa x
The following arguments can also be used to adapt the server settings:
usage: rasa x [-h] [-v] [-vv] [--quiet] [-m MODEL] [--data DATA] [-c CONFIG] [--no-prompt] [--production] [--rasa-x-port RASA_X_PORT] [--config-endpoint CONFIG_ENDPOINT] [--log-file LOG_FILE] [--endpoints ENDPOINTS] [-p PORT] [-t AUTH_TOKEN] [--cors [CORS [CORS ...]]] [--enable-api] [--response-timeout RESPONSE_TIMEOUT] [--remote-storage REMOTE_STORAGE] [--ssl-certificate SSL_CERTIFICATE] [--ssl-keyfile SSL_KEYFILE] [--ssl-ca-file SSL_CA_FILE] [--ssl-password SSL_PASSWORD] [--credentials CREDENTIALS] [--connector CONNECTOR] [--jwt-secret JWT_SECRET] [--jwt-method JWT_METHOD] optional arguments: -h, --help show this help message and exit -m MODEL, --model MODEL Path to a trained Rasa model. If a directory is specified, it will use the latest model in this directory. (default: models) --data DATA Path to the file or directory containing stories and Rasa NLU data. (default: data) -c CONFIG, --config CONFIG The policy and NLU pipeline configuration of your bot. (default: config.yml) --no-prompt Automatic yes or default options to prompts and oppressed warnings. (default: False) --production Run Rasa X in a production environment. (default: False) --rasa-x-port RASA_X_PORT Port to run the Rasa X server at. (default: 5002) --config-endpoint CONFIG_ENDPOINT Rasa X endpoint URL from which to pull the runtime config. This URL typically contains the Rasa X token for authentication. Example: https://example.com/api/config?token=my_rasa_x_token (default: None) --log-file LOG_FILE Store logs in specified file. (default: None) --endpoints ENDPOINTS Configuration file for the model server and the connectors as a yml file. (default: None) Python Logging Options: -v, --verbose Be verbose. Sets logging level to INFO. (default: None) -vv, --debug Print lots of debugging statements. Sets logging level to DEBUG. (default: None) --quiet Be quiet! Sets logging level to WARNING. (default: None) Server Settings: -p PORT, --port PORT Port to run the server at. (default: 5005) -t AUTH_TOKEN, --auth-token AUTH_TOKEN Enable token based authentication. Requests need to provide the token to be accepted. (default: None) --cors [CORS [CORS ...]] Enable CORS for the passed origin. Use * to whitelist all origins. (default: None) --enable-api Start the web server API in addition to the input channel. (default: False) --response-timeout RESPONSE_TIMEOUT Maximum time a response can take to process (sec). (default: 3600) --remote-storage REMOTE_STORAGE Set the remote location where your Rasa model is stored, e.g. on AWS. (default: None) --ssl-certificate SSL_CERTIFICATE Set the SSL Certificate to create a TLS secured server. (default: None) --ssl-keyfile SSL_KEYFILE Set the SSL Keyfile to create a TLS secured server. (default: None) --ssl-ca-file SSL_CA_FILE If your SSL certificate needs to be verified, you can specify the CA file using this parameter. (default: None) --ssl-password SSL_PASSWORD If your ssl-keyfile is protected by a password, you can specify it using this paramer. (default: None) Channels: --credentials CREDENTIALS Authentication credentials for the connector as a yml file. (default: None) --connector CONNECTOR Service to connect to. (default: None) JWT Authentication: --jwt-secret JWT_SECRET Public key for asymmetric JWT methods or shared secretfor symmetric methods. Please also make sure to use --jwt-method to select the method of the signature, otherwise this argument will be ignored. (default: None) --jwt-method JWT_METHOD Method used for the signature of the JWT authentication payload. (default: HS256)
👋 I can help you get started with Rasa and answer your technical questions.