Konfiguration¶

Allgemeine Einstellungen¶

base_path = BASE PATH¶

Legt das Startverzeichnis für relative Datei-/Verzeichnisnamen in der Konfigurationsdatei fest. Wenn Sie für das Startverzeichnis einen relativen Verzeichnisnamen verwenden (wie z.B. .), dann wird das Verzeichnis des LiveConfig-Programms als Ausgangspunkt verwendet.

license_file = LICENSEFILE¶

Legt den Namen der Lizenzdatei fest. Diese Datei sollte nur von dem Benutzer lesbar sein, unter dem LiveConfig ausgeführt wird. Weitere Informationen siehe manpage liveconfig.key(5).

Standard: /etc/liveconfig/liveconfig.key

log_file = LOGFILE¶

Legt den Namen der Protokolldatei fest. Diese Datei (oder das Verzeichnis in dem diese angelegt werden soll) muss von dem Benutzer beschreibbar sein, unter dem LiveConfig ausgeführt wird. Wenn diese Datei bereits existiert, darf diese keine Spezialdatei (z.B. symbolischer Link, Pipe, …) sein. Wenn die Einstellung log_file auf den Wert syslog gesetzt wird, werden alle Meldungen an den Systemdienst syslog(3) gesendet.

log_level = emerg | alert | crit | err | warning | notice | info | debug¶

Legt den Log-Level für die Protokollierung fest.

Standard: info

pid_file = PIDFILE¶

Legt den Namen der PID-Datei fest. Diese Datei (oder das Verzeichnis in dem diese Datei erstellt werden soll) muss von dem Benutzer beschreibbar sein, unter dem LiveConfig ausgeführt wird. Die PID-Datei enthält die Prozess-ID des laufenden LiveConfig-Prozesses.

Standard: /var/run/liveconfig.pid

resource_path = RESOURCE_PATH¶

Legt den Verzeichnisnamen fest, in dem die Ressourcen-Dateien abgelegt sind.

library_path = LIBRARY_PATH¶

Legt den Verzeichnisnamen fest, in dem LiveConfig’s zusätzliche Bibliotheken (z.B. Datenbanktreiber) zu finden sind.

libexec_path = LIBEXEC_PATH¶

Legt den Verzeichnisnamen fest, in dem LiveConfig’s Skripte & Hilfsprogramme (z.B. Lua-Skripte, lclogsplit-Tool) zu finden sind.

user = USER¶

Legt den Systembenutzer fest, unter dem alle unprivilegierten Tätigkeiten (z.B. Frontend-Webserver, Abfrage von Systemstatistiken, etc.) ausgeführt werden. Wenn nicht anders definiert, wird die User-ID -1 verwendet. LiveConfig muss als root-Benutzer gestartet werden um zu einem weniger privilegierten Benutzer wechseln zu können. Wenn LiveConfig als nicht-root-Benutzer gestartet wird, läuft LiveConfig durchgehend unter diesem Benutzer.

group = GROUP¶

Legt die Systemgruppe für alle unprivilegierten Tätigkeiten fest (siehe user). Wenn nicht gesetzt, wird die Standard-Gruppe des durch user festgelegten Benutzers verwendet.

proxy_http = URL¶

Wenn diese Option gesetzt ist, verwendet LiveConfig den angegebenen Proxy-Server für ausgehende HTTP(S)-Verbindungen. Die URL muss das Format http://<server_name> haben.

Datenbank-Einstellungen¶

Die folgenden Optionen dienen der Konfiguration des Datenbankzugriffs für LiveConfig:

db_driver = DRIVER¶

Legt den zu verwendenden Datenbanktreiber fest. Unterstützte Werte sind:

• mysql um zu einer MySQL- oder MariaDB-Datenbank zu verbinden

• sqlite um eine lokale SQLite-Datenbank (Datei-basiert) zu verwenden

db_host = HOST¶

[MySQL] Name des Datenbank-Servers

db_name = NAME¶

[MySQL, SQLite] Legt den Namen der Datenbank fest. Bei SQLite ist dies der Dateiname der Datenbank.

db_user = USER¶

[MySQL] Benutzername für die Datenbankanmeldung.

db_password = PASSWORD¶

[MySQL] Passwort für die Datenbankanmeldung.

db_options = OPTIONS¶

Optionen für die Datenbankverbindung. Unterstützte Werte:

• charset=CHARSET [MySQL] set different character set (default: utf8mb4)

• collation=COLLATION [MySQL] set different collation (default: utf8mb4_unicode_ci)

• port=PORT [MySQL] Port für die TCP-Verbindung wählen (Standard: 3306)

• socket=SOCKET [MySQL] Erlaubt die Auswahl einer Socket-Datei für lookale Verbindungen (der Standardwert hängt von der [client]-Einstellung in my.cnf ab, oft /tmp/mysql.sock - aber in den meisten Fällen ist /var/lib/mysqld/mysqld.sock richtig.

• no-secure-auth [MySQL] Erlaubt die Verwendung der alten (und unsicheren) Verbindungs-Methode von MySQL vor v4.1.1.

• synchronous=0|1|2 [SQLite] Entspricht dem Aufruf von „PRAGMA synchronous=0|1|2;“ (Standard: 1)

• journal_mode=DELETE|TRUNCATE|PERSIST|MEMORY|WAL|OFF [SQLite] Entspricht dem Aufruf von PRAGMA journal=...; (Standard: TRUNCATE)

HTTP-Protokoll-Einstellungen¶

Die HTTP-spezifischen Einstellungen sind:

http_socket = ADDRESS[:PORT]¶

Legt die Netzwerkadresse fest, an der auf eingehende HTTP-Verbindungen gewartet werden soll. Optional kann ein Port mit angegeben werden. Sowohl IPv4- als auch IPv6-Adresseb sind erlaubt. Wird die Adresse * angegeben, wartet LiveConfig an allen verfügbaren IPv4- und IPv6-Adressen (:: wartet nur an IPv6-Schnittstellen, 0.0.0.0 nur an IPv4-Schnittstellen!). Beispiele für gültigr Adressen sind:

*:8888	wartet an allen IPv4- und allen IPv6-Schnittstellen an Port 8888
[::]:8888	wartet an allen IPv6-Schnittstellen an Port 8888
0.0.0.0	wartet an allen IPv4-Adressen am Standard-Port 8080
::	wartet an allen IPv6-Adressen am Standard-Port 8080
12.34.56.78	wartet nur an der IPv4-Adresse 12.34.56.78 (Port 8080)

Die Einstellung http_socket kann mehrfach angegeben werden, um an mehreren Adressen/Ports zu warten.

http_ssl_socket = ADDRESS[:PORT]¶

Siehe http_socket, nur dass ein Port für eingehende HTTPS-Verbindungen (SSL) geöffnet wird. Das SSL-Zertifikat wird aus der mit http_ssl_certificate festgelegten Datei geladen. Der Standard-Port für SSL-Verbindungen ist 8443.

Wenn weder die Einstellung http_socket noch http_ssl_socket gesetzt wird, öffnet LiveConfig standardmäßig einen HTTPS-Socket unter *:8443.

http_access_log = LOG FILE¶

Legt die Protokolldatei für HTTP-Zugriffe fest. Das Format dieser Logdatei ist das selbe wie beim Combined Log Format des Apache-Webservers.

http_htdocs_path = HTDOCS_PATH¶

Verzeichnis für statische Dateien (z.B. Kunden-Logos, …). Muss durch den LiveConfig-Benutzer beschreibbar sein.

http_read_timeout = TIMEOUT¶

Setzt das Lese-Timeout für HTTP-Zugriffe auf TIMEOUT Sekunden.

http_keepalive_timeout = TIMEOUT¶

Setzt das HTTP-Keep-Alive-Timeout auf TIMEOUT Sekunden.

http_keepalive_requests = MAX_REQUESTS¶

Setzt die maximale Anzahl an HTTP-Keep-Alive-Zugriffen auf MAX_REQUESTS.

http_max_connections = MAX_CONNECTIONS¶

Begrenzt die maximale Anzahl gleichzeitiger HTTP-Verbindungen auf MAX_CONNECTIONS.

http_ssl_certificate = CERTFILE¶

Legt die Datei fest, welche sowohl das SSL-Zertifikat als auch den privaten SSL-Schlüssel (PEM-codiert) enthält - siehe SSL-Konfiguration.

http_redirect = STATUS URI DESTINATION¶

Leite Anfragen nach URI zu DESTINATION weiter (mit dem HTTP-Status STATUS). Gültige Werte für STATUS sind 301 (dauerhafte Weiterleitung) und 302 (vorübergehende Weiterleitung). Alle URIs müssen einen führenden Schrägstrich enthalten. Weiterleitungen und Umschreibungen (Rewrites) haben die höchste Priorität bei der Verarbeitung einer Anfrage, somit kann jede URI umgeleitet werden. Die URI muss exakt übereinstimmen, es ist nicht möglich alle Zugriffe mit einem bestimmten Präfix umzuleiten.

Häufig möchte man eine Standard-Weiterleitung auf die Anmeldeseite einrichten, etwa so:

http_redirect = 301  /  /liveconfig/login

Sie können Anfragen auch auf eine beliebige andere Website umleiten:

http_redirect = 301  /  http://www.example.test/customer-login/

http_rewrite = URI DESTINATION¶

Schreibe Anfragen nach URI auf DESTINATION um (ohne HTTP-Weiterleitung). Alle URIs müssen einen führenden Schrägstrich enthalten. Weiterleitungen und Umschreibungen (Rewrites) haben die höchste Priorität bei der Verarbeitung einer Anfrage, somit kann jede URI umgeleitet werden. Die URI muss exakt übereinstimmen, es ist nicht möglich alle Zugriffe mit einem bestimmten Präfix umzuleiten.

Häufig möchte man eine „robots.txt“-Datei direkt erreichbar machen:

http_rewrite = /robots.txt  /res/m/liveconfig/robots.txt

http_canonical_host = HOSTNAME¶

Verwende HOSTNAME als kanonischen Hostnamen für die LiveConfig-Weboberfläche.

http_canonical_redirect = URL¶

Wenn http_canonical_host gesetzt ist und sich ein Benutzer unter einem anderen Hostnamen mit LiveConfig verbindet, kann er an die hier festgelegte URL weitergeleitet werden.

http_nonssl_redirect = STATUS URL¶

Wenn ein reiner HTTP-Zugriff (über ein http_socket) eintrifft, wird er an die hier definierte URL weitergeleitet.

http_hsts_time = TIME¶

Aktiviert HTTP Strict Transport Security (HSTS) für SSL-Verbindungen. Der mit TIME definierte Wert legt fest, wie lange ein Besucher gezwungen wird nur verschlüsselte Verbindungen zu verwenden (empfohlen: 31536000 Sekunden = 12 Monate). Der Standardwert ist 0 (aus).

Wenn die Option http_canonical_host gesetzt ist, wird HSTS nur für diesen Namen aktiviert. Weiterleitungen per http_canonical_redirect sind auf diese Art weiterhin möglich.

http_proxy_ip_from = IP[, IP...]¶

Wenn LiveConfig hinter einem Reverse-Proxy betrieben wird, können Sie hier die IP-Adressen festlegen von welchen die Proxy-Zugriffe kommen. Dies wird für die Option http_proxy_ip_header benötigt, um die „echte“ IP-Adresse von Besuchern zu erhalten.

http_proxy_ip_header = HEADER¶

Legt den Namen des HTTP-Headers fest, welcher die IP-Adresse des „echten““ Besuchers enthält wenn ein Reverse-Proxy verwendet wird. Je nach Proxy-Webserver lautet dieser Header X-Forwarded-For (Apache httpd) oder X-Real-IP (NGINX). Um Betrug (Spoofing) zu verhindern, wird die IP-Adresse in diesem Feld nur berücksichtigt wenn die Verbindung von einer in http_proxy_ip_from angegebenen IP-Adresse stammt.

http_proxy_url = URL¶

Wenn LiveConfig hinter einem Reverse-Proxy betrieben wird, können Sie hier die „öffentlich“ URL (die des Proxy-Servers) angeben. Manchmal muss LiveConfig eine vollständige URL erzeugen (z.B. für den Link zum Zurücksetzen von Passwörtern, der per E-Mail versendet wird). Da LiveConfig die externe URL nicht kennt, muss diese hier explizit angegeben werden. Bitte geben Sie die URL ohne abschließenden Schrägstrich an.

Beispiel:

http_proxy_url = https://controlpanel.example.org

LCCP-Protokoll-Einstellungen¶

Das LiveConfig Client Protocol (LCCP) wird für die Kommunikation zwischen einem LiveConfig-Server und einem LiveConfig-Client genutzt (benötigt eine Business-Lizenz auf dem LiveConfig-Server).

Die LCCP-spezifischen Optionen sind:

lccp_socket = ADDRESS[:PORT]¶

Legt die Netzwerkadresse fest, an der auf eingehende LCCP-Verbindungen gewartet werden soll. Optional kann ein Port mit angegeben werden. Sowohl IPv4- als auch IPv6-Adresse sind erlaubt. Beispiele für gültige Werte sind:

[::]:7888	wartet an allen IPv4- und IPv6-Adressen an Port 7888
0.0.0.0	wartet an allen IPv4-Adressen am Standard-Port 788
::	wartet an allen IPv4- und IPv6-Adressen am Standard-Port 788
12.34.56.78	wartet nur an der IPv4-Adresse 12.34.56.78 (Port 788)

Die lccp_socket-Einstellung kann mehrfach angegeben werden, um mehrere Ports zu öffnen. Sie müssen nur dann einen LCCP-Socket konfigurieren, wenn Sie mindestens einen LiveConfig-Client betreiben der sich an diese Serverinstanz verbinden soll.