luzifer/birthday-notifier
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Notify on upcoming birthdays from a collection of address books in a CardDAV server
5 commits 1 branch 3 tags 55 KiB
Go 97.6%
Dockerfile 2.4%
Find a file
Knut Ahlers 20b0969ca4
prepare release v0.2.0
2024-03-13 11:41:36 +01:00
pkg Add Slack-Compatible webhook notification target 2024-03-13 11:41:15 +01:00
.gitignore Initial version 2024-03-11 13:17:17 +01:00
caldav.go Initial version 2024-03-11 13:17:17 +01:00
Dockerfile Initial version 2024-03-11 13:17:17 +01:00
go.mod Initial version 2024-03-11 13:17:17 +01:00
go.sum Initial version 2024-03-11 13:17:17 +01:00
History.md prepare release v0.2.0 2024-03-13 11:41:36 +01:00
LICENSE Initial version 2024-03-11 13:17:17 +01:00
main.go Add Slack-Compatible webhook notification target 2024-03-13 11:41:15 +01:00
notifier.go Add Slack-Compatible webhook notification target 2024-03-13 11:41:15 +01:00
README.md Add Slack-Compatible webhook notification target 2024-03-13 11:41:15 +01:00

README.md

Luzifer / birthday-notifier

Previously I used an app on my phone to notify me on upcoming birthdays: One day in advance and on the same day. Then that app decided to add a skew of one day and notify me too late…

And that's why there is now a server based solution to notifying my of upcoming birthdays.

Features:

  • Sync contacts using CardDAV
  • Extract birthdays from the contacts
  • Send notifications

Hosted somewhere it's always running and configured properly and birthday notifications are coming in properly.

Usage

# birthday-notifier --help
Usage of birthday-notifier:
      --fetch-interval duration       How often to fetch birthdays from CardDAV (default 1h0m0s)
      --log-level string              Log level (debug, info, warn, error, fatal) (default "info")
      --notify-days-in-advance ints   Send notification X days before birthday (default [1])
      --notify-via strings            How to send the notification (log, pushover, slack) (default [log])
      --version                       Prints current version and exits
      --webdav-base-url string        Webdav server to connect to
      --webdav-pass string            Password for the Webdav user
      --webdav-principal string       Principal format to fetch the addressbooks for (%s will be replaced with the webdav-user) (default "principals/users/%s")
      --webdav-user string            Username for Webdav login

For Nextcloud leave the principal format the default, for other systems you might need to adjust it.

To adjust the notification text see the template in pkg/formatter/formatter.go and provide your own as NOTIFICATION_TEMPLATE environment variable.

Notifier configuration

  • log - Just sends the notification to the console logs, no configuration available
  • pushover - Send notification via Pushover
    • PUSHOVER_API_TOKEN - Token for the App you've created in the Pushover Dashboard
    • PUSHOVER_USER_KEY - Token for the User to send the notification to
    • PUSHOVER_SOUND - (Optional) Specify a sound to use
  • slack - Send notification through Slack(-compatible) webhook
    • SLACK_WEBHOOK - Webhook URL (i.e. https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX or https://discord.com/api/webhooks/00000/XXXXX/slack)
    • SLACK_CHANNEL - (Optional) Specify the channel to send to
    • SLACK_ICON_EMOJI - (Optional) Emoji to use as user icon
    • SLACK_USERNAME - (Optional) Overwrite the hooks username