 |
Zusammenfassung | Integrieren Sie das Spenden-/Trinkgeldsystem von Ko-fi mit Discourse. Belohnen Sie Spenden mit Abzeichen oder Gruppenmitgliedschaften. |
 |
Repository-Link | https://github.com/magicball-network/discourse-kofi.git |
 |
Installationsanleitung | So installieren Sie Plugins in Discourse |
Funktionen
Dieses Plugin ermöglicht es Ihnen, Ihr Ko-fi-Konto mit Ihrer Discourse-Community zu verknüpfen. Nutzer können über Ko-fi Geld spenden, was im Gegenzug Belohnungen wie Abzeichen oder Gruppenmitgliedschaften gewähren kann. Es ermöglicht auch die Verknüpfung von Ko-fi-Abonnementstufen mit Gruppenmitgliedschaften.
Dieses Plugin ist auf den Ko-fi-Webhook angewiesen, der eine Benachrichtigung an Discourse sendet, wenn eine Zahlung eingegangen ist.
Sie können zwei Arten von Belohnungen konfigurieren:
- Einmalige Belohnungen wie Abzeichen und Gruppenmitgliedschaften. Diese Belohnungen basieren auf dem Gesamtbetrag, den Personen gezahlt haben.
- Monatliche Gruppenmitgliedschaften basierend auf Abonnementstufen. Personen bleiben Mitglied der Gruppe, solange sie für diese Abonnementstufe zahlen. Die Gruppenmitgliedschaft wird nach einem Monat erneut überprüft.
Neben diesen Belohnungen können Sie auch ein Dashboard basierend auf kürzlich eingegangenen Zahlungen anzeigen.
Die verschiedenen Dashboard-Bereiche können nach Ihren Wünschen aktiviert und konfiguriert werden.
Sie können den CSV-Export von Ko-fi importieren, um Zahlungen zu registrieren, die vor der Installation dieses Plugins getätigt wurden.
Wenn Zahlungen eingehen, ordnet das Plugin diese anhand der E-Mail-Adresse, die bei der Ko-fi-Zahlung verwendet wurde, und der Discourse-E-Mail-Adresse des Nutzers zu. Wenn diese Adressen nicht identisch sind, kann ein Nutzer getätigte Zahlungen über die spezielle Ko-fi-Seite in den Benutzereinstellungen beanspruchen. Dies ermöglicht es dem Nutzer auch, seine Transaktion von der öffentlichen Anzeige auszublenden.
Konfiguration
Sie benötigen ein funktionierendes Ko-fi-Konto. Nach der üblichen Installation des Plugins müssen Sie das Ko-fi-Webhook-Token in den Plugin-Einstellungen konfigurieren und die Webhook-URL auf Ihre Discourse-Installation einstellen: https://example.org/ko-fi/webhook
Wenn Sie dies getan haben, können Sie eine Testnachricht von Ko-fi senden und auf der Statusseite des Plugins überprüfen, ob alles in Ordnung ist.
Es könnte ratsam sein, Belohnungen zu konfigurieren, bevor Sie den Webhook aktivieren oder eine CSV-Datei importieren. Andernfalls müssten Sie die Belohnungen erneut verarbeiten, damit sie auf die vorhandenen Zahlungen angewendet werden.
Einstellungen
Hier ist eine Tabelle mit den Einstellungen und deren Beschreibungen:
| Name | Beschreibung |
|---|---|
kofi_webhook_token |
Das Webhook-Verifikationstoken. Sie finden dies in Ihrem Ko-fi-Konto. |
kofi_account |
Ihr Ko-fi-Kontoname. Dies wird in der Dashboard-Beschreibung und im Ko-fi-Widget verwendet, falls diese aktiviert sind. |
kofi_dashboard_enabled |
Aktiviert das Spenden-Dashboard in Discourse unter https://example.org/ko-fi. |
kofi_dashboard_in_menu |
Legt fest, ob ein Menüpunkt “Spenden” zum Dashboard zum Menü hinzugefügt werden soll. Wenn Sie diesen Menüpunkt anpassen möchten, sollten Sie diese Option deaktivieren. |
kofi_dashboard_topic_id |
Die Topic-ID, die die Beschreibung auf dem Dashboard enthält. Beim Aktivieren des Plugins wird ein Topic mit einer Standardnachricht in der Kategorie “Mitarbeiter” erstellt. |
kofi_dashboard_widget_enabled |
Aktiviert das Ko-fi-Spenden-Widget auf dem Dashboard. Dies erfordert, dass kofi_account konfiguriert ist. |
kofi_dashboard_count |
Wenn größer als 0, soll diese Anzahl der neuesten Zahlungen angezeigt werden. |
kofi_dashboard_types |
Die Ko-fi-Zahlungstypen, die in den neuesten Zahlungen enthalten sein sollen. |
kofi_dashboard_anonymous_view |
Zahlungsdaten, die auf dem Dashboard für Besucher angezeigt werden, die nicht authentifiziert sind. |
kofi_dashboard_authenticated_view |
Details, die angezeigt werden, wenn authentifizierte Mitglieder das Dashboard aufrufen. |
kofi_goal_amount |
Wenn größer als 0, aktiviert das “Ziel”-Widget auf dem Dashboard. Dies kann verwendet werden, um den Fortschritt bis zu einem bestimmten Zielbetrag anzuzeigen. |
kofi_goal_period |
Zeitraum, über den das Ziel berechnet wird. |
kofi_goal_since |
Wenn Sie den Zeitraum “seit” auswählen, ist dies der Zeitstempel, ab dem der Ziel-Fortschritt berechnet wird. |
kofi_goal_show_amount |
Wenn aktiviert, wird auch der Zielbetrag im Ziel-Widget angezeigt. Andernfalls wird nur ein Prozentsatz angezeigt. |
kofi_goal_types |
Discourse-Zahlungstypen, die für die Zielberechnung gezählt werden. |
kofi_goal_progress_bar_integration |
Dies aktiviert die Integration mit der Progress Bar Theme Component. Wenn der Ziel-Fortschritt berechnet wird, werden die aktuellen und maximalen Werteinstellungen dieser Komponente aktualisiert. |
kofi_leaderboard_count |
Wenn größer als 0, wird ein Leaderboard-Widget auf dem Dashboard angezeigt. |
kofi_leaderboard_days |
Berechnet das Leaderboard basierend auf Zahlungen der letzten Tage. |
kofi_leaderboard_types |
Ko-fi-Zahlungstypen, die für die Leaderboard-Berechnung verwendet werden. |
Belohnungskonfiguration
Neben diesen Einstellungen gibt es im Ko-fi-Plugin unter “Einstellungen” einen Reiter Belohnungen, in dem Sie die einmaligen und Abonnement-Belohnungen konfigurieren.
Für Abonnement-Belohnungen müssen Sie den auf Ko-fi konfigurierten Stufennamen eingeben. Wenn Sie die Stufennamen auf Ko-fi ändern, müssen Sie diese dort ebenfalls aktualisieren, da Ko-fi nur den Anzeigenamen und keine eindeutige ID sendet.
Beim Erstellen oder Ändern von Belohnungen können Sie anfordern, dass Zahlungen erneut verarbeitet werden, damit diese Belohnungen auch auf bestehende Zahlungen angewendet werden.
Verwaltung
Neben den Reitern Einstellungen, Status und Belohnungen gibt es auf der Admin-Seite des Ko-fi-Plugins folgende weitere Reiter:
- Zahlungen – Liste der eingegangenen Ko-fi-Zahlungen.
- Konten – Die Verknüpfung zwischen Ko-fi-Zahlungen und Nutzern.
- Import – Importieren Sie einen CSV-Export von Ko-fi-Zahlungen. Verwenden Sie dies, um bereits eingegangene Zahlungen zu importieren.
- Anonymisieren – Ermöglicht es Ihnen, Zahlungen, die von einer bestimmten E-Mail-Adresse getätigt wurden, vollständig zu anonymisieren.
