Settings Documentation

This module contains all settings that define the servers behaviour. They can roughly be categorized into

  • Django settings

  • Plugin system settings

  • miscellaneous

For all django specific settings look at this and this.

The plugin and miscellaneous settings should be documented. Those that aren’t are best left alone. For settings specific to individual plugins read up on the plugin tutorial.

Most settings are available via the generated config.ini. However not all of them (most of the time that is on purpose).

Every setting specified in the config.ini or in the settings.py itself can be overriden by setting an environment variable with the same name.

RIXAWebserver.settings.ALLOWED_HOSTS

List of domains which the webserver serves. ‘*’ means all connections will be accepted. Needs to be properly configured before deploying.

RIXAWebserver.settings.BASE_DIR

The absolute path to the working directory (wd). If you want to change this via envvar use RIXA_WD.

RIXAWebserver.settings.BOOTSTRAP_THEME

Set actual css theme. Use BOOTSTRAP_THEME in config file for changing

Make site work without SSL

Make site work without SSL

RIXAWebserver.settings.DATABASES

https://docs.djangoproject.com/en/4.1/ref/settings/#databases

RIXAWebserver.settings.DISABLE_PLUGIN_MODULE_CHECK

If activated the server will not check if a specified venv and plugin are compatible. Can be useful if you import via adding paths or use a more complicated setup for imports. Be aware that should you have missing imports and this activated the server will be in a unsafe state.

RIXAWebserver.settings.IGNORE_PLUGIN_WARNINGS

Disable this if you suspect faulty behaviour could be missing due to a missing warning. Will add some annoying mesages.

RIXAWebserver.settings.LANGUAGES

Internationalization. I strongly recommend not changing any of this as it will break the entire site

RIXAWebserver.settings.MAINTENANCE_MODE

prevents access to server outside of localhost. With asgi blocks all connections.

RIXAWebserver.settings.MAX_BLOCKING_CALLS

Max number of concurrent sync awaitables. Corresponds to the maximum number of non local plugin calls the server handles in total.

RIXAWebserver.settings.MAX_LOAD_TIME_PER_MODULE

Multiplied by 0.01s. You can change this to prevent a plugin timing out while loading a huge module. On the flipside it will take longer for the server to skip crashed plugins.

RIXAWebserver.settings.MAX_PLUGIN_STACK_DEPTH

Basically the maximum depth of nested function calls between plugins. Prevents circular deadlock.

RIXAWebserver.settings.MAX_USER_JOBS

Max non async jobs that a connected user can commit

RIXAWebserver.settings.NLP_BACKEND

Which NLP backend to use. If the specified backend has not been loaded it will reset to none. None means the chat only supports manual commands.

RIXAWebserver.settings.NLP_GREETING

Greeting message when user connects to server

RIXAWebserver.settings.PATCH_USER_MODEL

Patch users that have been created via the admin interface or other means.

RIXAWebserver.settings.PYENV_LOC

If set to an existing path with pyenv in it you allow the server to manage venvs on its own.

RIXAWebserver.settings.PYENV_PY_BASE

Standard python version to use for managed venvs unless otherwise specified.

RIXAWebserver.settings.SECRET_KEY

SECURITY WARNING: keep the secret key used in production secret!

Time in seconds before session is marked as invalid

Make site work without SSL

Make site work without SSL

RIXAWebserver.settings.STATISTICS_COLLECTION_INTERVAL

Interval in minutes in which the server collects statistics about user activity.