From 0cc0ca98e1e1a7b192282fcc5ab90d859dcb43a5 Mon Sep 17 00:00:00 2001 From: Jonas F Date: Mon, 22 Apr 2024 14:33:50 +0200 Subject: [PATCH] Update README.md --- README.md | 70 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 49 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 316c59e..e5e4f2f 100644 --- a/README.md +++ b/README.md @@ -2,36 +2,21 @@ ## English description coming soon -## Erste Testversion +## Beschreibung Wer möchte kann den UmlautAdaptarr jetzt gerne testen! Über Feedback würde ich mich sehr freuen! Es sollte mit allen *arrs funktionieren, hat aber nur bei Sonarr, Readarr und Lidarr schon Auswirkungen (abgesehen vom Caching). -Momentan ist docker dafür nötig, wer kein Docker nutzt muss sich noch etwas gedulden. - -[Link zum Docker Image](https://hub.docker.com/r/pcjones/umlautadaptarr) - -Zusätzlich müsst ihr in Sonarr oder Prowlarr einen neuen Indexer hinzufügen (für jeden Indexer, bei dem UmlautAdapdarr greifen soll). - -Am Beispiel von sceneNZBs: - -![grafik](https://github.com/PCJones/UmlautAdaptarr/assets/377223/07c7ca45-e0e5-4a82-af63-365bb23c55c9) - -Also alles wie immer, nur dass ihr als API-URL nicht direkt z.B. `https://scenenzbs.com` eingebt, sondern -`http://localhost:5005/_/scenenzbs.com` - -Den API-Key müsst ihr natürlich auch ganz normal setzen. - -## Was macht UmlautAdaptarr überhaupt? UmlautAdaptarr löst mehrere Probleme: - Releases mit Umlauten werden grundsätzlich nicht korrekt von den *Arrs importiert - Releases mit Umlauten werden oft nicht korrekt gefunden (*Arrs suchen nach "o" statt "ö" & es fehlt häufig die korrekte Zuordnung zur Serie/zum Film beim Indexer) - Sonarr & Radarr erwarten immer den englischen Titel von https://thetvdb.com/ bzw. https://www.themoviedb.org/. Das führt bei deutschen Produktionen oder deutschen Übersetzungen oft zu Problemen - falls die *arrs schon mal etwas mit der Meldung `Found matching series/movie via grab history, but release was matched to series by ID. Automatic import is not possible/` nicht importiert haben, dann war das der Grund. +- Zusätzlich werden einige andere Fehler behoben, die häufig dazu führen, dass Titel nicht erfolgreich gefunden, geladen oder importiert werden. -# Wie macht UmlautAdaptarr das? +## Wie macht UmlautAdaptarr das? UmlautAdaptarr tut so, als wäre es ein Indexer. In Wahrheit schaltet sich UmlautAdaptarr aber nur zwischen die *arrs und den echten Indexer und kann somit die Suchen sowie die Ergebnisse abfangen und bearbeiten. Am Ende werden die gefundenen Releases immer so umbenannt, dass die Arrs sie einwandfrei erkennen. -Einige Beispiele findet ihr unter Features. +Einige Beispiele finden sich [weiter unten](https://github.com/PCJones/UmlautAdaptarr/edit/develop/README.md#beispiel-funktionalit%C3%A4t). ## Features @@ -45,7 +30,7 @@ Einige Beispiele findet ihr unter Features. | Releases mit deutschem Titel werden erkannt | ✓ | | Releases mit TVDB-Alias Titel werden erkannt | ✓ | | Korrekte Suche und Erkennung von Titel mit Umlauten | ✓ | -| Anfragen-Caching für 5 Minuten zur Reduzierung der API-Zugriffe | ✓ | +| Anfragen-Caching für 12 Minuten zur Reduzierung der API-Zugriffe | ✓ | | Usenet (newznab) Support |✓| | Torrent (torznab) Support |✓| | Radarr Support | Geplant | @@ -53,6 +38,49 @@ Einige Beispiele findet ihr unter Features. | Unterstützung weiterer Sprachen neben Deutsch | Geplant | | Wünsche? | Vorschläge? | + +## Installation +Momentan ist docker dafür nötig, wer kein Docker nutzt muss sich noch etwas gedulden. Eine Unraid-App gibt es auch, einfach nach `umlautadaptarr` suchen. + +[Link zum Docker Image](https://hub.docker.com/r/pcjones/umlautadaptarr) + +Nicht benötigte Umgebungsvariablen können entfernt werden. + +### Konfiguration in Prowlarr (empfohlen) +Das ist die empfohlene Methode um den UmlautAdaptarr einzurichten. Sie hat den Vorteil, dass es keinen Geschwindigkeitsverlust bei der Suche gibt, sofern man mehrere Indexer hat. + +1) In Prowlarr: Settings>Indexers bzw. Einstellungen>Indexer öffnen +2) Lege einen neuen HTTP-Proxy an: + +![Image](https://github.com/PCJones/UmlautAdaptarr/assets/377223/b97418d8-d972-4e3c-9d2f-3a830a5ac0a3) + +- Port: `5006` +- Tag: `umlautadaptarr` +- Host: Je nachdem, wie deine Docker-Konfiguration ist, kann es sein, dass du entweder `umlautadaptarr` oder `localhost` als Host setzen muss. Probiere es sonst einfach aus, indem du auf Test klickst. +- Die Username- und Passwort-Felder können leergelassen werden. +3) Gehe zur Indexer-Übersichtsseite +4) Für alle Indexer/Tracker, die den UmlautAdaptarr nutzen sollen: + +![grafik](https://github.com/PCJones/UmlautAdaptarr/assets/377223/3daea3f1-7c7b-4982-84e2-ea6a42d90fba) + + - Füge den `umlautadaptarr` Tag hinzu + - **Wichtig:** Ändere die URL von `https` zu `http`. (Für die Experten: Dies ist erforderlich, damit der UmlautAdaptarr die Anfragen lokal abfangen kann. Ausgehende Anfragen an den Indexer verwenden natürlich weiterhin https). +5) Klicke danach auf `Test All Indexers` bzw `Alle Indexer Testen`. Falls du irgendwo noch `https` statt `http` stehen hast, sollte in den UmlautAdaptarr logs eine Warnung auftauchen. Mindestens solltest du aber noch ein zweites Mal alle Indexer durchgehen und überprüfen, ob überall `http` eingestellt ist - Indexer, bei denen noch `https` steht, werden nämlich einwandfrei funktionieren - allerdings ohne, dass der UmlautAdaptarr bei diesen wirken kann. + +### Konfiguration in Sonarr/Radarr oder Prowlarr ohne Proxy +Falls du kein Prowlarr nutzt oder nur 1-3 Indexer nutzt, kannst du diese alternative Konfigurationsmöglichkeit nutzen. + +Dafür musst du einfach nur alle Indexer, bei denen der UmlautAdaptarr greifen soll, bearbeiten: + +Am Beispiel von sceneNZBs: + +![grafik](https://github.com/PCJones/UmlautAdaptarr/assets/377223/07c7ca45-e0e5-4a82-af63-365bb23c55c9) + +Also alles wie immer, nur dass als API-URL nicht direkt z.B. `https://scenenzbs.com` gesetzt wird, sondern +`http://localhost:5005/_/scenenzbs.com` + +Den API-Key muss natürlich auch ganz normal gesetzt werden. + ## Beispiel-Funktionalität In den Klammern am Ende des Releasenamens (Bild 2 & 4) steht zu Anschauungszwecken der deutsche Titel der vorher nicht gefunden bzw. akzeptiert wurde. Das bleibt natürlich nicht so ;) @@ -66,7 +94,7 @@ In den Klammern am Ende des Releasenamens (Bild 2 & 4) steht zu Anschauungszweck **Vorher:** Es werden nur Releases mit dem englischen Titel der Serie gefunden ![Vorherige Suche, englische Titel](https://github.com/PCJones/UmlautAdaptarr/assets/377223/ed7ca0fa-ac36-4584-87ac-b29f32dd9ace) -**Jetzt:** Es werden auch Titel mit dem deutschen Namen gefunden :D (haben nicht alle Suchergebnisse auf den Screenshot gepasst) +**Jetzt:** Es werden auch Titel mit dem deutschen Namen gefunden :D ![Jetzige Suche, deutsche und englische Titel](https://github.com/PCJones/UmlautAdaptarr/assets/377223/1c2dbe1a-5943-4fc4-91ef-29708082900e)