rix1337/docker-feedcrawler repository overview

⁠FeedCrawler

FeedCrawler automatisiert bequem das Hinzufügen von Links für den JDownloader.

⁠Installation

⁠Manuelle Installation

⁠Voraussetzungen

• Python 3.8⁠ oder neuer (nur 4 externe Abhängigkeiten⁠!)
• JDownloader 2⁠ mit aktivem My JDownloader-Konto⁠
• optional: FlareSolverr 3⁠ um Cloudflare-Blockaden zu umgehen

⁠Installation / Update durch pip⁠

pip install -U feedcrawler

⁠Lokaler Build

Benötigt Node.js⁠, npm⁠ und pip⁠:

1. Frontend-Pfad aufrufen: cd feedcrawler/web_interface/vuejs_frontend
2. Dependencies installieren: npm ci
3. Vue.js 3⁠ Frontend kompilieren: npm run build
4. Zurück in das Hauptverzeichnis wechseln: cd ../../..
5. FeedCrawler auf Basis der setup.py installieren: pip install .

⁠Start

feedcrawler in der Konsole (Python muss im System-PATH hinterlegt sein)

⁠Docker Image⁠

docker run -d \
  --name="FeedCrawler" \
  -p port:9090 \
  -v /path/to/config/:/config:rw \
  -e DELAY=30 \
  -e LOGLEVEL=[INFO/DEBUG/WARNING/ERROR/CRITICAL/NOTSET] \
  --log-opt max-size=50m \
  rix1337/docker-feedcrawler

• Der Betrieb als Docker-Container empfiehlt sich als Standardinstallation - vor allem für NAS-Systeme, Homeserver und sonstige Geräte die dauerhaft und möglichst wartungsfrei (headless) betrieben werden sollen.
• Bei jedem Release wird ein getaggtes Image erstellt. Damit kann man auf der Wunschversion verbleiben oder im Falle eines Bugs zu einer stabilen Version zurück kehren.
• Um immer auf dem aktuellen Stand zu sein, einfach das mit latest getaggte Image nutzen.
• Für UNRAID-Server kann das Image direkt über die Community Applications bezogen und der Container so eingerichtet werden.

⁠Spezifische Version nutzen

Das Image rix1377/docker-feedcrawler wird standardmäßig auf das :latest-Tag aufgelöst. Dieses wird mit jedem Release auf die neue Version aktualisiert. Mit jedem Release wird ebenfalls eine getaggte Version des Images erzeugt. Auf letztere kann man wechseln, um beispielsweise bei Fehlern in der neuen Version auf einen funktionierenden Stand zurück zu kehren.

Beispiel:

docker pull rix1337/docker-feedcrawler:13.3.7

⁠Windows Build

• Jedem Release⁠ wird eine selbstständig unter Windows lauffähige Version des FeedCrawlers beigefügt.
• Hierfür müssen weder Python, noch die Zusatzpakete installiert werden.
• Einfach die jeweilige Exe herunterladen und ausführen bzw. bei Updates die Exe ersetzen.

⁠Hostnamen

FeedCrawler kann zum Durchsuchen beliebiger Webseiten verwendet werden. Welche das sind, entscheiden Anwender selbständig bei der Einrichtung. Es gilt dabei:

• Welche Hostname aufgerufen werden entscheidet allein der Anwender.
• Ist nicht mindestens ein Hostname gesetzt, wird der FeedCrawler nicht starten.
• Passen Hostnamen nicht zum jeweiligen Suchmuster des FeedCrawlers, sind Fehlermeldungen möglich.

⁠Startparameter

⁠Sicherheitshinweis

Der Webserver sollte nie ohne Absicherung im Internet freigegeben werden. Dazu lassen sich im Webinterface Nutzername und Passwort festlegen.

Es empfiehlt sich, zusätzlich einen Reverse-Proxy mit HTTPs-Zertifikat, bspw. kostenlos von letsencrypt⁠, zu verwenden.

⁠Credits

• mmarquezs⁠ (My-JDownloader-API für Python)