simon/yellow-externallinks
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-05-28 08:24:57 +02:00
parent d566656227
commit 72243b9885
1 changed files with 4 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
readme.md
View file

@ -1,8 +1,8 @@
<p align="right"><a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/readme-de.md">Deutsch</a> &nbsp; <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/readme.md">English</a></p> <p align="right"><a href="https://codeberg.org/simonpipe/yellow-externallinks/src/branch/main/readme-de.md">Deutsch</a> &nbsp; <a href="https://codeberg.org/simonpipe/yellow-externallinks/src/branch/main/readme.md">English</a></p>
# Mastodonapi 0.9.8 # Externallinks 0.9.0
Import your toots into your blog. Tested with <a href="https://comam.es/what-is-snac">Snac</a>. Open external links in a new tab.
## Installation ## Installation
@ -10,41 +10,7 @@ Import your toots into your blog. Tested with <a href="https://comam.es/what-is-
## How to ## How to
The plugin works fully automatically. It regularly checks in the background if there are new posts. The plugin works fully automatically. Links to an external website are opened in a new tab.
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)
*Find the ID of a Snac or Mastodon account: Enter "https://YOUR_INSTANCE_URL/api/v1/accounts/lookup?acct=PROFILNAME" in your browser.*
*Find the ID of a GoToSocial account <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/help-en.md">(see here)</a>*
`MastodonapiAccessToken` = optional for a Mastodon account, mandatory for a GoToSocial account <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/help-en.md">(see here)</a>
`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/)
`MastodonapiMaxAge` = age of Toots in hours that should still be imported. 0 = all available Toots
`MastodonapiStatus` = page status, default value is public
The following status values are supported:
`public` = page is a normal page
`draft` = page is not visible, user needs to log in, requires <a target="blank_" href="https://github.com/annaesvensson/yellow-draft">draft extension</a>
`unlisted` = page is not visible, but can be accessed with the correct link
## Developer ## Developer