borgmatic

Pushover

πŸ”

New in version 1.9.2 Pushover makes it easy to get real-time notifications on your Android, iPhone, iPad, and Desktop (Android Wear and Apple Watch, too!).

First, create a Pushover account and login on your mobile device. Create an Application in your Pushover dashboard.

Then, configure borgmatic with your user's unique "User Key" found in your Pushover dashboard and the unique "API Token" from the created Application.

Here's a basic example:

pushover:
    token: 7ms6TXHpTokTou2P6x4SodDeentHRa
    user: hwRwoWsXMBWwgrSecfa9EfPey55WSN

With this configuration, borgmatic creates a Pushover event for your service whenever borgmatic fails, but only when any of the create, prune, compact, or check actions are run. Note that borgmatic does not contact Pushover when a backup starts or when it ends without error by default.

You can configure Pushover to have custom parameters declared for borgmatic's start, fail and finish hooks states.

Here's a more advanced example:

pushover:
    token: 7ms6TXHpTokTou2P6x4SodDeentHRa
    user: hwRwoWsXMBWwgrSecfa9EfPey55WSN
    start:
        message: "Backup <b>Started</b>"
        priority: -2
        title: "Backup Started"
        html: True
        ttl: 10  # Message will be deleted after 10 seconds.
    fail:
        message: "Backup <font color='#ff6961'>Failed</font>"
        priority: 2  # Requests acknowledgement for messages.
        expire: 600  # Used only for priority 2. Default is 600 seconds.
        retry: 30  # Used only for priority 2. Default is 30 seconds.
        device: "pixel8"

Full configuration

pushover:
    # Your application's API token. Supports the "{credential
    # ...}" syntax.
    token: 7ms6TXHpTokTou2P6x4SodDeentHRa

    # Your user/group key (or that of your target user), viewable
    # when logged into your dashboard: often referred to as
    # USER_KEY in Pushover documentation and code examples.
    # Supports the "{credential ...}" syntax.
    user: hwRwoWsXMBWwgrSecfa9EfPey55WSN

    start:
        # Message to be sent to the user or group. If omitted
        # the default is the name of the state.
        message: A backup job has started.

        # A value of -2, -1, 0 (default), 1 or 2 that 
        # indicates the message priority.
        priority: 0

        # How many seconds your notification will continue 
        # to be retried (every retry seconds). Defaults to
        # 600. This settings only applies to priority 2
        # notifications.
        expire: 600

        # The retry parameter specifies how often 
        # (in seconds) the Pushover servers will send the 
        # same notification to the user. Defaults to 30. This
        # settings only applies to priority 2 notifications.
        retry: 30

        # The name of one of your devices to send just to 
        # that device instead of all devices.
        device: pixel8

        # Set to True to enable HTML parsing of the message.
        # Set to false for plain text.
        html: true

        # The name of a supported sound to override your 
        # default sound choice. All options can be found 
        # here: https://pushover.net/api#sounds
        sound: bike

        # Your message's title, otherwise your app's name is 
        # used.
        title: A backup job has started.

        # The number of seconds that the message will live, 
        # before being deleted automatically. The ttl 
        # parameter is ignored for messages with a priority.
        # value of 2.
        ttl: 3600

        # A supplementary URL to show with your message.
        url: https://pushover.net/apps/xxxxx-borgbackup

        # A title for the URL specified as the url parameter,
        # otherwise just the URL is shown.
        url_title: Pushover Link

    finish:
        # Message to be sent to the user or group. If omitted
        # the default is the name of the state.
        message: A backup job has finished.

        # A value of -2, -1, 0 (default), 1 or 2 that 
        # indicates the message priority.
        priority: 0

        # How many seconds your notification will continue 
        # to be retried (every retry seconds). Defaults to
        # 600. This settings only applies to priority 2
        # notifications.
        expire: 600

        # The retry parameter specifies how often 
        # (in seconds) the Pushover servers will send the 
        # same notification to the user. Defaults to 30. This
        # settings only applies to priority 2 notifications.
        retry: 30

        # The name of one of your devices to send just to 
        # that device instead of all devices.
        device: pixel8

        # Set to True to enable HTML parsing of the message.
        # Set to false for plain text.
        html: true

        # The name of a supported sound to override your 
        # default sound choice. All options can be found 
        # here: https://pushover.net/api#sounds
        sound: bike

        # Your message's title, otherwise your app's name is 
        # used.
        title: A backup job has started.

        # The number of seconds that the message will live, 
        # before being deleted automatically. The ttl 
        # parameter is ignored for messages with a priority.
        # value of 2.
        ttl: 3600

        # A supplementary URL to show with your message.
        url: https://pushover.net/apps/xxxxx-borgbackup

        # A title for the URL specified as the url parameter,
        # otherwise just the URL is shown.
        url_title: Pushover Link

    fail:
        # Message to be sent to the user or group. If omitted
        # the default is the name of the state.
        message: A backup job has failed.

        # A value of -2, -1, 0 (default), 1 or 2 that 
        # indicates the message priority.
        priority: 0

        # How many seconds your notification will continue 
        # to be retried (every retry seconds). Defaults to
        # 600. This settings only applies to priority 2
        # notifications.
        expire: 600

        # The retry parameter specifies how often 
        # (in seconds) the Pushover servers will send the 
        # same notification to the user. Defaults to 30. This
        # settings only applies to priority 2 notifications.
        retry: 30

        # The name of one of your devices to send just to 
        # that device instead of all devices.
        device: pixel8

        # Set to True to enable HTML parsing of the message.
        # Set to false for plain text.
        html: true

        # The name of a supported sound to override your 
        # default sound choice. All options can be found 
        # here: https://pushover.net/api#sounds
        sound: bike

        # Your message's title, otherwise your app's name is 
        # used.
        title: A backup job has started.

        # The number of seconds that the message will live, 
        # before being deleted automatically. The ttl 
        # parameter is ignored for messages with a priority.
        # value of 2.
        ttl: 3600

        # A supplementary URL to show with your message.
        url: https://pushover.net/apps/xxxxx-borgbackup

        # A title for the URL specified as the url parameter,
        # otherwise just the URL is shown.
        url_title: Pushover Link

    # List of one or more monitoring states to ping for: "start",
    # "finish", and/or "fail". Defaults to pinging for failure
    # only.
    states:
        - start
        - finish

Improve this documentation

Have an idea on how to make this documentation even better? Use our issue tracker to send your feedback!