Update readme-de.md
This commit is contained in:
simonpipe
parent
00c5c17e22
commit
d1fc6613d3
1 changed files with 44 additions and 31 deletions
75
readme-de.md
75
readme-de.md
|
|
@ -1,50 +1,63 @@
|
||||||
<p align="right"><a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/readme-de.md">Deutsch</a> <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-mastodonapi/src/branch/main/readme-de.md">Deutsch</a> <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/readme.md">English</a></p>
|
||||||
|
|
||||||
# MastodonAPI
|
# Mastodonapi 0.9
|
||||||
|
|
||||||
Ein Plug-in, um deine öffentlichen Toots via Mastodon-API in deinen Yellow Blog zu importieren. Das Plugin funktiert mit Mastodon und mit GoToSocial.
|
Mastodonapi ist eine Erweiterung für <a target="blank_" href="https://datenstrom.se/yellow/">Datenstrom Yellow</a>, um deine öffentlichen Beiträge (Toots) in dein Blog zu importieren. Sie funktioniert mit Mastodon- und GoToSocial-Instanzen.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. ZIP-Datei herunterladen
|
<a href="https://codeberg.org/simonpipe/yellow-mastodonapi/archive/main.zip">Lade die ZIP-Datei herunter</a> und kopiere sie in deinen system/extensions Ordner. <a target="blank_" href="https://github.com/annaesvensson/yellow-update">Erfahre mehr über Erweiterungen</a>.
|
||||||
2. In das Verzeichnis `/system/extensions` kopieren
|
|
||||||
3. Deine Website neu laden – das Plug-in ist nun installiert
|
|
||||||
|
|
||||||
## Funktionsweise
|
## Funktionsweise
|
||||||
|
|
||||||
Das Plug-in arbeitet vollautomatisch. Es prüft regelmäßig im Hintergrund, ob neue Beiträge vorhanden sind.
|
Das Plugin arbeitet vollautomatisch. Es prüft im Hintergrund regelmäßig, ob neue Beiträge vorhanden sind.
|
||||||
|
|
||||||
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.
|
Wenn du die Seite besuchst, fragt es deine Mastodon-API ab und erstellt automatisch Blog-Beiträge aus deinen Toots. Optional kannst du einen #Hashtag angeben, um nur bestimmte Beiträge zu importieren.
|
||||||
|
|
||||||
Es gibt drei Wege, wie der Import ausgelöst wird:
|
Es gibt drei Möglichkeiten, den Import auszulösen:
|
||||||
|
|
||||||
1. **Automatisch (Lazy Cron):** Sobald ein Besucher deine Website aufruft, prüft das Plug-in, ob das Update-Intervall abgelaufen ist und lädt gegebenenfalls neue Toots.
|
Automatisch (Lazy Cron): Sobald ein Besucher deine Website aufruft, prüft das Plugin, ob das Update-Intervall abgelaufen ist und lädt bei Bedarf neue Toots.
|
||||||
2. **Per Terminal:** Du kannst den Import manuell auf dem Server starten mit: `php yellow.php mastodonapi`
|
|
||||||
3. **Per System-Cronjob:** Wenn dein Hoster Cronjobs unterstützt, kannst du den Befehl `php yellow.php mastodonapi` regelmäßig (z. B. alle 30 Minuten) ausführen lassen.
|
Über das Terminal: Du kannst den Import manuell auf dem Server starten mit: php yellow.php mastodonapi
|
||||||
|
|
||||||
|
Über den System-Cronjob: Falls dein Host Cronjobs unterstützt, kannst du den Befehl php yellow.php mastodonapi regelmäßig ausführen lassen (z. B. alle 30 Minuten).
|
||||||
|
|
||||||
## Einstellungen
|
## Einstellungen
|
||||||
|
|
||||||
Alle Einstellungen findest du in `system/extensions/yellow-system.ini`:
|
Alle Einstellungen befinden sich in system/extensions/yellow-system.ini:
|
||||||
|
|
||||||
- **MastodonapiInstanceUrl** – URL deiner Mastodon-Instanz (z. B. `https://mastodon.social`)
|
MastodonapiInstanceUrl = deine Mastodon Instanz-URL (z. B. https://mastodon.social)
|
||||||
- **MastodonapiAccountId** – deine Mastodon-User-ID (numerisch, z. B. `1234567890`)
|
|
||||||
- ID bei einem Mastodon-Account finden: Gib im Browser "https://DEINE_INSTANZ_URL/api/v1/accounts/lookup?acct=PROFILNAME" ein.
|
MastodonapiAccountId = deine Mastodon User-ID (numerisch, z. B. 1234567890)
|
||||||
- ID bei einem GoToSocial-Account finden <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/help-gotoso-de.md">(siehe hier)</a>
|
|
||||||
- **MastodonapiAccessToken**
|
Finde die ID eines Mastodon-Accounts: Gib "https://DEINE_INSTANZ_URL/api/v1/accounts/lookup?acct=PROFILNAME" in deinen Browser ein. Finde die ID eines GoToSocial-Accounts <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/help-gotoso-de.md">(siehe hier)</a>
|
||||||
- Bei einem Mastodon-Account optional
|
|
||||||
- Bei einem GoToSocial-Account pflicht <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/help-gotoso-de.md">(siehe hier)</a>
|
MastodonapiAccessToken = optional für einen Mastodon-Account, zwingend für einen GoToSocial-Account <a href="https://codeberg.org/simonpipe/yellow-mastodonapi/src/branch/main/help-gotoso-de.md">(siehe hier)</a>
|
||||||
- **MastodonapiUpdateInterval** – Zeitabstand zwischen den automatischen Updates in Minuten (Standard: `30`).
|
|
||||||
- **MastodonapiLimit** – Anzahl der abgerufenen Toots pro Lauf (Standard: `20`).
|
MastodonapiUpdateInterval = Zeitintervall zwischen automatischen Updates in Minuten (Standard: 30).
|
||||||
- **MastodonapiHashtag** – Leer lassen für alle Beiträge; oder mit `#hashtag` filtern.
|
|
||||||
- **MastodonapiAuthor** – Name, unter dem die Blogposts erscheinen sollen .
|
MastodonapiLimit = Anzahl der Toots, die pro Durchgang abgerufen werden (Standard: 20).
|
||||||
- **MastodonapiTag** – Tag für die Blogposts (Standard: `Fediverse`).
|
|
||||||
- **MastodonapiFolder** – Pfad zum Blog-Ordner (Standard: `content/2-blog/`).
|
MastodonapiHashtag = leer lassen für alle Beiträge; oder mit #hashtag filtern.
|
||||||
- **MastodonapiStatus** – Standartwert ist public
|
|
||||||
- public = Seite ist normal sichtbar
|
MastodonapiAuthor = Name, unter dem die Blog-Beiträge erscheinen sollen.
|
||||||
- draft = Die Seite ist nicht sichtbar, der Benutzer muss sich anmelden, erfordert die <a target="blank_" href="https://github.com/annaesvensson/yellow-draft">Erweiterung «Draft</a>
|
|
||||||
- unlisted = Die Seite ist nicht sichtbar, aber mit dem richtigen Link erreichbar
|
MastodonapiTag = Tag für die Blog-Beiträge (Standard: Fediverse).
|
||||||
- **MastodonapiMaxAge** – Alter der Toots in Stunden, die noch importiert werden sollen. `0` = alle verfügbaren Toots.
|
|
||||||
|
MastodonapiFolder = Pfad zum Blog-Ordner (Standard: content/2-blog/).
|
||||||
|
|
||||||
|
MastodonapiMaxAge = Alter der Toots in Stunden, die noch importiert werden sollen. 0 = alle verfügbaren Toots.
|
||||||
|
|
||||||
|
MastodonapiStatus = Seitenstatus, Standardwert ist public
|
||||||
|
|
||||||
|
Die folgenden Status-Werte werden unterstützt:
|
||||||
|
|
||||||
|
public = Seite ist eine normale Seite
|
||||||
|
|
||||||
|
draft = Seite ist nicht sichtbar, Benutzer muss eingeloggt sein, erfordert die <a target="blank_" href="https://github.com/annaesvensson/yellow-draft">Draft-Erweiterung</a>
|
||||||
|
|
||||||
|
unlisted = Seite ist nicht sichtbar, kann aber mit dem richtigen Link aufgerufen werden
|
||||||
|
|
||||||
## Entwickler
|
## Entwickler
|
||||||
|
|
||||||
Simon
|
Simon Rohr
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue