Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.36 KB

README.md

File metadata and controls

48 lines (33 loc) · 1.36 KB

About

This is an addon for qToggleServer.

It provides push notifications for qToggleServer via Pushover.

Install

Install using pip:

pip install qtoggleserver-pushover

Usage

You'll need to register your account on Pushover, if you haven't done it yet. On their home page, you'll see your User Key; copy it and use it in the configuration below. You can add more than one user key, if you plan to send notifications to multiple users.

Then, you'll need a registered Pushover application (you can register one here). Copy the API key and use it in the configuration below:

qtoggleserver.conf:
...
event_handlers = [
    ...
    {
        driver = "qtoggleserver.pushover.PushoverEventHandler"
        user_keys = ["r7zxs1nj20w86bghyub5div8jyzyiw"]
        api_key = "nwn1cmgc9m6sjhrv1o4roebpb31b5i"
        sound = "pushover"  # optional
        ...
    }
    ...
]
...

For further customization, see Template Notifications.

For advanced event filtering, see Filter Event Handlers.

For available Pushover sounds, see Pushover Sounds.