computer-playbook/roles/systemd-notifier-telegram/README.md

41 lines
1.6 KiB
Markdown
Raw Normal View History

2023-05-28 22:17:33 +02:00
## Description
2023-12-03 11:24:17 +01:00
This Ansible role installs the necessary components for sending Telegram notifications through systemd when any service fails. It configures the `systemd-notifier-telegram` service and handles the setup of Telegram bot parameters and notification templates.
2023-05-28 22:17:33 +02:00
Features include:
- Installation and configuration of a Telegram notifier service.
- Customizable templates for Telegram messages sent on service failure.
2023-12-03 11:24:17 +01:00
This role is part of the `systemd-notifier` suite, which provides a comprehensive solution for service failure notifications in a systemd environment.
2023-05-28 22:17:33 +02:00
## Requirements
This role has the following requirements:
- Access to a Telegram bot token for sending messages.
- Availability of the `curl` package on the target system.
## Role Variables
The following variables can be customized in the role's `vars/main.yml` file:
2023-12-03 11:24:17 +01:00
- `systemd_telegram_folder`: The path to the folder where Telegram-related scripts and configurations will be stored.
- `systemd_telegram_script`: The full path to the systemd-telegram.sh script.
2023-05-28 22:17:33 +02:00
This role was created as part of a conversation with OpenAI's ChatGPT and can be found [here](https://chat.openai.com/share/96e4ca12-0888-41c0-9cfc-29c0180f0dba).
## Usage
2023-12-03 11:24:17 +01:00
To use this role, include it as a dependency in your playbook or role that requires Telegram notifications. Ensure that the `systemd-notifier-telegram` role is correctly referenced and configured.
2023-05-28 22:17:33 +02:00
## License
This Ansible role is licensed under the AGPL v3 License. See the LICENSE file for the full license text.
## Contact Information
For any questions or feedback, please contact the author:
Author: Kevin Veen-Birkenbach
Email: kevin@veen.world