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 Container oder
der compose.yaml festgelegt werden.
Wenn eine Umgebungsvariable gesetzt ist (zum Beispiel in der Compose-Datei),
wird sie NICHT von den Werten in der settings.ini überschrieben.
| Variable | Standard | Beschreibung |
|---|---|---|
| APP_ID | auto-generated | Die persistente App-ID. |
| APP_DESCRIPTION | auto-generated | Die Beschreibung der App. Wenn keine App-Beschreibung angegeben ist, wird der Hostname verwendet. |
| CONFIG | configuration.yml | Der Dateipfad zur Konfigurationsdatei. |
| AUTO_START | 1 | Lädt die Konfigurationsdatei beim Start. |
| AUTO_INSTALL | 1 | Anforderungen von Drittanbietern (Python-Pakete) automatisch installieren. |
| INITIAL_DOWNLOAD | 1 | Module beim allerersten Start automatisch vom Hub herunterladen. |
| AUTO_DOWNLOAD | 1 | Fehlende Module werden vor der Ausführung automatisch vom Hub heruntergeladen. |
| API | 1 | Startet die API. |
| API_HOST | 0.0.0.0 | Hostadresse der API. |
| API_PORT | 8181 | Port der API. |
| API_AUTHENTICATION | 1 | Für die API und das Frontend ist eine Authentifizierung erforderlich. |
| LOCAL_ADMIN_USERNAME | admin | Der Benutzername des lokalen Admins. |
| LOCAL_ADMIN_PASSWORD | auto-generated | Das Passwort des lokalen Admins. |
| MCP | 0 | Starten Sie den MCP-Server. Dazu muss die API aktiviert sein. |
| FRONTEND | 1 | Startet die Benutzeroberfläche. |
| FRONTEND_HOST | 0.0.0.0 | Hostadresse der Benutzeroberfläche. |
| FRONTEND_PORT | 8282 | Port der Benutzeroberfläche. |
| MOTHERSHIPS | [] | Die Adressen der Mothership-API (z.B. "http://127.0.0.1:8181"). |
| HUB_API_ACCESS_TOKEN | Das API-Zugriffstoken des Hub-Profils collectu.de. | |
| GIT_ACCESS_TOKEN | Das GIT-Zugriffstoken des Hub-Profils collectu.de als Base64-encodierter String. | |
| REPORT_TO_HUB | 1 | Soll die App mit dem Hub collectu.de kommunizieren? |
| SEND_USAGE_STATISTICS | 1 | Anonyme Nutzungsstatistiken an den Entwickler senden. |
| CUSTOM_MODULE_FOLDER | Name eines benutzerdefinierten Modulordners im Verzeichnis „modules“. | |
| ALLOWED_COMMANDS | restart,start,stop,update,load,save | Durch Kommas getrennte Liste von Befehlen, die ausgeführt werden können, wenn sie von einem Mothership oder dem Hub ausgegeben werden. |
| RUN_AS_ROOT | 0 | Nur Container. Bei der Einstellung „1“ wird die Anwendung als Root statt als Standardbenutzer (appuser) ausgeführt. Dies ist nützlich, wenn Zugriff auf das Host-Gerät (z. B. USB-Anschlüsse) erforderlich ist. |
Zurück
First Steps
First Steps
Weiter
Proxy
Proxy