simon/yellow-mastodonapi
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme.md

Browse source
This commit is contained in:
simonpipe 2026-01-07 09:22:13 +01:00
parent 925f996db3
commit c21fd9e4b9
1 changed files with 18 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
readme.md
View file

@ -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 2. In das Verzeichnis `/system/extensions` kopieren
3. Deine Website neu laden – das Plug-in ist nun installiert 3. Deine Website neu laden – das Plug-in ist nun installiert
## Benutzung ## Funktionsweise
Das Plug-in wird über einen individuellen **Webhook** aufgerufen. 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. 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 ## Einstellungen
@ -27,21 +34,18 @@ Alle Einstellungen findest du in `system/extensions/yellow-system.ini`:
- **MastodonapiAccessToken** - **MastodonapiAccessToken**
- Bei einem Mastodon-Account optional - Bei einem Mastodon-Account optional
- Bei einem GoToSocial-Account pflicht <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/help-gotoso-de.md">(siehe hier)</a> - Bei einem GoToSocial-Account pflicht <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/help-gotoso-de.md">(siehe hier)</a>
- **MastodonapiLimit** - Standartwert ist 20 - **MastodonapiUpdateInterval** – Zeitabstand zwischen den automatischen Updates in Minuten (Standard: `30`).
- **MastodonapiHashtag** – leer lassen = alle öffentlichen Beiträge importieren; mit `#hashtag` = nur Beiträge mit diesem Tag - **MastodonapiLimit** – Anzahl der abgerufenen Toots pro Lauf (Standard: `20`).
- **MastodonapiAuthor** – Name, unter dem die Blogposts erscheinen sollen - **MastodonapiHashtag** – Leer lassen für alle Beiträge; oder mit `#hashtag` filtern.
- **MastodonapiTag** – Tag, mit dem die Blogposts im Blog versehen werden - **MastodonapiAuthor** – Name, unter dem die Blogposts erscheinen sollen .
- **MastodonapiFolder** – Pfad zum Blog-Ordner (z. B. `content/1-blog/`) - **MastodonapiTag** – Tag für die Blogposts (Standard: `Fediverse`).
- **MastodonapiTriggerPath** – Webhook-Pfad, z. B. `/mastodonapi-webhook-CHANGE_THIS_SECRET_KEY` - **MastodonapiFolder** – Pfad zum Blog-Ordner (Standard: `content/2-blog/`).
- Unbedingt anpassen! Wer diesen Link kennt, kann das Plug-in starten. - Unbedingt anpassen! Wer diesen Link kennt, kann das Plug-in starten.
- **MastodonapiStatus** – Standartwert ist public - **MastodonapiStatus** – Standartwert ist public
- public = Seite ist eine normale sichtbar - public = Seite ist eine normale sichtbar
- draft = Die Seite ist nicht sichtbar, der Benutzer muss sich anmelden, erfordert die <a target="blank_" href="https://github.com/annaesvensson/yellow-draft">Erweiterung «Draft</a> - draft = Die Seite ist nicht sichtbar, der Benutzer muss sich anmelden, erfordert die <a target="blank_" href="https://github.com/annaesvensson/yellow-draft">Erweiterung «Draft</a>
- unlisted = Die Seite ist nicht sichtbar, aber mit dem richtigen Link erreichbar - unlisted = Die Seite ist nicht sichtbar, aber mit dem richtigen Link erreichbar
- **MastodonapiMaxAge** – Standartwert ist 0 - **MastodonapiMaxAge** – Alter der Toots in Stunden, die noch importiert werden sollen. `0` = alle verfügbaren Toots.
- In Stunden. 0 = alle Toots.
💡 Du kannst den Webhook auch per Cronjob regelmäßig aufrufen (z. B. stündlich).
## Entwickler ## Entwickler