Zum Hauptinhalt springen

Passwork-Serverkonfiguration

Wenn ein erforderlicher Parameter in der Liste fehlt, bedeutet dies, dass er über die Passwork-Weboberfläche konfiguriert wird oder nicht mehr unterstützt wird.

Die Konfigurationsdatei config.env befindet sich in den folgenden Verzeichnissen (abhängig von der gewählten Passwork-Installation):

  • Linux/var/www/init/config.env
  • Windows ServerC:\inetpub\wwwroot\passwork\init\config.env
  • Docker/<passwork>/conf/keys/config.env

Parameter für den Passwork-Betrieb

ParameterStandardwertBeschreibung
ENCRYPTION_CIPHERAES-256-CFBDatenverschlüsselungsalgorithmus.
IS_EXPORT_ENABLED1Standardmäßig ist der Passwortexport in Passwork aktiviert. Der Wert 0 deaktiviert den Export.
IS_EMERGENCY_RESET_ENABLED0Berechtigung zum Zurücksetzen des Besitzer-Passworts über einen Konsolenbefehl.
IS_WRITING_LOGS_TO_STDERR_ENABLED1Fehler in den stderr-Stream schreiben.
IS_WRITING_LOGS_TO_ERROR_LOG_ENABLED1Fehler in die error_log-Datei schreiben.
IS_BASE64_RESPONSE_ENCODING_ENABLED1Antworten in Base64 kodieren.
APP_URLPasswork-URL-Adresse. Wird während des Installationsassistenten festgelegt.
HEALTH_CHECK_TOKENToken für den Health-Check-Endpunkt.
HASH_ALGORITHMEmpfohlen, nicht zu ändernPasswort-Hashing-Algorithmus. Standardmäßig wird SHA512 verwendet.
ENCRYPTION_CIPHEREmpfohlen, nicht zu ändernSie können einen Verschlüsselungsalgorithmus aus der OpenSSL-Bibliothek angeben.
IS_HTTP_HEADERS_CHECKER_ENABLED0Referer-Prüfung in HTTP-Headern aktivieren.

Pfad- und Konfigurationsdateiparameter

ParameterStandardwertBeschreibung
FILES_DIR<Passwork root>/filesVerzeichnis mit Hintergrundaufgaben-Protokollen, API-Schemabeschreibung und anderen Dateien.
INIT_DIR<Passwork root>/initStandardverzeichnis für die Speicherung des Verschlüsselungsschlüssels und der Benutzerkonfigurationsdatei.
ENCRYPTION_KEY_PATHINIT_DIR/encryption_keyPfad zur Verschlüsselungsschlüssel-Datei.
ENV_LOCAL_PATHINIT_DIR/config.envPfad zur Benutzerkonfigurationsdatei.
SSO_FILES_DIRFILES_DIR/ssoPfad zum SSO-Verzeichnis, erforderlich für die Speicherung von Zertifikaten bei Verwendung zur Signierung.

Verwendung

init/config.env — der standardmäßig angegebene Pfad, der jedoch über .env.local überschrieben werden kann. Er enthält den Hauptteil der Einstellungen, und in den meisten Fällen beschränkt sich die Konfiguration auf das Ändern oder Hinzufügen von Parametern in dieser Datei.

.env — befindet sich im Stammverzeichnis des Passwork-Codes (nicht zu verwechseln mit .env im Stammverzeichnis des Docker Builds). Bitte nehmen Sie keine Änderungen an dieser Datei vor, es sei denn, dies wird von unserem technischen Support verlangt.

.env.local — standardmäßig nicht vorhanden, kann nur im Stammverzeichnis des Passwork-Codes angelegt werden. Wir empfehlen, sie nur zum Ändern weniger Einstellungen zu verwenden: Pfade, Verschlüsselungsmodus, Antwortkodierungsmodus. Einstellungen aus dieser Datei überschreiben die in init/config.env und .env angegebenen.

Environment variables — können ebenfalls für die Konfiguration verwendet werden, was jedoch nur beim Betrieb in Containern oder über externe Prozessmanager sinnvoll ist. In anderen Fällen ist die Verwendung von Konfigurationsdateien vorzuziehen.

Datenbankverbindungsparameter

MongoDB

ParameterBeschreibung
MONGODB_URLVerbindungszeichenfolge zu MongoDB.
MONGODB_DBName der Passwork-Datenbank.
MONGODB_USERNAME(optional) MongoDB-Benutzername.
MONGODB_PASSWORD(optional) MongoDB-Benutzerpasswort.

E-Mail-Parameter

info

Wird mit dem DSN-Typ verwendet.

ParameterBeschreibung
APP_SENDER_EMAILAbsender-E-Mail für Systemnachrichten.
MAILER_DSNDSN-Verbindungszeichenfolge zum E-Mail-Server.

Oberflächenanpassung

Logo-Anzeige

Passwork ermöglicht es Ihnen, Ihr Firmenlogo in der Weboberfläche anstelle des Textnamens anzuzeigen.

Einrichtungsreihenfolge:

  1. Bereiten Sie eine PNG-Datei in der entsprechenden Größe vor und legen Sie sie in einem für den Webserver-Benutzer zugänglichen Verzeichnis ab.
  2. Geben Sie den absoluten Pfad zur Datei im Parameter APP_LOGO_PATH in config.env an.
  3. Starten Sie die Dienste neu, um das Logo zu laden.

Empfehlungen für das Logo-Format:

  • Format: PNG
  • Maximale Größe: 200×80 Pixel
ParameterBeschreibung
APP_LOGO_PATHPfad zum Logo-Bild
Konfigurationsbeispiele

Linux

  1. Verschieben Sie die .png-Datei auf den Server, auf dem Passwork installiert ist, und setzen Sie den Apache2-Webserver-Benutzer als Eigentümer.
chown www-data:www-data /opt/logo/example.png
  1. Bearbeiten Sie config.env und fügen Sie den Parameter hinzu:
APP_LOGO_PATH=/opt/logo/example.png
  1. Starten Sie die PHP- und Webserver-Dienste neu:
systemctl restart php8.3-fpm
systemctl restart apache2

Docker

  1. Legen Sie die .png-Datei in /<passwork>/conf/keys/ im Konfigurationsverzeichnis ab:
keys
├── config.env
├── encryption_key
└── example.png
  1. Fügen Sie den Parameter in config.env mit der Variable %init_dir% hinzu:
APP_LOGO_PATH="%init_dir%/example.png"
  1. Starten Sie die PHP- und Nginx-Container neu:
docker restart passwork_php passwork_nginx

Windows Server

  1. Kopieren Sie die Datei in ein beliebiges für IIS zugängliches Verzeichnis, zum Beispiel:
C:\inetpub\logo\example.png
  1. Fügen Sie den Parameter in config.env hinzu:
APP_LOGO_PATH="C:\inetpub\logo\example.png"
  1. Starten Sie in IIS die Passwork-Website oder den entsprechenden Anwendungspool neu.