Pass-It-On

A library that provides a simple notification client and server that receives messages and passes them on to endpoints.

Key Features

• A configurable server that monitors interfaces and passes notifications to endpoints.
• A configurable client to use as part of a binary to send notifications to the server.
• Traits to support extension of Interfaces and their inclusion in the configuration file.
  • Interface
  • InterfaceConfig
• Traits to support extension of Endpoints and their inclusion in the configuration file.
  • Endpoint
  • EndpointConfig

Interfaces

Interfaces can be used for both the server and the client.

Endpoints

Endpoints are the destinations for notifications received by the server.

Configuration

The Server and Client support configuration via a TOML file. At least one interface must be setup for a Client and at least one interface and endpoint must be setup for the Server.

Server Configuration Example

[server]
key = "sdfsf4633ghf44dfhdfhQdhdfhewaasg"

[[server.interface]]
type = "pipe"
path = '/path/to/pipe.fifo'
group_read_permission = true

[[server.interface]]
type = "http"
port = 8080

[[server.endpoint]]
type = "matrix"
home_server = "example.com"
username = "test1"
password = "pass"
session_store_path = '/path/to/session/store/matrix_store'
session_store_password = "storepass123"

[[server.endpoint.room]]
room = "!dfsdfsdf:example.com"
notifications = ["notification_id1", "notification_id2"]

[[server.endpoint.room]]
room = "#matrix-room:example.com"
notifications = ["notification_id4"]

[[server.endpoint]]
type = "file"
path = '/test_data/file_endpoint.txt'
notifications = ["notification_id1", "notification_id3"]

Client Configuration Example

[client]
key = "sdfsf4633ghf44dfhdfhQdhdfhewaasg"

[[client.interface]]
type = "pipe"
path = '/path/to/pipe.fifo'
group_read_permission = true

[[client.interface]]
type = "http"
ip = "192.168.1.2"
port = 8080

Feature Flags