 |
Resumen | Integra el sistema de donaciones/bocetos de Ko-fi con Discourse. Recompensa las donaciones con insignias o membresías en grupos. |
 |
Enlace al repositorio | https://github.com/magicball-network/discourse-kofi.git |
 |
Guía de instalación | Cómo instalar plugins en Discourse |
Características
Este plugin te permite vincular tu cuenta de Ko-fi con tu comunidad de Discourse. Las personas pueden donar dinero a través de Ko-fi, lo que a su vez puede otorgar recompensas como insignias o membresías en grupos. También permite asociar los niveles de suscripción de Ko-fi con membresías en grupos.
Este plugin depende del webhook de Ko-fi, que enviará una notificación a Discourse cuando se reciba un pago.
Puedes configurar dos tipos de recompensas:
- Recompensas únicas, como insignias y membresías en grupos. Estas recompensas se basan en la cantidad total que las personas han pagado.
- Membresías mensuales en grupos basadas en niveles de suscripción. Las personas permanecen miembros del grupo mientras sigan pagando por ese nivel de suscripción. La membresía en el grupo se vuelve a evaluar después de un mes.
Además de estas recompensas, también puedes mostrar un panel de control basado en los pagos recibidos recientemente.
Las diferentes secciones del panel de control se pueden habilitar y configurar según tus preferencias.
Puedes importar la exportación CSV de Ko-fi para registrar los pagos realizados antes de instalar este plugin.
Cuando se reciben pagos, el plugin los vincula con los usuarios basándose en la dirección de correo electrónico que utilizaron para el pago en Ko-fi y su dirección de correo electrónico en Discourse. Si estas direcciones no coinciden, un usuario puede reclamar los pagos realizados a través de la página especial de Ko-fi en las preferencias del usuario. También permite a los usuarios ocultar su transacción de la vista pública.
Configuración
Necesitas tener una cuenta de Ko-fi funcional. Después de instalar el plugin de la manera habitual, debes configurar el token de webhook de Ko-fi en la configuración del plugin y configurar la URL del webhook en tu instalación de Discourse: https://ejemplo.org/ko-fi/webhook
Si has hecho esto, puedes enviar un mensaje de prueba desde Ko-fi y verificar en la página de estado del plugin si todo está correcto.
Es posible que desees configurar las recompensas antes de habilitar el webhook o importar un CSV. De lo contrario, tendrás que reprocesar las recompensas para que se apliquen a los pagos actuales.
Configuraciones
Incluye una tabla de configuraciones y sus descripciones
| Nombre | Descripción |
|---|---|
kofi_webhook_token |
El token de verificación del webhook. Puedes encontrarlo en tu cuenta de Ko-fi. |
kofi_account |
El nombre de tu cuenta de Ko-fi. Se utilizará en la descripción del panel de control y en el widget de Ko-fi si los habilitas. |
kofi_dashboard_enabled |
Habilita el panel de control de donaciones en Discourse en https://ejemplo.org/ko-fi. |
kofi_dashboard_in_menu |
Define si se debe agregar un elemento de menú “Donaciones” al panel de control. Si deseas personalizar este elemento del menú, debes deshabilitar esta opción. |
kofi_dashboard_topic_id |
El ID del tema que contiene la descripción en el panel de control. Se crea un tema con un mensaje predeterminado en la categoría “personal” cuando se habilita el plugin. |
kofi_dashboard_widget_enabled |
Habilita el widget de donaciones de Ko-fi en el panel de control. Esto requiere que kofi_account esté configurado. |
kofi_dashboard_count |
Si es mayor que 0, muestra este número de pagos recientes. |
kofi_dashboard_types |
Los tipos de pago de Ko-fi a incluir en los pagos recientes. |
kofi_dashboard_anonymous_view |
Detalles del pago que se mostrarán en el panel de control para visitantes que no estén autenticados. |
kofi_dashboard_authenticated_view |
Detalles que se mostrarán cuando los miembros autenticados accedan al panel de control. |
kofi_goal_amount |
Si es mayor que 0, habilita el widget “objetivo” en el panel de control. Esto se puede usar para mostrar el progreso hacia una cantidad objetivo dada. |
kofi_goal_period |
Período sobre el cual calcular el objetivo. |
kofi_goal_since |
Si seleccionas el período “desde”, esta será la marca de tiempo desde la cual calcular el progreso del objetivo. |
kofi_goal_show_amount |
Si está habilitado, también muestra la cantidad objetivo en el widget del objetivo. De lo contrario, solo tendrás un porcentaje. |
kofi_goal_types |
Tipos de pago de Discourse que se cuentan hacia el objetivo. |
kofi_goal_progress_bar_integration |
Esto habilita la integración con el Componente de tema Barra de progreso. Cuando se calcula el progreso del objetivo, se actualizarán la configuración de valor actual y máximo de este componente. |
kofi_leaderboard_count |
Si es mayor que 0, muestra un widget de tabla de clasificación en el panel de control. |
kofi_leaderboard_days |
Calcula la tabla de clasificación basándose en los pagos de los últimos días. |
kofi_leaderboard_types |
Tipos de pago de Ko-fi que se utilizan para el cálculo de la tabla de clasificación. |
Configuración de recompensas
Además de estas configuraciones, hay una pestaña Recompensas en la configuración del plugin de Ko-fi donde puedes configurar las recompensas únicas y de suscripción.
Para las recompensas de suscripción, debes ingresar el nombre del nivel que configuraste en Ko-fi. Si alguna vez cambias los nombres de los niveles en Ko-fi, también debes actualizarlos allí, ya que Ko-fi solo enviará el nombre de visualización y no algún tipo de ID único.
Al crear o modificar recompensas, puedes solicitar que los pagos se reprocesen para que estas recompensas se otorguen a los pagos existentes.
Administración
Además de las pestañas de configuración, estado y recompensas, también hay las siguientes pestañas en la página de administración del plugin de Ko-fi:
- Pagos: lista de pagos recibidos de Ko-fi.
- Cuentas: el vínculo entre los pagos de Ko-fi y los usuarios.
- Importar: importa una exportación CSV de pagos de Ko-fi. Utiliza esto para importar pagos ya recibidos.
- Anonimizar: te permite anonimizar completamente los pagos realizados por una dirección de correo electrónico dada.
