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 | auto-generated | The persistent app id. |
| APP_DESCRIPTION | auto-generated | The description of the app. If no app description is given, the hostname is used. |
| CONFIG | configuration.yml | The filepath to the configuration file. |
| AUTO_START | 1 | Load configuration file on start-up. |
| AUTO_INSTALL | 1 | Automatically install third-party requirements (Python packages). |
| INITIAL_DOWNLOAD | 1 | Automatically download modules from the hub on the very first start-up. |
| AUTO_DOWNLOAD | 1 | Automatically download missing modules from the hub before running them. |
| API | 1 | Start the api. |
| API_HOST | 0.0.0.0 | Host address of the api. |
| API_PORT | 8181 | Port of the api. |
| API_AUTHENTICATION | 1 | Require authentication for the API and frontend. |
| LOCAL_ADMIN_USERNAME | admin | The local admin username. |
| LOCAL_ADMIN_PASSWORD | auto-generated | The local admin password. |
| MCP | 0 | Start the MCP server. Requires the API to be enabled. |
| FRONTEND | 1 | Start the frontend. |
| FRONTEND_HOST | 0.0.0.0 | Host address of the frontend. |
| FRONTEND_PORT | 8282 | Port of the frontend. |
| MOTHERSHIPS | [] | The addresses of the motherships API (e.g. "http://127.0.0.1:8181") to report to. |
| HUB_API_ACCESS_TOKEN | The api access token of the hub profile collectu.de. | |
| GIT_ACCESS_TOKEN | The git access token of the hub profile collectu.de as base64 encoded string. | |
| REPORT_TO_HUB | 1 | Shall this app report and receive tasks from the hub collectu.de. |
| SEND_USAGE_STATISTICS | 1 | Send anonymous usage statistics to the developer. |
| CUSTOM_MODULE_FOLDER | Name of a custom module folder inside the modules directory. | |
| ALLOWED_COMMANDS | restart,start,stop,update,load,save | Comma-separated list of commands that may be executed when issued by a mothership or the hub. |
| RUN_AS_ROOT | 0 | Container only. If set to 1, the application runs as root instead of the default non-root user (appuser). Useful when host device access (e.g. USB ports) is required. |
Previous
First Steps
First Steps
Next
Proxy
Proxy