Konfiguration
Alle Einstellungen erfolgen über Umgebungsvariablen mit dem Präfix FunkArr__. Der doppelte Unterstrich (__) trennt verschachtelte Abschnitte - das ist die standardmäßige ASP.NET Core Konfigurationsbindung.
Die Standardwerte funktionieren sofort für die lokale Entwicklung. Für den Produktivbetrieb musst du normalerweise nur FunkArr__ApiKey und FunkArr__Download__Path setzen.
Allgemein
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__ApiKey | funkarr-default-api-key | API-Schlüssel für Prowlarr/Sonarr/Radarr |
FunkArr__DataPath | data | Basispfad für Datenbank, Regelwerke, temporäre Dateien |
FunkArr__BaseUrl | (leer) | Basis-URL für FunkArr (wird von der Setup-API für die Auto-Konfiguration verwendet) |
API-Schlüssel
Der API-Schlüssel authentifiziert alle Anfragen von Prowlarr, Sonarr und Radarr. Sowohl die Indexer-API (/index/api) als auch die Download-Client-API (/download/api) benötigen diesen Schlüssel. Verwende denselben Wert bei der Konfiguration von FunkArr in deinen *arr-Apps.
WARNING
Ändere den Standard-API-Schlüssel im Produktivbetrieb. Jeder mit dem Schlüssel kann über deine FunkArr-Instanz suchen und herunterladen.
Datenpfad
Der Datenpfad ist das Stammverzeichnis für alle persistenten Daten. FunkArr erstellt darin folgende Struktur:
data/
funkarr.db # SQLite-Datenbank (wenn kein PostgreSQL verwendet wird)
rulesets/
community/ # Automatisch synchronisierte Community-Regelwerke
local/ # Deine eigenen Regelwerke
version.txt # Aktuell installierte Community-Regelwerk-Version
temp/ # Temporäre Dateien während Download/RemuxDownloads
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__Download__Path | data/downloads | Stamm-Download-Verzeichnis |
FunkArr__Download__ConcurrentDownloads | 3 | Maximale parallele Downloads |
FunkArr__Download__RetryEnabled | false | Fehlgeschlagene Downloads automatisch wiederholen |
FunkArr__Download__MaxRetries | 3 | Maximale Wiederholungsversuche pro Download |
FunkArr__Download__RetryBackoffBase | 00:00:30 | Basis-Wartezeit zwischen Wiederholungen (TimeSpan, HH:mm:ss) |
FunkArr__Download__MaxHistoryRecords | 1000 | Maximale Anzahl aufbewahrter Download-Verlaufseinträge |
Download-Pfad
Der Download-Pfad enthält zwei Unterverzeichnisse, die FunkArr automatisch verwaltet:
incomplete/- aktive Downloads und laufende Remux-Operationencomplete/- fertige Downloads, nach Kategorie-Unterverzeichnissen organisiert
Sonarr und Radarr überwachen das complete/-Verzeichnis auf fertige Dateien. Stelle sicher, dass dieser Pfad sowohl für FunkArr als auch für deine *arr-Apps erreichbar ist (typischerweise über ein gemeinsames Docker-Volume-Mount).
Parallele Downloads
Steuert, wie viele Videos gleichzeitig heruntergeladen und remuxed werden. Jeder Download verwendet einen FFmpeg-Prozess. Erhöhe den Wert bei schnellen Verbindungen mit verfügbarer CPU; verringere ihn bei Timeouts oder Ressourcenproblemen.
Wiederholungen
Wenn RetryEnabled auf true steht, werden fehlgeschlagene Downloads bis zu MaxRetries-mal wiederholt. RetryBackoffBase ist die Basis-Wartezeit zwischen den Versuchen; sie verdoppelt sich mit jedem Versuch, maximal jedoch auf 5 Minuten (bei 00:00:30: 30 s, 1 min, 2 min, ...). MaxHistoryRecords begrenzt, wie viele abgeschlossene Downloads im Download-Verlauf gespeichert bleiben.
Kategorien
Kategorien ordnen Sonarr/Radarr-Download-Kategorien Unterverzeichnissen innerhalb von complete/ zu. Konfiguriere eine Kategorie pro *arr-App-Typ:
FunkArr__Download__Categories__0__Name=tv
FunkArr__Download__Categories__0__Dir=tv
FunkArr__Download__Categories__1__Name=movies
FunkArr__Download__Categories__1__Dir=movies| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__Download__Categories__N__Name | - | Kategoriename wie in Sonarr/Radarr konfiguriert |
FunkArr__Download__Categories__N__Dir | - | Unterverzeichnis innerhalb von complete/ für diese Kategorie |
Die Standardwerte in appsettings.json definieren bereits die Kategorien tv und movies (jeweils mit gleichnamigem Verzeichnis). Eigene Einträge sind nur nötig, wenn du andere Namen brauchst.
Wenn Sonarr eine Download-Anfrage mit der Kategorie tv sendet, landet die fertige Datei in complete/tv/. Das N im Variablennamen ist ein nullbasierter Index - verwende 0, 1, 2 usw. für jede Kategorie.
Download-Zeitplan
Optionale Zeitfenster, in denen Downloads gestartet werden dürfen. Außerhalb der Fenster bleiben Downloads in der Warteschlange und starten automatisch, sobald das nächste Fenster beginnt. Ohne konfigurierte Zeitfenster läuft der Download rund um die Uhr.
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__Download__DownloadSchedule__N__Start | - | Startzeit des Zeitfensters (Format: HH:mm) |
FunkArr__Download__DownloadSchedule__N__End | - | Endzeit des Zeitfensters (Format: HH:mm) |
Das N ist ein nullbasierter Index. Zeitfenster können Mitternacht überbrücken (z.B. 23:00 bis 02:00). Mehrere Zeitfenster sind möglich.
FunkArr__Download__DownloadSchedule__0__Start=23:00
FunkArr__Download__DownloadSchedule__0__End=06:00Netzwerk-Routen
FunkArr kann verschiedene Mediatheken über verschiedene Netzwerkwege erreichen. Das ist notwendig, um auf geo-beschränkte Inhalte von ORF (Österreich) oder SRF (Schweiz) zuzugreifen. FunkArr selbst unterstützt nur HTTP-Proxys - die VPN-Infrastruktur (z.B. WireGuard + AirVPN) wird außerhalb von FunkArr in Docker betrieben.
Routen-Definitionen
Benannte Netzwerkwege mit optionalem HTTP-Proxy:
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__Routes__Definitions__N__Name | Direct | Name der Route |
FunkArr__Routes__Definitions__N__Proxy | (leer) | HTTP-Proxy-URI (leer = direkte Verbindung) |
FunkArr__Routes__Default | Direct | Standard-Route für nicht zugeordnete Sender |
Sender-Zuordnung
Glob-Muster ordnen Mediathek-Sender einer Route zu. Das erste passende Muster gewinnt. Sender ohne Treffer verwenden die Standard-Route.
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__Routes__ChannelRoutes__N__Pattern | - | Glob-Muster für den Sendernamen (z.B. ORF*) |
FunkArr__Routes__ChannelRoutes__N__Route | - | Name der zugeordneten Route |
Die Muster verwenden einfaches Glob-Matching (* für beliebige Zeichen). MediathekViewWeb liefert folgende Sendernamen: ARD, ARD-alpha, BR, ZDF, ZDFneo, ZDFinfo, 3Sat, ARTE.DE, ORF, SRF, Funk.net, KiKA, DW und weitere.
Beispiel-Konfiguration:
FunkArr__Routes__Definitions__0__Name=Direct
FunkArr__Routes__Definitions__1__Name=Austria
FunkArr__Routes__Definitions__1__Proxy=http://gluetun-at:8888
FunkArr__Routes__Definitions__2__Name=Switzerland
FunkArr__Routes__Definitions__2__Proxy=http://gluetun-ch:8888
FunkArr__Routes__ChannelRoutes__0__Pattern=ORF*
FunkArr__Routes__ChannelRoutes__0__Route=Austria
FunkArr__Routes__ChannelRoutes__1__Pattern=SRF*
FunkArr__Routes__ChannelRoutes__1__Route=Switzerland
FunkArr__Routes__Default=DirectMit dieser Konfiguration werden ORF-Inhalte über einen österreichischen Proxy geladen, SRF-Inhalte über einen Schweizer Proxy, und alle anderen Sender (ARD, ZDF, 3Sat, ...) direkt.
WARNING
Wenn ein Proxy nicht erreichbar ist, schlägt der Download fehl - es gibt keinen automatischen Fallback auf eine direkte Verbindung. Das ist beabsichtigt: ein stiller Fallback würde die geografische Einschränkung umgehen, die du explizit konfiguriert hast.
Die Route gilt für die gesamte Download-Pipeline: sowohl der Untertitel-Download als auch FFmpeg verwenden den konfigurierten Proxy.
Docker Compose mit Proxy-Infrastruktur
Ein vollständiges Beispiel mit FunkArr und gluetun-VPN-Gateways, die jeweils einen HTTP-Proxy bereitstellen:
services:
funkarr:
image: ghcr.io/st0o0/funkarr:latest
restart: unless-stopped
ports:
- "8080:6969"
volumes:
- funkarr-data:/app/data
- /path/to/media:/media
environment:
- FunkArr__Download__Path=/media/downloads
# Routen-Definitionen
- FunkArr__Routes__Definitions__0__Name=Direct
- FunkArr__Routes__Definitions__1__Name=Austria
- FunkArr__Routes__Definitions__1__Proxy=http://gluetun-at:8888
- FunkArr__Routes__Definitions__2__Name=Switzerland
- FunkArr__Routes__Definitions__2__Proxy=http://gluetun-ch:8888
# Sender-Zuordnung
- FunkArr__Routes__ChannelRoutes__0__Pattern=ORF*
- FunkArr__Routes__ChannelRoutes__0__Route=Austria
- FunkArr__Routes__ChannelRoutes__1__Pattern=SRF*
- FunkArr__Routes__ChannelRoutes__1__Route=Switzerland
- FunkArr__Routes__Default=Direct
# Österreich: gluetun-WireGuard-Gateway mit eingebautem HTTP-Proxy
gluetun-at:
image: qmcgaw/gluetun:latest
restart: unless-stopped
cap_add:
- NET_ADMIN
devices:
- /dev/net/tun:/dev/net/tun
environment:
- VPN_SERVICE_PROVIDER=<dein Anbieter>
- VPN_TYPE=wireguard
- WIREGUARD_PRIVATE_KEY=<dein Schlüssel>
- WIREGUARD_ADDRESSES=<deine Adresse>
- SERVER_COUNTRIES=Austria
- HTTPPROXY=on
# Schweiz: gluetun-WireGuard-Gateway mit eingebautem HTTP-Proxy
gluetun-ch:
image: qmcgaw/gluetun:latest
restart: unless-stopped
cap_add:
- NET_ADMIN
devices:
- /dev/net/tun:/dev/net/tun
environment:
- VPN_SERVICE_PROVIDER=<dein Anbieter>
- VPN_TYPE=wireguard
- WIREGUARD_PRIVATE_KEY=<dein Schlüssel>
- WIREGUARD_ADDRESSES=<deine Adresse>
- SERVER_COUNTRIES=Switzerland
- HTTPPROXY=on
volumes:
funkarr-data:TIP
Jeder gluetun-Container leitet seinen Verkehr durch WireGuard und stellt den HTTP-Proxy selbst bereit (HTTPPROXY=on, Port 8888). FunkArr erreicht ihn über das interne Docker-Netzwerk - die Proxys müssen nicht öffentlich erreichbar sein.
WARNING
Verwende ein gluetun-Image, das mit Go 1.26.9 / 1.27.2 oder neuer gebaut wurde. Ältere Builds antworten auf CONNECT mit Transfer-Encoding: chunked, wodurch FFmpeg den TLS-Handshake über den Proxy nicht abschließen kann (gluetun#3489). Jeder andere HTTP-Proxy mit CONNECT-Unterstützung (z. B. tinyproxy) funktioniert ebenfalls.
Regelwerke
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__RuleSet__Repository | st0o0/funkarr | GitHub-Repository für Community-Regelwerke |
FunkArr__RuleSet__Version | latest | Zu verwendende Regelwerk-Version |
FunkArr__RuleSet__RefreshEnabled | true | Automatische Regelwerk-Updates aktivieren |
Repository
Das GitHub-Repository, in dem Community-Regelwerke als Release-Assets veröffentlicht werden. Ändere dies nur, wenn du einen Fork mit eigenen Regelwerk-Releases betreibst.
Version
Setze auf latest, um immer das neueste Community-Regelwerk-Release zu verwenden. Pinne auf einen bestimmten Versions-Tag (z.B. rulesets-v0.2.0), um automatische Updates zu verhindern - nützlich, wenn ein neues Release ein Mapping bricht, auf das du angewiesen bist.
Aktualisierung
Wenn aktiviert, prüft FunkArr alle 30 Minuten auf neue Regelwerk-Releases und lädt Updates automatisch herunter. Deaktiviere dies, wenn du eine bestimmte Version pinnst oder in einer isolierten Umgebung arbeitest.
Metadaten
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__Tmdb__ApiKey | (leer) | TMDB API-Schlüssel |
FunkArr__Tvdb__ApiKey | (leer) | TVDB API-Schlüssel |
TMDB
Ein TMDB-API-Schlüssel ermöglicht die Metadaten-Auflösung für Filme und Serien. FunkArr verwendet ihn, um Mediathek-Einträge dem richtigen TMDB-Titel zuzuordnen und so die Genauigkeit für Radarr und Sonarr zu verbessern.
Einen kostenlosen API-Schlüssel gibt es unter themoviedb.org/settings/api.
TVDB
Ein TVDB-API-Schlüssel ermöglicht die Episodenguide-Auflösung. FunkArr nutzt TVDB-Daten, um datumsbasierte Mediathek-Einträge Staffel-/Episodennummern zuzuordnen, wenn das Regelwerk eine Airdate-Strategie verwendet.
Einen API-Schlüssel gibt es unter thetvdb.com/api-information.
TIP
Beide Schlüssel sind optional, aber empfohlen. Ohne sie verlässt sich FunkArr ausschließlich auf Regelwerk-Muster für die Zuordnung, was funktioniert, aber weniger Ergebnisse liefert.
RSS-Feed
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__Feed__Enabled | true | Neue Mediathek-Einträge für den RSS-Sync von Sonarr und Radarr sammeln |
FunkArr__Feed__Interval | 00:15:00 | Abstand zwischen zwei Abrufen |
FunkArr__Feed__InitialLookback | 2.00:00:00 | Wie weit der allererste Abruf zurückschaut |
FunkArr__Feed__PageSize | 1000 | Einträge pro MediathekViewWeb-Seite (1-1000) |
FunkArr__Feed__MaxPages | 20 | Maximale Seiten pro Abruf (Schutzgrenze) |
FunkArr__Feed__MaxCatchUp | 7.00:00:00 | Wie weit ein Abruf nach einem Ausfall höchstens nachholt |
FunkArr__Feed__Retention | 14.00:00:00 | Wie lange veröffentlichte Releases im Feed bleiben |
FunkArr__Feed__MinConfidence | 0.7 | Mindest-Score für die Veröffentlichung (0-1) |
Ein Abruf ohne neues Filmlisten-Update kostet nur eine kleine Anfrage. Kann ein Abruf nicht alle neuen Einträge innerhalb von MaxPages abdecken, zeigt die Feed-Seite eine Lücke an; passiert das regelmäßig, MaxPages erhöhen.
Scoring
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__Scoring__PoolSize | 4 | Parallele Scoring-Worker |
Der Scoring-Pool verarbeitet Mediathek-Suchergebnisse parallel gegen Regelwerke. Jeder Worker wertet einen Regelwerk-Match gleichzeitig aus. Erhöhe den Wert für schnellere Suchantworten auf Multi-Core-Systemen; der Standardwert von 4 funktioniert für die meisten Setups gut.
Sendungsfassungen
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__Variants__AudioDescription | Exclude | Fassungen mit Audiodeskription ("Audiodeskription", "Hörfassung") |
FunkArr__Variants__SignLanguage | Exclude | Fassungen mit Gebärdensprache ("Gebärdensprache", "DGS") |
FunkArr__Variants__PlainLanguage | Exclude | Fassungen in Einfacher, Leichter oder Klarer Sprache |
FunkArr__Variants__OriginalVersion | Exclude | Originalfassungen ("Originalfassung", "OV", "OmU") |
Mediatheken veröffentlichen dieselbe Sendung oft in mehreren Fassungen. FunkArr erkennt die Fassung an Titel und Thema jedes Eintrags. Mit Exclude erscheint die Fassung nie in den Suchergebnissen, Sonarr und Radarr können sie also nicht automatisch laden. Mit Allow wird sie mit einer Kennzeichnung im Release-Titel ausgeliefert (AD, DGS, EinfacheSprache, OV), auf die du ein Custom Format setzen kannst, zum Beispiel um Audiodeskription zu bevorzugen. Originalfassungen erhalten keine GERMAN-Sprachkennzeichnung. Die aktuelle Einstellung steht auf der Einstellungsseite.
Match-Verlauf
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__ScoringHistory__MaxSnapshots | 100 | Maximale Anzahl von Match-History-Snapshots |
FunkArr__ScoringHistory__MaxAgeDays | 30 | Tage, bevor alte Snapshots gelöscht werden |
FunkArr__ScoringHistory__SnapshotInterval | 20 | Intervall zwischen Snapshots |
Der Match-Verlauf speichert, welche Regelwerk-Zuordnungen ausgewertet wurden und deren Ergebnisse. Die Daten sind diagnostisch — sie liefern Statistiken und Traces für die Web-UI, beeinflussen aber nicht das Scoring. Die Scoring-Engine wertet Regeln deterministisch aus und nutzt ausschließlich die konfigurierten Konfidenzwerte des Regelwerks.
- MaxSnapshots - begrenzt den Speicher für den Match-Verlauf. Höhere Werte behalten mehr Verlauf für die Diagnose, verbrauchen aber mehr Speicherplatz.
- MaxAgeDays - entfernt Snapshots, die älter als diese Anzahl Tage sind. Mediathek-Inhalte ändern sich regelmäßig, sodass alte Match-Daten weniger relevant werden.
- SnapshotInterval - Journal-Checkpoint-Intervall für schnellere Wiederherstellung. Alle N Aufzeichnungen wird ein Snapshot gespeichert. Hat keinen Einfluss darauf, welche Daten erfasst werden.
Arr-API
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__ArrApi__SearchCacheTtlSeconds | 60 | Dauer in Sekunden, die Suchergebnisse zwischengespeichert werden |
Der Search-Cache gilt für die externe Indexer-API (/index/api), die Prowlarr, Sonarr und Radarr ansprechen. Er verhindert, dass eine Pagination-Folgeanfrage die gesamte Suche erneut auslöst.
PostgreSQL
Standardmäßig verwendet FunkArr SQLite mit der Datenbankdatei unter {DataPath}/funkarr.db. Setze FunkArr__Postgres__Host, um auf PostgreSQL umzustellen.
| Variable | Standard | Beschreibung |
|---|---|---|
FunkArr__Postgres__Host | (leer) | PostgreSQL-Host - setzen, um PostgreSQL zu aktivieren |
FunkArr__Postgres__Port | 5432 | PostgreSQL-Port |
FunkArr__Postgres__User | (leer) | PostgreSQL-Benutzer |
FunkArr__Postgres__Password | (leer) | PostgreSQL-Passwort |
FunkArr__Postgres__Database | funkarr | PostgreSQL-Datenbankname |
INFO
Wenn Host leer ist oder nicht gesetzt wurde, verwendet FunkArr SQLite. Das ist die empfohlene Standardeinstellung für Einzelinstanz-Setups. Verwende PostgreSQL, wenn du externes Datenbankmanagement brauchst oder skalieren möchtest.
Logging
FunkArr verwendet Serilog für strukturiertes Logging. Log-Level können pro Namespace angepasst werden:
| Variable | Standard | Beschreibung |
|---|---|---|
Serilog__MinimumLevel__Default | Information | Globales Mindest-Log-Level |
Serilog__MinimumLevel__Override__Akka | Warning | Akka.NET Actor-System Log-Level |
Serilog__MinimumLevel__Override__Microsoft.AspNetCore | Warning | ASP.NET Core Request Log-Level |
Serilog__MinimumLevel__Override__Microsoft.AspNetCore.HttpLogging | Information | Log-Level des ASP.NET Core HTTP-Request-Loggings |
Gültige Level: Verbose, Debug, Information, Warning, Error, Fatal.
Setze den Standard auf Debug zur Fehlersuche. Die Akka- und ASP.NET-Overrides sind standardmäßig auf Warning gesetzt, um das Rauschen vom Actor-System und der HTTP-Pipeline zu reduzieren.
Netzwerk
FunkArr lauscht auf Port 6969 im Container. Mappe ihn auf einen beliebigen Host-Port in deiner Docker Compose:
ports:
- "8080:6969" # Zugriff über http://localhost:8080FFmpeg
FFmpeg muss im PATH verfügbar sein - es ist im offiziellen Docker-Image enthalten. FunkArr verwendet FFmpeg um:
- Videostreams herunterzuladen (einschließlich HLS
.m3u8) - Nach MKV zu remuxen (kopiert Video-/Audio-Codecs ohne Neucodierung)
- Untertitel als SRT-Spuren mit deutschem Sprach-Tag einzubetten
Wenn für den Sender eine Netzwerk-Route mit Proxy konfiguriert ist, wird FFmpeg automatisch mit dem entsprechenden HTTP-Proxy gestartet (-http_proxy). Es gibt keine separaten Konfigurationsoptionen für das FFmpeg-Verhalten. Der Setup-Health-Check (/api/system/setup) überprüft, ob FFmpeg verfügbar ist.
Health Checks
FunkArr stellt drei Health-Endpunkte bereit, von denen keiner konfigurierbar ist:
| Endpunkt | Zweck |
|---|---|
/healthz | Vollständiger Health-Check (Daten-, Complete- und Incomplete-Verzeichnis beschreibbar, FFmpeg im PATH, MediathekViewWeb erreichbar) - gibt 503 zurück, wenn ein Verzeichnis- oder FFmpeg-Check fehlschlägt; ein nicht erreichbares MediathekViewWeb ergibt nur Degraded (200) |
/alive | Einfacher Liveness-Probe - gibt immer 200 zurück |
/api/system/setup | Setup-Validierung - prüft API-Schlüssel, Verzeichnisse, FFmpeg, API-Konnektivität |
Verwende /healthz für Container-Orchestrierungs-Health-Probes und /api/system/setup in der Web-Oberfläche, um deine Konfiguration zu überprüfen.