diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..210c4bb --- /dev/null +++ b/readme.md @@ -0,0 +1,29 @@ +

Deutsch   English

+ +# MastodonAPI + +Ein Plug-in, um via Tröts via Mastodon-API in deinem Blog zu integrieren. + +## 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. + +## Wie man MastodonAPI benutzt + +Durch den Aufruf von einem individuellen Webhook wird das Plugin angestossen. Dabei wird der RSS-Feed deines Mastodon-Kontos aufgerufen und einzelne Toots als Blogpost erstellt. Du kannst dabei auch ein bestimmter #hashtag als Filter nutzen. + +## Einstellungen + +Die folgenden Einstellungen können in system/extensions/yellow-system.ini: eingestellt werden: + +- MastodonapiFeedurl = Die Feed-URL zu deinem Mastodon-Konto +- MastodonapiHashtag = Wenn leer werden alle 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) + +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. + +## Entwickler +Simon Pipe \ No newline at end of file