From c21fd9e4b9d78ca3caa072390f2d0c990d99ac75 Mon Sep 17 00:00:00 2001 From: simonpipe Date: Wed, 7 Jan 2026 09:22:13 +0100 Subject: [PATCH] Update readme.md --- readme.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/readme.md b/readme.md index cbbde80..1498710 100644 --- a/readme.md +++ b/readme.md @@ -10,11 +10,18 @@ Ein Plug-in, um deine öffentlichen Toots via Mastodon-API in deinen Yellow Blog 2. In das Verzeichnis `/system/extensions` kopieren 3. Deine Website neu laden – das Plug-in ist nun installiert -## Benutzung +## Funktionsweise -Das Plug-in wird über einen individuellen **Webhook** aufgerufen. -Beim Aufruf fragt es deine Mastodon-API ab und erstellt aus deinen Toots automatisch Blogbeiträge. -Optional kannst du einen **#Hashtag** angeben, um nur bestimmte Beiträge zu importieren. +Das Plug-in arbeitet vollautomatisch. Es prüft regelmäßig im Hintergrund, ob neue Beiträge vorhanden sind. + +Beim Aufruf fragt es deine Mastodon-API ab und erstellt aus deinen Toots automatisch Blogbeiträge. Optional kannst du einen **#Hashtag** angeben, um nur bestimmte Beiträge zu importieren. + +Es gibt drei Wege, wie der Import ausgelöst wird: + +1. **Automatisch (Lazy Cron):** Sobald ein Besucher deine Website aufruft, prüft das Plug-in, ob das Update-Intervall abgelaufen ist und lädt gegebenenfalls neue Toots. +2. **Per Terminal:** Du kannst den Import manuell auf dem Server starten mit: + `php yellow.php mastodonapi` +3. **Per System-Cronjob:** Wenn dein Hoster Cronjobs unterstützt, kannst du den Befehl `php yellow.php mastodonapi` regelmäßig (z. B. alle 30 Minuten) ausführen lassen. ## Einstellungen @@ -27,21 +34,18 @@ Alle Einstellungen findest du in `system/extensions/yellow-system.ini`: - **MastodonapiAccessToken** - Bei einem Mastodon-Account optional - Bei einem GoToSocial-Account pflicht (siehe hier) -- **MastodonapiLimit** - Standartwert ist 20 -- **MastodonapiHashtag** – leer lassen = alle öffentlichen Beiträge importieren; mit `#hashtag` = nur Beiträge mit diesem Tag -- **MastodonapiAuthor** – Name, unter dem die Blogposts erscheinen sollen -- **MastodonapiTag** – Tag, mit dem die Blogposts im Blog versehen werden -- **MastodonapiFolder** – Pfad zum Blog-Ordner (z. B. `content/1-blog/`) -- **MastodonapiTriggerPath** – Webhook-Pfad, z. B. `/mastodonapi-webhook-CHANGE_THIS_SECRET_KEY` +- **MastodonapiUpdateInterval** – Zeitabstand zwischen den automatischen Updates in Minuten (Standard: `30`). +- **MastodonapiLimit** – Anzahl der abgerufenen Toots pro Lauf (Standard: `20`). +- **MastodonapiHashtag** – Leer lassen für alle Beiträge; oder mit `#hashtag` filtern. +- **MastodonapiAuthor** – Name, unter dem die Blogposts erscheinen sollen . +- **MastodonapiTag** – Tag für die Blogposts (Standard: `Fediverse`). +- **MastodonapiFolder** – Pfad zum Blog-Ordner (Standard: `content/2-blog/`). - Unbedingt anpassen! Wer diesen Link kennt, kann das Plug-in starten. - **MastodonapiStatus** – Standartwert ist public - public = Seite ist eine normale sichtbar - draft = Die Seite ist nicht sichtbar, der Benutzer muss sich anmelden, erfordert die Erweiterung «Draft - unlisted = Die Seite ist nicht sichtbar, aber mit dem richtigen Link erreichbar -- **MastodonapiMaxAge** – Standartwert ist 0 - - In Stunden. 0 = alle Toots. - -💡 Du kannst den Webhook auch per Cronjob regelmäßig aufrufen (z. B. stündlich). +- **MastodonapiMaxAge** – Alter der Toots in Stunden, die noch importiert werden sollen. `0` = alle verfügbaren Toots. ## Entwickler