Settings

The app functionality can be adjusted on different ways. In general there are two main opportunities: Environment variables and the command line interface (python src/main.py --help).

Environment Variables

Environment variables are used to control basic functionalities of the application. The variables can be set in the settings.ini file, the container, or in the compose.yaml. If an environment variable is set (for example inside the compose file), it will NOT be overwritten by the settings.ini values.

Variable Default Description
APP_ID APP_ID=uuid.uuid4() The persistent app id.
APP_DESCRIPTION APP_DESCRIPTION= The description of the app.
CONFIG CONFIG=configuration.yml The filepath to the configuration file.
AUTO_START AUTO_START=1 Load configuration file on start-up.
AUTO_INSTALL AUTO_INSTALL=1 Automatically install third party requirements.
INITIAL_DOWNLOAD INITIAL_DOWNLOAD=1 Automatically download modules from hub during first start.
AUTO_DOWNLOAD AUTO_DOWNLOAD=1 Automatically download modules if they do not exist locally.
API API=1 Start the api.
API_HOST API_HOST=0.0.0.0 Host address of the api.
API_PORT API_PORT=8181 Port of the api.
API_AUTHENTICATION API_AUTHENTICATION=1 Is authentication required for the local api and frontend.
MCP MCP=0 Start the mcp server. The api has to be enabled.
FRONTEND FRONTEND=1 Start the frontend.
FRONTEND_HOST FRONTEND_HOST=0.0.0.0 Host address of the frontend.
FRONTEND_PORT FRONTEND_PORT=80 Port of the frontend.
MOTHERSHIPS MOTHERSHIPS=[] The addresses of the motherships API (e.g. "http://127.0.0.1:8181") to report to.
HUB_API_ACCESS_TOKEN HUB_API_ACCESS_TOKEN= The api access token of the hub profile collectu.de.
REPORT_TO_HUB REPORT_TO_HUB=1 Shall this app report and receive tasks from the hub collectu.de.
SEND_USAGE_STATISTICS SEND_USAGE_STATISTICS=1 Send anonymous usage statistics to the developer.
CUSTOM_MODULE_FOLDER CUSTOM_MODULE_FOLDER= Your custom module folder located in modules.
Previous
First Steps
Next
Proxy