50 lines
3.1 KiB
Markdown
50 lines
3.1 KiB
Markdown
<p align="right"><a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/readme-de.md">Deutsch</a> <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/readme.md">English</a></p>
|
||
|
||
# MastodonAPI
|
||
|
||
Ein Plug-in, um deine öffentlichen Toots via Mastodon-API in deinen Yellow Blog zu importieren. Das Plugin funktiert mit Mastodon und mit GoToSocial.
|
||
|
||
## Installation
|
||
|
||
1. ZIP-Datei herunterladen
|
||
2. In das Verzeichnis `/system/extensions` kopieren
|
||
3. Deine Website neu laden – das Plug-in ist nun installiert
|
||
|
||
## Funktionsweise
|
||
|
||
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
|
||
|
||
Alle Einstellungen findest du in `system/extensions/yellow-system.ini`:
|
||
|
||
- **MastodonapiInstanceUrl** – URL deiner Mastodon-Instanz (z. B. `https://mastodon.social`)
|
||
- **MastodonapiAccountId** – deine Mastodon-User-ID (numerisch, z. B. `1234567890`)
|
||
- ID bei einem Mastodon-Account finden: Gib im Browser "https://DEINE_INSTANZ_URL/api/v1/accounts/lookup?acct=PROFILNAME" ein.
|
||
- ID bei einem GoToSocial-Account finden <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/help-gotoso-de.md">(siehe hier)</a>
|
||
- **MastodonapiAccessToken**
|
||
- 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>
|
||
- **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/`).
|
||
- **MastodonapiStatus** – Standartwert ist public
|
||
- 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>
|
||
- unlisted = Die Seite ist nicht sichtbar, aber mit dem richtigen Link erreichbar
|
||
- **MastodonapiMaxAge** – Alter der Toots in Stunden, die noch importiert werden sollen. `0` = alle verfügbaren Toots.
|
||
|
||
## Entwickler
|
||
|
||
Simon Pipe
|