Einstellungen

Die Funktionalität der App kann auf verschiedene Arten angepasst werden. Im Allgemeinen gibt es zwei Hauptmöglichkeiten: Umgebungsvariablen und die Befehlszeilenschnittstelle (python src/main.py --help).

Umgebungsvariablen

Umgebungsvariablen werden verwendet, um grundlegende Funktionen der Anwendung zu steuern. Die Variablen können in der settings.ini-Datei, dem Docker-Container oder der docker-compose.yml festgelegt werden. Wenn eine Umgebungsvariable gesetzt ist (zum Beispiel in der Docker-Compose-Datei), wird sie NICHT von den Werten in der settings.ini überschrieben.

Variable Standard Beschreibung
APP_ID APP_ID=uuid.uuid4() Die persistente App-ID.
APP_DESCRIPTION APP_DESCRIPTION= Die Beschreibung der App.
CONFIG CONFIG=configuration.yml Der Dateipfad zur Konfigurationsdatei.
AUTO_START AUTO_START=1 Lädt die Konfigurationsdatei beim Start.
AUTO_INSTALL AUTO_INSTALL=1 Automatisches installieren von Abhängigkeiten.
INITIAL_DOWNLOAD INITIAL_DOWNLOAD=1 Automatischer Download von Modulen vom Hub beim ersten Start.
AUTO_DOWNLOAD AUTO_DOWNLOAD=1 Automatisches Herunterladen von Modulen, wenn diese lokal nicht vorhanden sind.
API API=1 Startet die API.
API_HOST API_HOST=localhost Hostadresse der API.
API_PORT API_PORT=8181 Port der API.
API_AUTHENTICATION API_AUTHENTICATION=1 Ist eine Authentifizierung für die lokale API und Benutzeroberfläche erforderlich?
FRONTEND FRONTEND=1 Startet die Benutzeroberfläche.
FRONTEND_HOST FRONTEND_HOST=localhost Hostadresse der Benutzeroberfläche.
FRONTEND_PORT FRONTEND_PORT=80 Port der Benutzeroberfläche.
MOTHERSHIPS MOTHERSHIPS=[] Die Adressen der Mothership-API (z.B. "http://127.0.0.1:8181").
HUB_API_ACCESS_TOKEN HUB_API_ACCESS_TOKEN= Das API-Zugriffstoken des Hub-Profils collectu.de.
REPORT_TO_HUB REPORT_TO_HUB=1 Soll die App mit dem Hub collectu.de kommunizieren?
SEND_USAGE_STATISTICS SEND_USAGE_STATISTICS=1 Anonyme Nutzungsstatistiken an den Entwickler senden.
CUSTOM_MODULE_FOLDER CUSTOM_MODULE_FOLDER= Ihr benutzerdefinierter Modulordner in modules.