This webtrees custom module sends Telegram notifications about significant family events, such as birthdays and anniversaries, based on the data from your webtrees installation.
This Readme contains the following main sections:
Before installing this module on your main site, we recommend testing it on a staging environment. This module interacts with external services (Telegram API) and may require specific configuration of your Telegram bot and permissions.
This custom module for webtrees integrates with Telegram to send notifications about significant family events, including but not limited to birthdays, anniversaries, and other key milestones.
Previously, the module only supported events related to living individuals (e.g., birthdays and marriage anniversaries). Now, it has been updated to support notifications for all events, whether they involve living or deceased individuals. This means you can now receive notifications for important events for all family members.
- All Events: Notifications can be configured for any event types defined in your webtrees installation.
- Telegram Bot Integration: Sends messages using a Telegram bot.
- Event Types: Now supports a wider range of events, including those for deceased individuals.
- Configuration: Set your Telegram Bot Token and chat ID in the module settings.
- User and Tree Preferences: Specify the user and family tree for which you want to send notifications.
Screenshot of settings module
Screenshot of the message in Telegram
This module requires webtrees version 2.2 or later. This module has the same requirements as webtrees system requirements.
This module was tested with webtrees 2.2.1 and later versions.
- Create a Telegram bot using BotFather.
- Obtain your bot's token and chat ID.
To ensure that the notifications are sent regularly (e.g., daily at midnight), you need to set up a cron job on your server. The link for the cron job must be taken from the module settings. This will allow the script to check for events and send the corresponding notifications.
Follow these steps to install the module:
- Download the latest release.
- Unzip the package into your
webtrees/modules_v4directory. - Log in to webtrees as an administrator and go to Control Panel / Modules / Telegram.
- In the settings, enter your Telegram Bot Token and Telegram Chat ID.
- Set the User and Tree from which you want to send the events.
- Enable the module and click Save.
- Set up a cron job on your server to trigger the module at regular intervals (e.g., daily).
To update the module:
- Download and unzip the latest release.
- Replace the existing
telegramfolder in yourmodules_v4directory with the new version. - No further configuration should be needed, but double-check the settings in the module to ensure everything is up to date.
- Issues: Report any bugs or issues by opening an issue on the GitHub repository.
- Forum: General support for webtrees can be found on the webtrees forum.
- Copyright © 2024 Tywed
This module was developed based on the webtrees-reminder module by Kirill Uksusov (UksusoFF).
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.