gotify-broadcast
A plugin which brings broadcasts to gotify.
Screenshot
Installation
If you found your gotify version is included in the build, you can download the shared object and put that into your plugin dir.
If you did not find you gotify version, follow these steps to build one for your own:
- Download a zip file of the source code of current release at the releases page and extract it.
export GO111MODULE=onif you are in GOPATHmake download-toolsmake GOTIFY_VERSION=v1.2.1 buildto build the plugin for your gotify version (GOTIFY_VERSIONcould be a tag, a branch or a commit).
Configuration
The configuration contains three keys: channels, sender_filter, and receiver_filter.
Channels
The channels key in the configuration describes which channels you are using. Each channen has two parameters: name and public.
The name parameter is used to identify the channel. It must be unique and is required while sending broadcasts.
The public parameter specifies whether this channel will be visible to other users in the Displayer panel in their WebUI. If this is set to false, they will not be able to see this channel on the WebUI, but they can still recieve messages from this broadcast. Thus, it is recommended to set a receiver filter which defaults to Reject on private channels.
channels:
- name: example_public_channel
public: true
- name: example_private_channel
public: falseFilters
In order to control from which and to which a broadcast is sent, a filter system is integrated into this plugin.
The Matching Routine
Messages are filtered with a iptables-like filter system. The filter is a chain of Rules, which contains a match describing how this rule matches messages, and a action describing the action to take when this rule matches successfully.
receiver_filter:
- match:
- mode: <mode>
<param>: <param>
- mode: <mode>
<param>: <param>
action: <action>
- match:
- mode: <mode>
<param>: <param>
- mode: <mode>
<param>: <param>
action: <action>
- match:
- mode: <mode>
<param>: <param>
- mode: <mode>
<param>: <param>
action: <action>
sender_filter:
- match:
- mode: <mode>
<param>: <param>
- mode: <mode>
<param>: <param>
action: <action>
- match:
- mode: <mode>
<param>: <param>
- mode: <mode>
<param>: <param>
action: <action>
- match:
- mode: <mode>
<param>: <param>
- mode: <mode>
<param>: <param>
action: <action>All modes and its parameter requirements is documented here
On the sender side
When a broadcast is created, the receiver_filter will be applied to each recipient. Similar to the OUTPUT chain in iptables, when the filter evaluates to Accept, the message is sent to that recipient (but whether the message is actually received also depends on the configuration of the sender_filter filter on the recipient side)
+--------------------------------------------------------+
| Outgoing Message |
| |
+---------------------------+----------------------------+
|
|
+--------------------------------------------+
|
|
|
| +----------------+ +-----------------+ +-----------------+
| | | | | | |
| | +----------+ | | +-----------+ | | +-----------+ | +-----------------+
| | | | | N | | | | N | | | | N | |
+--------------> Match +-------------> Match +-------------> Match +--------------> Default: Accept |
| | | | | | | | | | | | | |
| +----+-----+ | | +-----+-----+ | | +-----+-----+ | +-----------------+
| | | | | | | | |
| |Y | | | | | | |
| | | | | | | | |
| +----v-----+ | | | | | | |
| | | | | | | | | |
| | Match | | | | | | | |
| | | | | | | | | |
| +----+-----+ | | | | | | |
| | | | |Y | | |Y |
| | | | | | | | |
| | | | | | | | |
| | | | | | | | |
| |Y | | | | | | |
| | | | | | | | |
| | | | | | | | |
| | | | | | | | |
| | | | | | | | |
| +----v-----+ | | +-----v-----+ | | +-----v-----+ |
| | Accept | | | | Reject | | | | Reject | |
| | | | | | | | | | | |
| +----------+ | | +-----------+ | | +-----------+ |
| | | | | |
+----------------+ +-----------------+ +-----------------+
receiver_filter[0] receiver_filter[1] receiver_filter[2]Examples
Only sends broadcast from a channel to admin:
channels:
- name: secret
public: false
receiver_filter:
- match:
- mode: channel_name
channel_name: secret
- mode: is_admin
is_admin: false
action: rejectDon't send broadcast with priority less than a specified value to some user:
receiver_filter:
- match:
- mode: user_name
user_name: someone_who_does_not_want_to_be_bothered
- mode: priority_lt
priority: 5
action: rejectDon't send broadcast except to tom and jerry:
receiver_filter:
- match:
- mode: user_name
user_name: tom
action: accept
- match:
- mode: user_name
user_name: jerry
action: accept
- match:
- mode: any
action: rejectMute broadcasts sent by myself:
receiver_filter:
- match:
- mode: user_name
user_name: <my_user_name>
action: rejectOn the receiver side
When a broadcast is received, the sender_filter will be applied, similar to the INPUT chain in iptables. When this also evaluates to Accept, the message is eventually delivered.
+--------------------------------------------------------+
| Incoming Message |
| |
+---------------------------+----------------------------+
|
|
+--------------------------------------------+
|
|
|
| +----------------+ +-----------------+ +-----------------+
| | | | | | |
| | +----------+ | | +-----------+ | | +-----------+ | +-----------------+
| | | | | N | | | | N | | | | N | |
+--------------> Match +-------------> Match +-------------> Match +--------------> Default: Accept |
| | | | | | | | | | | | | |
| +----+-----+ | | +-----+-----+ | | +-----+-----+ | +-----------------+
| | | | | | | | |
| |Y | | | | | | |
| | | | | | | | |
| +----v-----+ | | | | | | |
| | | | | | | | | |
| | Match | | | | | | | |
| | | | | | | | | |
| +----+-----+ | | | | | | |
| | | | |Y | | |Y |
| | | | | | | | |
| | | | | | | | |
| | | | | | | | |
| |Y | | | | | | |
| | | | | | | | |
| | | | | | | | |
| | | | | | | | |
| | | | | | | | |
| +----v-----+ | | +-----v-----+ | | +-----v-----+ |
| | Accept | | | | Reject | | | | Reject | |
| | | | | | | | | | | |
| +----------+ | | +-----------+ | | +-----------+ |
| | | | | |
+----------------+ +-----------------+ +-----------------+
sender_filter[0] sender_filter[1] sender_filter[2]Examples
Reject messages which matches a regexp from my_server:
sender_filter:
- match:
- mode: user_name
user_name: my_server
- mode: message_text
regex: true
message_text: ^\[(INFO|DEBUG)\]
action: rejectReject messages from non-admins but my_friend:
sender_filter:
- match:
- mode: user_name
user_name: my_friend
action: accept
- match:
- mode: is_admin
is_admin: false
action: rejectReject all received broadcasts:
sender_filter:
- match:
- mode: any
action: rejectSending messages
-
Go to the WebUI, configure channels and filters.
-
On the
Displayerpanel, you could see the message hook URL. -
POST your message to that hook URL just like how to push regular messages with an extra query parameter
channel=<channel_name>