mirror of
https://codeberg.org/scip/kleingebaeck.git
synced 2025-12-16 20:11:01 +01:00
Added german README, update docker docs, add latest image tag
This commit is contained in:
T.v.Dein
BIN
.github/assets/english.png
vendored
Normal file
BIN
.github/assets/english.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.5 KiB |
BIN
.github/assets/english.xcf
vendored
Normal file
BIN
.github/assets/english.xcf
vendored
Normal file
Binary file not shown.
BIN
.github/assets/german.png
vendored
Normal file
BIN
.github/assets/german.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.9 KiB |
BIN
.github/assets/german.xcf
vendored
Normal file
BIN
.github/assets/german.xcf
vendored
Normal file
Binary file not shown.
6
.github/workflows/pushimage.yaml
vendored
6
.github/workflows/pushimage.yaml
vendored
@@ -26,3 +26,9 @@ jobs:
|
||||
with:
|
||||
push: true
|
||||
tags: ghcr.io/tlinden/kleingebaeck:${{ github.ref_name}}
|
||||
|
||||
- name: Build and push latest Docker image
|
||||
uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
|
||||
with:
|
||||
push: true
|
||||
tags: ghcr.io/tlinden/kleingebaeck:latest
|
||||
|
||||
302
README-de.md
Normal file
302
README-de.md
Normal file
@@ -0,0 +1,302 @@
|
||||
## Kleingebäck - kleinanzeigen.de Backup
|
||||
|
||||
|
||||
|
||||
[](https://goreportcard.com/report/github.com/tlinden/kleingebaeck)
|
||||
[](https://github.com/tlinden/kleingebaeck/actions)
|
||||
[](https://raw.githack.com/wiki/tlinden/kleingebaeck/coverage.html)
|
||||
|
||||
[](https://github.com/TLINDEN/kleingebaeck/releases/latest)
|
||||
[](https://github.com/tlinden/kleingebaeck/blob/main/README.md)
|
||||
Mit diesem Tool kann man seine Anzeigen bei https://kleinanzeigen.de sichern.
|
||||
|
||||
Es kann alle Anzeigen eines Users (oder nur eine Ausgewählte)
|
||||
inklusive der Bilder herunterladen, die in einem Verzeichnis pro
|
||||
Anzeige gespeichert werden. In dem Verzeichnis wird eine Datei
|
||||
`Adlisting.txt` erstellt, in der sich die Inhalte der Anzeige wie
|
||||
Titel, Preis, Text etc befinden. Bilder werden natürlich auch heruntergeladen.
|
||||
|
||||
## Screenshots
|
||||
|
||||
Das ist die Hauptseite meines kleinanzeigen.de Accounts:
|
||||
|
||||
|
||||
|
||||
Sichern ich meine Anzeigen:
|
||||
|
||||
|
||||
|
||||
Backupverzeichnis nach dem Download:
|
||||
|
||||
|
||||
|
||||
Verzeichnis einer Anzeige:
|
||||
|
||||
|
||||
|
||||
**Das gleiche unter Windows:**
|
||||
|
||||
Anzeigen Sichern:
|
||||
|
||||
|
||||
|
||||
Backupverzeichnis nach dem Download
|
||||
|
||||
|
||||
|
||||
Und eine Anzeige:
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
Das Tool hat keine weiteren Abhängigkeiten und erfordert auch keine
|
||||
Anmeldung oder ähnliches. Man kädt sich einfach die ausführbare Datei
|
||||
für seine Plattform herunter und kann direkt loslegen.
|
||||
|
||||
### Installation des vorcompilierten Programms
|
||||
|
||||
Auf der Seite [des letzten Releases](https://github.com/TLINDEN/kleingebaeck/releases/latest) findet man das Program für sein Betriebssystem und die Plattform (z.b. Windows + Intel)
|
||||
|
||||
Es gibt 2 Varianten:
|
||||
|
||||
1. Direkt das fertige Program für seine Plattform+OS herunterladen,
|
||||
z.B. `kleingebaeck-linux-amd64-0.0.5`, nach `kleingebaeck`
|
||||
umbenennen und in ein Verzeichnis kopieren, das im `PATH` ist,
|
||||
(z.B. nach `$HOME/bin` oder als root nach `/usr/local/bin`).
|
||||
|
||||
Um sicher zu gehen, dass an dem Program nicht verändert wurde, kann
|
||||
man die Signatur vergleichen. Für jeden Download gibt es eine dazu
|
||||
passende Signatur, in unserem Beispiel wäre das
|
||||
`kleingebaeck-linux-amd64-0.0.5.sha256`.
|
||||
|
||||
Zum Verifizieren ausführen:
|
||||
|
||||
```shell
|
||||
cat kleingebaeck-linux-amd64-0.0.5.sha25 && sha256sum kleingebaeck-linux-amd64-0.0.5
|
||||
```
|
||||
Man sollte zweimal den gleichen SHA256 Hash sehen.
|
||||
|
||||
2. Man kann auch einen Tarball (tgz Dateiendung) herunterladen,
|
||||
auspacken und mit GNU Make installieren:
|
||||
|
||||
```shell
|
||||
tar xvfz kleingebaeck-linux-amd64-0.0.5.tar.gz
|
||||
cd kleingebaeck-linux-amd64-0.0.5
|
||||
sudo make install
|
||||
```
|
||||
|
||||
### Installation aus dem Sourcecode
|
||||
|
||||
Man muss eine funktionierende Go Buildumgebung in der Version 1.21
|
||||
installiert haben, um das Programm selber zu compilieren. GNU Make ist
|
||||
hilfreich, aber nicht unbedingt erforderlich.
|
||||
|
||||
Um das Programm zu compilieren, muss man folgende Schritte ausführen:
|
||||
|
||||
```shell
|
||||
git clone https://github.com/TLINDEN/kleingebaeck.git
|
||||
cd kleingebaeck
|
||||
go mod tidy
|
||||
make # (oder make)
|
||||
sudo make install
|
||||
```
|
||||
|
||||
### Docker image benutzen
|
||||
|
||||
Ein fertiges Dockerimage mit der aktuellen Programmversion ist immer
|
||||
verfügbar. Man kann damit z.B. das Tool testen, bevor man es dauerhaft
|
||||
benutzen möchte.
|
||||
|
||||
Um das Image herunterzuladen:
|
||||
```
|
||||
docker pull ghcr.io/tlinden/kleingebaeck:latest
|
||||
```
|
||||
|
||||
Um kleingebäck im Image auszuführen und Daten ins lokale Filesystem zu
|
||||
sichern, kann man so vorgehen:
|
||||
|
||||
```shell
|
||||
mkdir anzeigen
|
||||
docker run -u `id -u $USER` -v ./anzeigen:/backup ghcr.io/tlinden/kleingebaeck:latest -u XXX -v
|
||||
ls -l anzeigen/ein-buch-mit-leeren-seiten
|
||||
total 792
|
||||
drwxr-xr-x 2 scip root 4096 Jan 23 12:58 ./
|
||||
drwxr-xr-x 3 scip scip 4096 Jan 23 12:58 ../
|
||||
-rw-r--r-- 1 scip root 131650 Jan 23 12:58 1.jpg
|
||||
-rw-r--r-- 1 scip root 81832 Jan 23 12:58 2.jpg
|
||||
-rw-r--r-- 1 scip root 134050 Jan 23 12:58 3.jpg
|
||||
-rw-r--r-- 1 scip root 1166 Jan 23 12:58 Adlisting.txt
|
||||
```
|
||||
|
||||
Hier wird der aktuelle User auf den User im Image gemappt und das
|
||||
lokale Verzeichnis `anzeigen` nach `/backup` innerhalb des Images
|
||||
gemountet.
|
||||
|
||||
Die Optionen `-u XXX -v` sind kleingebäck Optionen. Ersetze `XXX`
|
||||
durch Deine tatsächliche kleinanzeigen.de Userid.
|
||||
|
||||
Eine Liste verfügbarer Images findet man [hier](https://github.com/tlinden/kleingebaeck/pkgs/container/kleingebaeck/versions?filters%5Bversion_type%5D=tagged)
|
||||
|
||||
## Kommandozeilen Optionen:
|
||||
|
||||
```
|
||||
Usage: kleingebaeck [-dvVhmoc] [<ad-listing-url>,...]
|
||||
Options:
|
||||
-u --user <uid> Backup ads from user with uid <uid>.
|
||||
-d --debug Enable debug output.
|
||||
-v --verbose Enable verbose output.
|
||||
-o --outdir <dir> Set output dir (default: current directory)
|
||||
-l --limit <num> Limit the ads to download to <num>, default: load all.
|
||||
-c --config <file> Use config file <file> (default: ~/.kleingebaeck).
|
||||
--ignoreerrors Ignore HTTP errors, may lead to incomplete ad backup.
|
||||
-m --manual Show manual.
|
||||
-h --help Show usage.
|
||||
-V --version Show program version.
|
||||
|
||||
If one or more <ad-listing-url>'s are specified, only backup those,
|
||||
otherwise backup all ads of the given user.
|
||||
```
|
||||
|
||||
## Konfiguration
|
||||
|
||||
Man kann anstelle von Kommandlineoptionen auch eine
|
||||
Konfigurationsdatei verwenden. Sie befindet sich standardmäßig in
|
||||
`~/.kleingebaeck` aber man kann mit dem Parameter `-c` auch eine
|
||||
andere Datei angeben.
|
||||
|
||||
Das Format (TOML) ist einfach:
|
||||
|
||||
```
|
||||
user = 1010101
|
||||
loglevel = verbose
|
||||
outdir = "test"
|
||||
```
|
||||
|
||||
Im Source gibt es eine Beispieldatei `example.conf` mit Kommentaren.
|
||||
|
||||
## Umgebungsvariablen
|
||||
|
||||
Man kann darüber hinaus auch Umgebungsvariablen verwenden. Sie
|
||||
entsprechen den Konfigurationsoptionen, aber gross geschrieben mit dem
|
||||
Präfix `KLEINGEBAECK_`, z.B.
|
||||
|
||||
```shell
|
||||
% KLEINGEBAECK_OUTDIR=/backup kleingebaeck -v
|
||||
```
|
||||
|
||||
## Benutzung
|
||||
|
||||
Um das Tool einsetzen zu können, muss man zunächst seine Userid bei
|
||||
kleinanzeigen.de herausfinden. Dazu ruft man am besten die Liste
|
||||
seiner Anzeigen auf, während man NICHT eingeloggt ist:
|
||||
|
||||
https://www.kleinanzeigen.de/s-bestandsliste.html?userId=XXXXXX
|
||||
|
||||
Der `XXXXX` Teil der URL ist die Userid.
|
||||
|
||||
Trage diese Userid in der Konfigurationsdatei ein wie oben
|
||||
beschrieben. Gib ausserdem das Ausgabeverzeichnis an. Dann einfach nur
|
||||
`kleingebaeck` ausführen.
|
||||
|
||||
Innerhalb des Ausgabeverzeichnisses wird sich dann pro Anzeige ein
|
||||
Unterverzeichnis befinden. Pro Anzeige gibt es eine Datei
|
||||
`Adlisting.txt`, die etwa so aussieht:
|
||||
|
||||
```default
|
||||
Title: A book I sell
|
||||
Price: 99 € VB
|
||||
Id: 1919191919
|
||||
Category: Sachbücher
|
||||
Condition: Sehr Gut
|
||||
Created: 10.12.2023
|
||||
|
||||
This is the description text.
|
||||
|
||||
Pay with paypal.
|
||||
```
|
||||
|
||||
Sowie alle Bilder.
|
||||
|
||||
Das Format kann man mit der Variable `template` in der Konfiguration
|
||||
ändern. Die `example.conf` enthält ein Beispiel für das Standard Template.
|
||||
|
||||
## Documentation
|
||||
|
||||
Die Dokumentation kann man
|
||||
[online](https://github.com/TLINDEN/kleingebaeck/blob/main/kleingebaeck.pod)
|
||||
oder lokal lesen mit: `kleingebaeck --manual`. Hat man das Tool mit
|
||||
dem Tarball installiert, funktioniert auch `man kleingebaeck`.
|
||||
|
||||
## Kleingebäck?
|
||||
|
||||
Der Name kommt von "kleinanzeigen backup", verkürzt "klein back", das
|
||||
englisch ausgesprochene "back" (deutsch bäck) führt dann zu "Kleingebäck".
|
||||
|
||||
## Wo bekommt man Hilfe
|
||||
|
||||
Obwohl ich gerne von kleingebäck Benutzern in privaten Mails höre, ist
|
||||
das doch der beste Weg, die Anfrage zu übersehen und zu vergessen.
|
||||
|
||||
Um einen Fehler, ein unerwartetes Verhalten, eine Feature Request oder
|
||||
einen Patch zu übermitteln, eröffne daher bitte einen Issue unter:
|
||||
https://github.com/TLINDEN/kleingebaeck/issues. Danke!
|
||||
|
||||
Bitte gebe den fehlgeschlagenen Befehl an, rufe es auch mit Debugging
|
||||
`-d` auf.
|
||||
|
||||
## Ähnliche Projekte
|
||||
|
||||
Ich konnte kein Projekt finden, das speziell dafür geeignet ist,
|
||||
Anzeigen bei kleinanzeigen.de zu sichern.
|
||||
|
||||
Aber es gibt ein Projekt, mit dem man ebenfalls Backups erstellen
|
||||
kann: [kleinanzeigen-bot](https://github.com/Second-Hand-Friends/kleinanzeigen-bot/).
|
||||
Aber Vorsicht: kleinanzeigen.de bekämpft Bots aktiv, mit diesem hier
|
||||
gibt es regelmäßige Probleme, z.B.:
|
||||
[issue](https://github.com/Second-Hand-Friends/kleinanzeigen-bot/issues/219).
|
||||
Das Hauptproblem ist, dass diese Art von Bot sich mit Deinem Account
|
||||
aktiv einloggt und mit der Seite interagiert. Damit kann die Firma die
|
||||
Aktivitäten recht einfach Deinem User zuordnen und diesen **sperren**!
|
||||
Also sei bitte vorsichtig!
|
||||
|
||||
**Kleingebäck** erfordert keinen Login, es verwendet lediglich die
|
||||
öffentlich verfügbare Webseite und ruft diese auf, wie ein normaler
|
||||
Browser. Tatsächlich gibt es meiner Meinung nach keinen Unterschied zu
|
||||
einem Browserclient: beide laufen auf Anwenderseite auf Initiative
|
||||
eines Benutzers. Und mit welchen Browser ich eine Webseite aufrufe,
|
||||
bleibt immer noch mir überlassen und muss mir nicht von irgendwem
|
||||
vorgeschrieben werden. Das schliesst die Verwendung von Kleingebäck
|
||||
mit ein.
|
||||
|
||||
Hinzu kommt, dass dieses Tool nicht dazu gedacht ist, rund um die Uhr
|
||||
zu laufen. Man ruft es ab und zu mal auf, wenn man halt neue Anzeigen
|
||||
eingestellt hat, vielleicht einmal die Woche oder so. Man weiss ja
|
||||
selber, wann man was geändert hat. Man benötigt trotzdem den Zugriff
|
||||
mit dem Browser oder der mobilen App um Kleinanzeigen.de verwalten zu
|
||||
können.
|
||||
|
||||
Meiner Ansicht nach ist das Risiko also sehr minimal, es handelt sich
|
||||
meiner Meinung nach auch nicht um eine Verletzung der AGBs dort. Aber
|
||||
das ist nur meine persönliche Meinung, bitte beachtet das. Am Ende
|
||||
müsst Ihr selbst einschätzen und beurteilen wie hoch Ihr das Risiko
|
||||
seht und ob Ohr es eingehen möchtet. Für eventuell auftretende
|
||||
Konsequenzen bin ich nicht verantwortlich. Siehe auch [GPL Lizenz](LICENSE).
|
||||
|
||||
Es gibt noch ein weiteres Tool namens
|
||||
[kleinanzeigen-enhanded](https://kleinanzeigen-enhanced.de/). Das ist
|
||||
eine kostenpflichtige vollständige Anzeigenverwaltung für
|
||||
Profinutzer. Man muss eine monatliche Abogebühr bezahlen. Das Tool
|
||||
ist als Browsererweiterung für Google Chrome implementiert, was
|
||||
erklärt, warum sie Anzeigen erstellen, ändern und löschen können,
|
||||
obwohl es gar keine öffentliche API gibt. Sieht nach einer netten
|
||||
ausgereiften Lösung aus. Mit Backups.
|
||||
|
||||
## Copyright und License
|
||||
|
||||
Lizensiert unter der GNU GENERAL PUBLIC LICENSE Version 3.
|
||||
|
||||
## Autor
|
||||
|
||||
T.v.Dein <tom AT vondein DOT org>
|
||||
|
||||
46
README.md
46
README.md
@@ -7,7 +7,9 @@
|
||||
[](https://raw.githack.com/wiki/tlinden/kleingebaeck/coverage.html)
|
||||
|
||||
[](https://github.com/TLINDEN/kleingebaeck/releases/latest)
|
||||
[](https://github.com/tlinden/kleingebaeck/blob/main/README-de.md)
|
||||
|
||||
[Die deutsche Version des READMEs findet Ihr hier](README-de.md).
|
||||
|
||||
This tool can be used to backup ads on the german ad page https://kleinanzeigen.de
|
||||
|
||||
@@ -60,7 +62,7 @@ Go to the [latest release
|
||||
page](https://github.com/TLINDEN/kleingebaeck/releases/latest) and
|
||||
look for your OS and platform. There are two options to install the binary:
|
||||
|
||||
1. Directly download the binary for your platoform,
|
||||
1. Directly download the binary for your platform,
|
||||
e.g. `kleingebaeck-linux-amd64-0.0.5`, rename it to `kleingebaeck`
|
||||
(or whatever you like more!) and put it into your bin dir
|
||||
(e.g. `$HOME/bin` or as root to `/usr/local/bin`).
|
||||
@@ -97,29 +99,37 @@ To install after building either copy the binary or execute `sudo make install`.
|
||||
### Using the docker image
|
||||
|
||||
A pre-built docker image is available, which you can use to test the
|
||||
app without installing it. You need `docker-compose`. Copy the file
|
||||
`docker-compose.yaml` to somewhere, cd to that directory and execute:
|
||||
app without installing it. To download:
|
||||
|
||||
```shell
|
||||
mkdir kleinanzeigen-backup
|
||||
USER_ID=$(id -u) GROUP_ID=$(id -g) OUTDIR=./kleinanzeigen-backup docker-compose run kleingebaeck -u XXX -v
|
||||
docker pull ghcr.io/tlinden/kleingebaeck:latest
|
||||
```
|
||||
|
||||
`USER_ID` and `GROUP_ID` needs to be specified so that you are the
|
||||
owner of the created backups. The backup directory `OUTDIR` must exist
|
||||
prior to the execution, otherwise docker will create it as root, then
|
||||
kleingebaeck will fail. You may also use a `.env` file in the same
|
||||
directory containing the variables, such as:
|
||||
To execute kleingebaeck inside the image and download ads to a local
|
||||
directory, do something like this:
|
||||
|
||||
```
|
||||
USER_ID=1000
|
||||
GROUP_ID=1000
|
||||
OUTDIR=./kleinanzeigen-backup
|
||||
```shell
|
||||
mkdir myads
|
||||
docker run -u `id -u $USER` -v ./myads:/backup ghcr.io/tlinden/kleingebaeck:latest -u XXX -v
|
||||
ls -l myads/ein-buch-mit-leeren-seiten
|
||||
total 792
|
||||
drwxr-xr-x 2 scip root 4096 Jan 23 12:58 ./
|
||||
drwxr-xr-x 3 scip scip 4096 Jan 23 12:58 ../
|
||||
-rw-r--r-- 1 scip root 131650 Jan 23 12:58 1.jpg
|
||||
-rw-r--r-- 1 scip root 81832 Jan 23 12:58 2.jpg
|
||||
-rw-r--r-- 1 scip root 134050 Jan 23 12:58 3.jpg
|
||||
-rw-r--r-- 1 scip root 1166 Jan 23 12:58 Adlisting.txt
|
||||
```
|
||||
|
||||
You may of course also modify the `docker-compose.yaml` to suit your needs.
|
||||
We map the local user to the one inside the image so the permission
|
||||
will match. You'll need to create the directory first before executing
|
||||
docker run. And the local directory `myads` will be mapped to
|
||||
`/backup` inside the container.
|
||||
|
||||
If you want to build the image yourself, use the supplied Dockerfile.
|
||||
The options `-u XXX -v` are kleingebaeck options, replace `XXX` with
|
||||
your actual kleinanzeigen.de user id.
|
||||
|
||||
A list of available images is [here](https://github.com/tlinden/kleingebaeck/pkgs/container/kleingebaeck/versions?filters%5Bversion_type%5D=tagged)
|
||||
|
||||
## Commandline options:
|
||||
|
||||
@@ -246,9 +256,9 @@ daily basis. You cannot use it to view regular ads or maintain your
|
||||
own ads. You'll need to use the mobile app or the browser page with a
|
||||
login. So, in my point of view, the risk is very minimal.
|
||||
|
||||
There is another Tool available named [kleinanzeigen-enhanded](https://kleinanzeigen-enhanced.de/). It is a complete Ad management system targeting primarily commercial users. You have to pay a monthly fee, perhaps there's also a free version available, but I haven't checked. The tool is implemented as a Chrome browser extension, which explains why it was possible to implement it without an API. It seems to be a nice solution for power users by the looks of it. And it includes backups.
|
||||
There is another Tool available named [kleinanzeigen-enhanced](https://kleinanzeigen-enhanced.de/). It is a complete Ad management system targeting primarily commercial users. You have to pay a monthly fee, perhaps there's also a free version available, but I haven't checked. The tool is implemented as a Chrome browser extension, which explains why it was possible to implement it without an API. It seems to be a nice solution for power users by the looks of it. And it includes backups.
|
||||
|
||||
## Copyright und License
|
||||
## Copyright and License
|
||||
|
||||
Licensed under the GNU GENERAL PUBLIC LICENSE version 3.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user