Konfiguration¶
koala verwendet die nachfolgenden Konfigurationswerte.
| Name | Typ | Beschreibung |
|---|---|---|
| CACHE_HOST | string | Redis hostname oder IP |
| DATABASE_CONNECTION_STRING | string | MySQL hostname oder IP |
| DEFAULT_API_QUERY_AUTH_REQUIRED | string | Siehe DIAS Spezifikationen: Definiert ob Passwörter per Query-Parameter benötigt werden |
| DEFAULT_APP_NAME | string | Name der Applikation, muss eindeutig sein |
| DEFAULT_HEARTBEAT_INTERVAL_IN_SEC | int | Heartbeat Intervall |
| DEFAULT_HTTP_BASIC_AUTH_REQUIRED | bool | Definiert ob http basic Authentifizierung für den Zugriff auf die API endpoints benötigt wird |
| DEFAULT_KOALA_NAME | string | Name der koala Installation. Wird auf der Webseite angezeigt |
| DEFAULT_NO_INGESTS_EMAIL_TO | string | E-Mail Empfänger |
| DEFAULT_NO_INGESTS_MAX_TIMESPAN_IN_MINUTES | int | Zeitspanne in Minuten für die Überprüfung nach neuen Paketen |
| DEFAULT_SEND_MAIL_ON_ERROR | bool | Versende E-Mails bei Fehlern oder Abstürzen |
| DEFAULT_SEND_MAIL_ON_NO_INGESTS | bool | Sende E-Mails falls innerhalb einer definierten Zeitspanne keine neuen SIPs eingespielt wurden |
| DEFAULT_SEND_MAIL_ON_SUCCESS | bool | Versende E-Mails bei erfolgreich eingespielten SIPs |
| DEFAULT_SMTP_FROM | string | E-Mail Sender |
| DEFAULT_SMTP_HOST | string | E-Mail Server relay host |
| DEFAULT_SMTP_PORT | int | SMTP Port |
| DEFAULT_SMTP_TO | string | E-Mail Empfänger |
| DEFAULT_SMTP_USER | string | SMTP Benutzername |
| DEFAULT_SMTP_PW | string | SMTP Passwort |
| DEFAULT_WORKAREA_BASE_PATH | string | Pfad zur Workarea |
| DEFAULT_USAGE_CONSUMPTION_SEND_MAIL | bool | Sende monatliche E-Mail mit Statistiken über die Speicherbelegung |
| DEFAULT_USAGE_CONSUMPTION_EMAIL_TO | string | E-Mail Empfänger für Statistiken |
| FTPINFO_PASSWORD | string | Password für den SFTP-Zugriff |
| FTPINFO_PRELOAD_AREA | string | Pfad in den per SFTP neue SIPs abgelegt werden müssen |
| FTPINFO_SERVER | string | Hostname oder IP des SFTP-Servers |
| FTPINFO_SSHKEY | string | Alternative zu Benutzername/Passwort: SSH public key |
| FTPINFO_USER | string | SFTP Benutzername |
| KOALA_MYSQL_HOST | string | MySQL Hostname oder IP |
| LOADER_7ZIP_PATH | string | Pfad zu 7zip |
| LOADER_AIP_MAX_FILE_COUNT | string | Falls definiert: Maximale Anzahl an erlaubten Dateien |
| LOADER_CIRCUIT_BREAKER_ENABLED | bool | Automatisches Deaktivieren des scheduler bei unbehandelten Fehlern |
| LOADER_CIRCUIT_BREAKER_EXCEPTION_TYPE_EXPIRATION_IN_SEC | int | Expiration time, optional |
| LOADER_CIRCUIT_BREAKER_EXCEPTION_TYPE_MAX_FAILED_COUNT | int | Maximale Anzahl an unbehandelten Fehlern die dazu führen, dass der scheduler deaktiviert wird, optional |
| LOADER_CHECK_URN8141_FORMAT | bool | Prüft die external_asset_id nach dem in RFC 8141 definierten Format |
| LOADER_DELETE_SIP_ON_ERROR | bool | SIP löschen anstatt in die errorarea verschieben, optional |
| LOADER_ERRORAREA | string | Pfad zur Errorarea |
| LOADER_SIP_MAX_FILENAME_LENGTH | string | Falls definiert: Maximale Dateinamenlänge |
| LOADER_USE_7ZIP | bool | Nutze 7zip anstelle interner Logik zum Packen/Entpacken |
| LOADER_USE_BLOCKSIZE | int | Blockgröße in Byte für das Hashing, optional |
| LOADER_CLAMAV_ENABLED | bool | Definiert, ob eine dedizierte clamav Instanz das SIP nach Viren scannen soll, optional |
| LOADER_CLAMAV_SOCKET | string | Unix-Socket, der für die Kommunikation mit clamav genutzt wird. Standard: /data/clamav/sockets/clamd.sock' |
| LTP_AIP_BASE_NAME | string | AIP Dateiname (e.g. aip) |
| LTP_AIP_FORMAT | string | AIP Format (e.g. zip) |
| LTP_IMPLEMENTATION | string | Archival storage backend Typ. |
| LTP_NFSHSM_AIP_FOLDER | string | Falls LTP_IMPLEMENTATION=hsm: Archivierungspfad |
| LTP_OPTIMIZE_FOR_ZIP | bool | Für schnelleren Ingest. Nutze Optimierungen falls das SIP im zip Format vorliegt |
| LTP_TSM_FILESPACE | string | TSM filespace Name. Default: kopal |
| MDQI_BASEX_PW | string | BaseX Passwort |
| MDQI_BASEX_URL | string | BaseX REST Endpunkt URL |
| MDQI_BASEX_USER | string | BaseX Benutzername |
| MDQI_INDEX_WHILE_INGEST | bool | Speichere die Metadten im MDQI |
| MQ_API_PORT | string | RabbitMQ REST Endpunkt und Port |
| MQ_HOST | string | RabbitMQ Hostname oder IP |
| MQ_PORT | int | RabbitMQ Port |
| MQ_PW | string | RabbitMQ Passwort |
| MQ_USER | string | RabbitMQ Benutzername |
| MYSQL_DATABASE | string | MySQL Datenbank |
| MYSQL_PASSWORD | string | MySQL application Passwort |
| MYSQL_ROOT_PASSWORD | string | MySQL root Passwort |
| MYSQL_USER | string | MySQL Benutzername |
| PURGER_HIGH_WATERMARK_IN_PERCENTAGE | string | Prozent benutzter Festplattenspeicher der zu einer Aufräumaktion des purgers führt |
| PURGER_INTERVAL_IN_SEC | int | Purger Intervall |
| PURGER_LOW_WATERMARK_IN_PERCENTAGE | string | Prozent benutzter Festplattenspeicher der dazu führt, dass der purger die Aufräumvorgang stoppt |
| PURGER_RETENTION_TIME_IN_MINUTES | int | Minimaler Zeitintervall den DIPs in der Downloadarea liegen |
| PURGER_CLEANUP_ERRORAREA_ENABLED | bool | Aktiviere/Deaktiviere das Aufräumen der Errorarea, falls PURGER_HIGH_WATERMARK_IN_PERCENTAGE überschritten wurde |
| RABBITMQ_DEFAULT_PASS | string | RabbitMQ Passwort |
| RABBITMQ_DEFAULT_USER | string | RabbitMQ Benutzername |
| RETRIEVER_DIP_FILENAME | string | DIP Dateiname |
| RETRIEVER_DISABLE_DIP_AGENT_OVERWRITE | bool | Verhindere Überschreiben von metsHdr/agent in DIP mets.xml |
| RETRIEVER_DOWNLOADAREA | string | Download area |
| RETRIEVER_FRONTEND | string | Kann genutzt werden um eine vollständige URL in Antworten zu formen anstatt einer relativen URL |
| RETRIEVER_RETRIEVE_QUEUE | string | Retriever queue |
| RETRIEVER_RETRIEVE_ROUTING_KEY | string | Retriever routing key |
| RETRIEVER_WEBSERVER_RELATIVE_ALIAS | string | URL Pfad unter dem die DIPs abrufbar sind |
| SCHEDULER_CREATE_INGEST_TICKET | bool | Erstelle ein Ticket sobald der scheduler das SIP verarbeitet. Standardmäßig geschieht dies erst mit der Vearbeitung durch einen loader |
| SCHEDULER_INGEST_QUEUE | string | Ingest queue name |
| SCHEDULER_INGEST_ROUTING_KEY | string | Ingest routing key |
| SCHEDULER_INTERVAL_IN_SEC | int | Intervall der Überprüfung nach neuen SIPs |
| SCHEDULER_PRELOADAREA | string | Uploadarea Pfad |
| SCHEDULER_SCHEDULED_FILE_EXTENSION | string | Dateinamenerweiterung die der scheduler nutzt um bearbeitete Dateien zu markieren |
| SCHEDULER_SIP_FILE_PATTERN | string | Regex der genutzt wird um neue SIPs zu erkennen |
| STATS_INTERVAL_IN_SEC | int | Intervall der Statistikberechnungn |
| WEB_LDAP_ADMIN_DN | string | DN des admin Benutzers |
| WEB_LDAP_ADMIN_PW | string | Passwort des admin Benutzers |
| WEB_LDAP_BASE_DN | string | BaseDN für die Benutzersuche |
| WEB_LDAP_ENABLE | bool | Aktiviere/Deaktiviere LDAP-Authentifizierung |
| WEB_LDAP_FILTER | string | Filter für die Benutzersuche |
| WEB_LDAP_HOST | string | LDAP server Hostname oder IP |
| WEB_LDAP_PORT | int | Ldap Port |
| WEB_LDAP_USE_SSL | bool | Nutze LDAPs |
| WEB_SECRET_KEY | string | Session Schlüssel |
| WEB_SSO_AUTHORIZATION_ENDPOINT | string | OpenID Connect auth endpoint url |
| WEB_SSO_CLIENT_ID | string | OpenID Connect client id |
| WEB_SSO_CLIENT_SECRET | string | OpenID Connect client secret |
| WEB_SSO_ENABLED | bool | Aktiviere/Deaktivere SSO-Authentifizierung |
| WEB_SSO_ISSUER | string | OpenID Connect issuer |
| WEB_SSO_JWKS_URI | string | OpenID Connect jwks endpoint url |
| WEB_SSO_PROTO | string | http/https protocol of client app |
| WEB_SSO_SCOPE | string | OpenID Connect scope |
| WEB_SSO_TOKEN_ENDPOINT | string | OpenID Connect token endpoint url |
| WEB_SSO_USERINFO_ENDPOINT | string | OpenID Connect userinfo endpoint url |