Update readme.md

This commit is contained in:
simonpipe 2026-01-07 14:41:17 +01:00
parent 5b48e5649f
commit 67c36ee72b

View file

@ -26,24 +26,24 @@ There are three ways to trigger the import:
All settings are in `system/extensions/yellow-system.ini`: All settings are in `system/extensions/yellow-system.ini`:
- **MastodonapiInstanceUrl** your Mastodon instance URL (e.g. `https://mastodon.social`) - **MastodonapiInstanceUrl** = your Mastodon instance URL (e.g. `https://mastodon.social`)
- **MastodonapiAccountId** - your Mastodon user ID (numeric, e.g. 1234567890) - **MastodonapiAccountId** = your Mastodon user ID (numeric, e.g. 1234567890)
- Find the ID of a Mastodon account: Enter "https://YOUR_INSTANCE_URL/api/v1/accounts/lookup?acct=PROFILNAME" in your browser. - Find the ID of a 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-gotoso-en.md">(see here)</a> - Find the ID of a GoToSocial account <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/help-gotoso-en.md">(see here)</a>
- **MastodonapiAccessToken** - **MastodonapiAccessToken**
- Optional for a Mastodon account - Optional for a Mastodon account
- Mandatory for a GoToSocial account <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/help-gotoso-en.md">(see here)</a> - Mandatory for a GoToSocial account <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/help-gotoso-en.md">(see here)</a>
- **MastodonapiUpdateInterval** Time interval between automatic updates in minutes (default: 30). - **MastodonapiUpdateInterval** = Time interval between automatic updates in minutes (default: 30).
- **MastodonapiLimit** Number of Toots retrieved per run (default: 20). - **MastodonapiLimit** = Number of Toots retrieved per run (default: 20).
- **MastodonapiHashtag** Leave blank for all posts; or filter with #hashtag. - **MastodonapiHashtag** = Leave blank for all posts; or filter with #hashtag.
- **MastodonapiAuthor** Name under which the blog posts should appear. - **MastodonapiAuthor** = Name under which the blog posts should appear.
- **MastodonapiTag** Tag for the blog posts (default: Fediverse). - **MastodonapiTag** = Tag for the blog posts (default: Fediverse).
- **MastodonapiFolder** Path to the blog folder (default: content/2-blog/). - **MastodonapiFolder** = Path to the blog folder (default: content/2-blog/).
- **MastodonapiStatus** Default value is public - **MastodonapiStatus** = Default value is public
- public = page is a normal page - 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> - 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 - 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. - **MastodonapiMaxAge** = Age of Toots in hours that should still be imported. 0 = all available Toots.
## Developer ## Developer