Welcome to RIXA’s documentation!

Installation guide: Installation

If you want to create plugins or similar, refer to rixaplugin. This includes significant parts of the code used here (e.g. logging, plugin communication, etc).

This documentation primarily should help understand

Full table of contents

• Plugin programming quickstart
  • Introduction
  • Setup
  • Developing the plugin
• Structure
  • Text command from client
• WebSocket Communication
  • Available Commands
  • Server Responses
  • Error Handling
• Settings Documentation
  • ALLOWED_HOSTS
  • BASE_DIR
  • BOOTSTRAP_THEME
  • CSRF_COOKIE_SAMESITE
  • CSRF_COOKIE_SECURE
  • DATABASES
  • DISABLE_PLUGIN_MODULE_CHECK
  • IGNORE_PLUGIN_WARNINGS
  • LANGUAGES
  • MAINTENANCE_MODE
  • MAX_BLOCKING_CALLS
  • MAX_LOAD_TIME_PER_MODULE
  • MAX_PLUGIN_STACK_DEPTH
  • MAX_USER_JOBS
  • NLP_BACKEND
  • NLP_GREETING
  • PATCH_USER_MODEL
  • PYENV_LOC
  • PYENV_PY_BASE
  • SECRET_KEY
  • SESSION_COOKIE_AGE
  • SESSION_COOKIE_SAMESITE
  • SESSION_COOKIE_SECURE
  • STATISTICS_COLLECTION_INTERVAL
• API Documentation
  • ChannelBridgeAPI
  • ConsumerAPI
• Plugin system integration
  • DashboardConfig
  • await_code_execution()
  • await_future_execution()
  • patch_users()
  • patched_set_event_loop()
  • plugin_interface()