simon/yellow-mastodonapi
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Import your toots from Mastodon and GoToSocial instances into your blog.
145 commits 1 branch 1 tag 189 KiB
PHP 100%
Find a file
simonpipe bee65004f4 Update readme.md
2026-01-07 10:45:39 +01:00
.gitattributes Add .gitattributes 2026-01-01 15:59:00 +01:00
extension.ini Update extension.ini 2026-01-07 09:58:34 +01:00
help-gotoso-de.md Update help-gotoso-de.md 2025-08-21 12:16:34 +02:00
help-gotoso-en.md Update help-gotoso-en.md 2025-08-21 12:17:01 +02:00
LICENSE LICENSE aktualisiert 2025-08-14 09:49:20 +02:00
mastodonapi.php Update mastodonapi.php 2026-01-07 09:58:23 +01:00
readme-de.md Update readme-de.md 2026-01-07 10:45:26 +01:00
readme.md Update readme.md 2026-01-07 10:45:39 +01:00

readme.md

Deutsch   English

MastodonAPI

A plugin to import your public Toots via the Mastodon API into your Yellow Blog. The plugin works with Mastodon and with GoToSocial.

Installation

  1. Download the ZIP file
  2. Copy it into the /system/extensions directory
  3. Reload your website – the plugin is now installed

How it works

The plugin works fully automatically. It regularly checks in the background if there are new posts.

When you visit the site, it queries your Mastodon API and automatically creates blog posts from your Toots. Optionally, you can specify a #Hashtag to import only certain posts.

There are three ways to trigger the import:

  1. Automatic (Lazy Cron): As soon as a visitor accesses your website, the plugin checks if the update interval has expired and loads new Toots if necessary.
  2. From the terminal: You can manually start the import on the server with: php yellow.php mastodonapi
  3. From the system cronjob: If your host supports cronjobs, you can have the command php yellow.php mastodonapi run regularly (e.g. every 30 minutes).

Settings

All settings are in system/extensions/yellow-system.ini:

  • MastodonapiInstanceUrl – your Mastodon instance URL (e.g. https://mastodon.social)
  • MastodonapiAccountId - your Mastodon user ID (numeric, e.g. 1234567890)
  • MastodonapiAccessToken
    • Optional for a Mastodon account
    • Mandatory for a GoToSocial account (see here)
  • MastodonapiUpdateInterval – Time interval between automatic updates in minutes (default: 30).
  • MastodonapiLimit – Number of Toots retrieved per run (default: 20).
  • MastodonapiHashtag – Leave blank for all posts; or filter with #hashtag.
  • MastodonapiAuthor – Name under which the blog posts should appear.
  • MastodonapiTag – Tag for the blog posts (default: Fediverse).
  • MastodonapiFolder – Path to the blog folder (default: content/2-blog/).
  • MastodonapiStatus – Default value is public
    • public = page is a normal page
    • draft = page is not visible, user needs to log in, requires draft extension
    • unlisted = page is not visible, but can be accessed with the correct link
  • MastodonapiMaxAge – Age of Toots in hours that should still be imported. 0 = all available Toots.

Developer

Simon