FeedCrawler
FeedCrawler automatisiert bequem das Hinzufügen von Links für den JDownloader.
![GitHub all releases](https://img.shields.io/github/downloads/rix1337/feedcrawler/total?label=github%20downloads)
![PyPI - Downloads](https://img.shields.io/pypi/dm/feedcrawler?label=pypi%20downloads)
![Docker Pulls](https://img.shields.io/docker/pulls/rix1337/docker-feedcrawler)
![Lines of code](https://img.shields.io/endpoint?url=https://ghloc.vercel.app/api/rix1337/FeedCrawler/badge?filter=.py$,.vue$,js$,scss$,yml$&style=flat&logoColor=white&label=Lines%20of%20Code)
![GitHub issues](https://img.shields.io/github/issues/rix1337/FeedCrawler.svg)
Installation
Manuelle Installation
Voraussetzungen
Installation / Update durch pip
pip install -U feedcrawler
Lokaler Build
Benötigt Node.js, npm
und pip:
- Frontend-Pfad aufrufen:
cd feedcrawler/web_interface/vuejs_frontend
- Dependencies installieren:
npm ci
- Vue.js 3 Frontend kompilieren:
npm run build
- Zurück in das Hauptverzeichnis wechseln:
cd ../../..
- FeedCrawler auf Basis der setup.py installieren:
pip install .
Start
feedcrawler
in der Konsole (Python muss im System-PATH hinterlegt sein)
docker run -d \
--name="FeedCrawler" \
-p port:9090 \
-v /path/to/config/:/config:rw \
-e DELAY=30 \
-e LOGLEVEL=[INFO/DEBUG] \
--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
Parameter | Erläuterung |
---|
--log-level=<LOGLEVEL> | Legt fest, wie genau geloggt wird (INFO oder DEBUG ) |
--port=<PORT> | Legt den Port des Webservers fest |
--delay=<SEKUNDEN> | Verzögere Suchlauf nach Start um ganze Zahl in Sekunden (optional) |
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