 |
Resumo | Integre o sistema de doações/motim do Ko-fi com o Discourse. Recompense doações com distintivos ou associação a grupos. |
 |
Link do Repositório | https://github.com/magicball-network/discourse-kofi.git |
 |
Guia de Instalação | Como instalar plugins no Discourse |
Recursos
Este plugin permite vincular sua conta Ko-fi à sua comunidade no Discourse. As pessoas podem doar dinheiro via Ko-fi, o que, por sua vez, pode conceder recompensas como distintivos ou associação a grupos. Também é possível vincular níveis de assinatura do Ko-fi a associações de grupos.
Este plugin depende do webhook do Ko-fi, que enviará uma notificação ao Discourse quando um pagamento for recebido.
Você pode configurar dois tipos de recompensas:
- Recompensas únicas, como distintivos e associações a grupos. Essas recompensas são baseadas no valor total pago pelas pessoas.
- Associações mensais a grupos baseadas em níveis de assinatura. As pessoas permanecem membros do grupo enquanto continuarem pagando por aquele nível de assinatura. A associação ao grupo é reavaliada após um mês.
Além dessas recompensas, você também pode exibir um painel baseado nos pagamentos recebidos recentemente.
As diferentes seções do painel podem ser habilitadas e configuradas conforme sua preferência.
Você pode importar a exportação CSV do Ko-fi para registrar pagamentos que foram feitos antes de instalar este plugin.
Quando os pagamentos são recebidos, o plugin os associa aos usuários com base no endereço de e-mail usado no pagamento do Ko-fi e no endereço de e-mail do Discourse. Se esses endereços não forem iguais, um usuário pode reivindicar pagamentos feitos por meio da página especial do Ko-fi nas preferências do usuário. Também permite que o usuário oculte sua transação da exibição pública.
Configuração
Você precisa ter uma conta Ko-fi funcional. Após instalar o plugin da maneira habitual, você deve configurar o token do webhook do Ko-fi nas configurações do plugin e configurar a URL do webhook para sua instalação do Discourse: https://example.org/ko-fi/webhook
Se você fez isso, pode enviar uma mensagem de teste do Ko-fi e verificar na página de status do plugin se tudo está correto.
Talvez você queira configurar as recompensas antes de habilitar o webhook ou importar um CSV. Caso contrário, será necessário reprocessar as recompensas para que elas sejam aplicadas aos pagamentos atuais.
Configurações
Inclua uma tabela de configurações e descrições de configurações
| Nome | Descrição |
|---|---|
kofi_webhook_token |
O token de verificação do webhook. Você pode encontrá-lo em sua conta Ko-fi. |
kofi_account |
Seu nome de conta Ko-fi. Isso será usado na descrição do painel e no widget do Ko-fi, se você os habilitar. |
kofi_dashboard_enabled |
Habilita o painel de doações no Discourse em https://example.org/ko-fi |
kofi_dashboard_in_menu |
Define se um item de menu “Doações” para o painel deve ser adicionado ao menu. Se você quiser personalizar este item de menu, deve desabilitar esta opção. |
kofi_dashboard_topic_id |
O ID do tópico que contém a descrição no painel. Um tópico com uma mensagem padrão é criado na categoria “staff” quando o plugin é habilitado. |
kofi_dashboard_widget_enabled |
Habilita o widget de doações do Ko-fi no painel. Isso requer que kofi_account esteja configurado. |
kofi_dashboard_count |
Se maior que 0, deve exibir esse número de pagamentos recentes. |
kofi_dashboard_types |
Os tipos de pagamento do Ko-fi a incluir nos pagamentos recentes. |
kofi_dashboard_anonymous_view |
Detalhes do pagamento a mostrar no painel para visitantes que não estão autenticados. |
kofi_dashboard_authenticated_view |
Detalhes a mostrar quando membros autenticados acessam o painel. |
kofi_goal_amount |
Se maior que 0, habilita o widget “meta” no painel. Isso pode ser usado para mostrar o progresso em direção a um valor alvo definido. |
kofi_goal_period |
Período sobre o qual calcular a meta. |
kofi_goal_since |
Se você selecionar o período “desde”, este será o timestamp a partir do qual calcular o progresso da meta. |
kofi_goal_show_amount |
Se habilitado, também mostra o valor alvo no widget da meta. Caso contrário, você terá apenas uma porcentagem. |
kofi_goal_types |
Tipos de pagamento do Discourse que são contados para a meta. |
kofi_goal_progress_bar_integration |
Isso habilita a integração com o Componente de Tema Barra de Progresso. Quando o progresso da meta é calculado, ele atualiza as configurações de valor atual e máximo deste componente. |
kofi_leaderboard_count |
Se maior que 0, mostra um widget de ranking no painel. |
kofi_leaderboard_days |
Calcula o ranking com base nos pagamentos dos últimos dias. |
kofi_leaderboard_types |
Tipos de pagamento do Ko-fi usados para o cálculo do ranking. |
Configuração de Recompensas
Além dessas configurações, há uma aba Recompensas nas configurações do plugin Ko-fi onde você configura as recompensas únicas e por assinatura.
Para recompensas por assinatura, você deve inserir o nome do nível que configurou no Ko-fi. Se você alterar os nomes dos níveis no Ko-fi, também precisará atualizá-los lá, pois o Ko-fi enviará apenas o nome de exibição, e não algum tipo de ID exclusivo.
Ao criar ou alterar recompensas, você pode solicitar que os pagamentos sejam reprocessados para que essas recompensas sejam concedidas aos pagamentos existentes.
Administração
Além das abas de configurações, status e recompensas, também há as seguintes abas na página de administração do plugin Ko-fi:
- Pagamentos – lista de pagamentos do Ko-fi recebidos.
- Contas – o vínculo entre pagamentos do Ko-fi e usuários.
- Importar – importar uma exportação CSV de pagamentos do Ko-fi. Use isso para importar pagamentos já recebidos.
- Anonimizar – permite anonimizar completamente os pagamentos feitos por um determinado endereço de e-mail.
