Project Name: Renterd/Hostd Telegram Alert Bot
Name of the organization or individual submitting the proposal: Mert Köklü
Describe your project.
Developing a Telegram bot to forward urgent Renterd and Hostd alerts to the Telegram app of end-user. Utilizing the provided endpoints from the Renterd and Hostd API, the bot will be set up to register a new webhook for alert modules, and subsequently monitor and forward any triggered alerts to the Telegram user. The core of the project will be encapsulated within a Docker container that can be easily deployed by end-users in their own environment, ensuring a seamless setup and execution with just a single command.
Why Docker, and not a Telegram bot that operates in centralized server for best user experience? I have considered this option, but there is security concerns from end-users and limitations. A centralized setup could expose all received alerts to a single point, which user may not be comfortable with. More importantly, alerts sent through webhooks to a central server, there’s a lack of unique information in the webhook endpoint response in Renterd/Hostd API to identify which Renterd/Hostd instance the alert originated from, making it impossible to alert the user.
How does the projected outcome serve the Foundation’s mission of user-owned data?
By real-time alerting users, this project enhances the user’s ability to respond to urgent alerts in a timely manner, and thus protecting their data.
Amount of money requested and justification with a reasonable breakdown of expenses:
2 months of work for $5000 that covers my time.
What are the goals of this small grant?
Developing a Telegram bot for alerting users of urgent Renterd alerts.
Developing a Telegram bot for alerting users of urgent Hostd alerts.
Ensuring ease of setup and use through Docker encapsulation.
Providing how-to documentation for end-users.
Potential risks that will affect the outcome of the project:
- Unexpected changes or limitations in the Renterd/Hostd API. This can be mitigated by updating the bot to handle the changes.
Other than that, there is no risk of the project since it only forwards the alerts to the user, and does not modify any data.
Will all of your project’s code be open-source?
Yes, the code will be open-source and available on Github with detailed documentation.
Leave a link where code will be accessible for review.
Do you agree to submit monthly progress reports?
Yes, I agree to submit monthly progress reports.
Any other preferred contact methods: