[docs suggestion] Include examples for notifications #416

New Issue

lasimik · 2021-05-07T14:07:48Z

lasimik commented

2021-05-07 14:07:48 +00:00

In the hooks section of the sample config, and in the docs, include a line how to do notifications, both for running borgmatic as a user or as root. e.g.

after_backup:
    # running borgmatic manually
    # - echo "Finished a backup."
    # running borgmatic as user
    # - notify-send --urgency=normal 'Borgmatic' 'Finished backup.'
    # running borgmatic as root, get USER and USER_ID from userdbctl
    # - sudo -u USER DISPLAY=:0 DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/USER_ID/bus notify-send --urgency=normal 'Borgmatic' 'Finished backup.\nEverything is fine.'

Using single quotes so \n will work.
Crude examples, can be improved...

EDITED TO ADD:
The notify-send… only work when root borgmatic is run manually (sudo -i then borgmatic).

If borgmatic is started by systemd, they ~~run into problems with sudo. Ditto storing the date of last backup into a file in /etc/borgmatic.~~ require that in borgmatic.service two capabilities are added: CAP_SETUID and CAP_SETGID.

NOT SURE ABOUT THE SECURITY IMPLICATIONS if capabilites are

CapabilityBoundingSet=CAP_DAC_READ_SEARCH CAP_NET_RAW CAP_SETUID CAP_SETGID

~~EDIT2: A different path (besides repo-specific files?) would be better to allow multiple dates for multiple repos.~~

EDIT3: If borgmatic could evaluate its own {repository}, it would allow to easily store something (such as the datetime of the last successful backup) alongside the local repo files, e.g. in /root/{repository}. Currently this path needs to be set manually inside the config.yaml, because {repository} is not evaluated in a script called from the after_backup hook.

In the hooks section of the sample config, and in the docs, include a line how to do notifications, both for running borgmatic as a user or as root. e.g. ``` after_backup: # running borgmatic manually # - echo "Finished a backup." # running borgmatic as user # - notify-send --urgency=normal 'Borgmatic' 'Finished backup.' # running borgmatic as root, get USER and USER_ID from userdbctl # - sudo -u USER DISPLAY=:0 DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/USER_ID/bus notify-send --urgency=normal 'Borgmatic' 'Finished backup.\nEverything is fine.' ``` Using single quotes so `\n` will work. Crude examples, can be improved... EDITED TO ADD: The `notify-send…` only work when root borgmatic is run *manually* (`sudo -i` then `borgmatic`). If borgmatic is started by systemd, they ~~run into problems with `sudo`. Ditto storing the date of last backup into a file in `/etc/borgmatic`.~~ require that in `borgmatic.service` two capabilities are added: `CAP_SETUID` and `CAP_SETGID`. NOT SURE ABOUT THE SECURITY IMPLICATIONS if capabilites are ``` CapabilityBoundingSet=CAP_DAC_READ_SEARCH CAP_NET_RAW CAP_SETUID CAP_SETGID ``` ~~EDIT2: A different path (besides repo-specific files?) would be better to allow multiple dates for multiple repos.~~ EDIT3: If borgmatic could evaluate its own `{repository}`, it would allow to easily store something (such as the datetime of the last successful backup) alongside the local repo files, e.g. in `/root/{repository}`. Currently this path needs to be set manually inside the `config.yaml`, because {repository} is not evaluated in a script called from the `after_backup` hook.

lasimik commented

2021-06-11 09:19:46 +00:00

A workaround is here.

A workaround is [here](https://projects.torsion.org/lasimik/borgmatic_notifications/src/branch/master/Readme.md).

witten commented

2022-05-23 22:37:56 +00:00

Sorry again for the delay here. My take is that such an example is outside the scope of the borgmatic docs, given how different notifications would have to be for different Linux systems. I know that notify-send in particular can be pretty finnicky. But it looks like you've done a fair amount of work documenting how to get it working on your system, which is great!

And as mentioned in #420, the {respository} variable in action hook commands now works.

Sorry again for the delay here. My take is that such an example is outside the scope of the borgmatic docs, given how different notifications would have to be for different Linux systems. I know that `notify-send` in particular can be pretty finnicky. But it looks like you've done a fair amount of work documenting how to get it working on your system, which is great! And as mentioned in #420, the `{respository}` variable in action hook commands now works.

witten closed this issue

2022-05-23 22:37:56 +00:00

Sign in to join this conversation.