Buscarron bot
made by etke.cc

The Buscarron bot installed by us is powered by buscarron.

• Full documentation
• Source code
• Support

This page shows you how to set up Buscarron using Cinny client app (available as an add-on component).

Overview¶

Buscarron is a Matrix bot developed by etke.cc. It allows HTML forms you add to your website (static or dynamic) to be submitted securely to a Matrix room of your choice. Submission happens via HTTP POST to a URL endpoint that the Buscarron bot exposes.

Buscarron provides a robust and customizable solution for securely handling form submissions within the Matrix ecosystem.

Features¶

Here is a list of Buscarron’s main features:

• Secure Communication

  Buscarron ensures end-to-end encryption, providing a secure channel for data transmission and maintaining user privacy.

• Form Submission Handling

  Receive HTTP POST forms and JSON submissions within Matrix rooms, and then redirect successful and failed submissions to different target pages.

• Spam prevention

  Various spam prevention mechanisms are in place, starting from standard rate limiting and even doing SMTP validation on email fields in the form payload.

• Customizable Matrix messages

  Supporting Go templates to define your own messages format

• Confirmation emails using Postmark

  The bot sends “Thank you!” message automatically ;)

• Prometheus metrics

  The bot exposes a Prometheus-compatible /metrics endpoint, protected with HTTP basic auth and an IP whitelist.

Usage¶

To use the bot, start a chat with @buscarron:your-server.com. You can also add the bot to any existing Matrix room by inviting it to the room (/invite @buscarron:your-server.com).

Make sure to replace your-server.com with your actual “base domain”. Setting your-server.com or example.com does not work on your server!

After the bot joins the room, anyone can call the web form via HTTP POST method.

Here is an example for the contact form:

<form method="POST" action="https://buscarron.your-server.com/contact">
<!--your fields-->
</form>