diff --git a/readme.md b/readme.md index af4b194..15776a1 100644 --- a/readme.md +++ b/readme.md @@ -2,30 +2,44 @@ # MastodonAPI -Ein Plug-in, um Toots via Mastodon-API in deinem Blog zu integrieren. -ACHTUNG: Es werden nur öffentliche Toots importiert. +Ein Plug-in, um öffentliche Toots via Mastodon-API in deinen Blog zu importieren. +⚠️ Es werden nur öffentliche Toots importiert. -## Wie man die Erweiterung installiert +--- -ZIP-Datei herunterladen und in dein /system/extensions Verzeichnis kopieren. Deine Seite neu laden und schon ist das Plugin installiert. +## Installation -## Wie man MastodonAPI benutzt +1. ZIP-Datei herunterladen +2. In das Verzeichnis `/system/extensions` kopieren +3. Deine Website neu laden – das Plug-in ist nun installiert -Durch den Aufruf von einem individuellen Webhook wird das Plugin angestossen. Dabei wird via Mastodon-API von deinen Toots ein Blogpost erstellt. Du kannst dabei auch ein bestimmter #hashtag als Filter nutzen. +--- + +## Benutzung + +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. + +--- ## Einstellungen -Die folgenden Einstellungen können in system/extensions/yellow-system.ini: eingestellt werden: +Alle Einstellungen findest du in `system/extensions/yellow-system.ini`: -- MastodonapiInstanceUrl = Deine Mastodon Instanz-URL -- MastodonapiAccountId = Deine Mastodon User ID (numerisch, z.B. 1234567890) -- MastodonapiHashtag = Wenn leer werden alle öffentlichen Beitrage importiert, wenn ein #hashtag angegeben wird, dann nur diese Beiträge -- MastodonapiAuthor = Unter welchem Namen sollen die Blogposts erstellt werden? -- MastodonapiTag = Und mit welchem Tag in deinem Blog -- MastodonapiFolder = Pfad zu deinem Blod-Ordner (z.B. content/1-blog/) -- MastodonapiTriggerPath = /mastodonapi-webhook-CHANGE_THIS_SECRET_KEY (Unbedingt anpassn. Wenn du diesen Link öffnest, dann läuft das Plugin) +- **MastodonapiInstanceUrl** – URL deiner Mastodon-Instanz (z. B. `https://mastodon.social`) +- **MastodonapiAccountId** – deine Mastodon-User-ID (numerisch, z. B. `1234567890`) +- **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` + *(Unbedingt anpassen! Wer diesen Link kennt, kann das Plug-in starten.)* -Wenn du möchtest, kannst du mit dem Webhook auch einen Cronjob einrichten. So kannst du das Plugin automatisch z. B. jede Stunde laufen lassen. +💡 Du kannst den Webhook auch per Cronjob regelmäßig aufrufen (z. B. stündlich). + +--- ## Entwickler -Simon Pipe \ No newline at end of file + +Simon Pipe