oitc/acs.pushover-bridge-service

By oitc

•Updated 7 months ago

OITC Access Control System: service to send access notifications via pushover.

Image

Security

Message queues

1.8K

Overview Tags

oitc/acs.pushover-bridge-service repository overview

⁠OITC Access Control System: Pushover bridge service

⁠Quick reference

Maintained by: Michael Oberdorf IT-Consulting⁠

Source code: GitHub⁠

Container image: DockerHub⁠

Access Control System documentation: ACS Documentation⁠

⁠Supported tags and respective `Dockerfile` links

latest, 1.0.0⁠

⁠Description

This service is part of the Michael Oberdorf IT-Consulting (OITC) Access Control System (ACS).

On accessing entry points, this information is available in the internal bus system. This service listens on these events and send them via Pushover⁠.

This service is NO standalone service. It requires an OITC ACS system to be running.

⁠Configuration

⁠Container configuration

The container get's the configuration from environment variables.

Variable name	Description	Required	Default value
`MQTT_SERVER`	The MQTT server hostname or IP address.	OPTIONAL	`localhost`
`MQTT_PORT`	The TCP port of the MQTT server.	OPTIONAL	`1883`
`MQTT_PROTOCOL_VERSION`	The MQTT protocol version to use. Currently supported `3` (means 3.1.1) and `5`.	OPTIONAL	`3`
`MQTT_TLS`	Should SSL communication be enabled (`true`) or not (`false`).	OPTIONAL	`false`
`MQTT_CACERT_FILE`	If TLS is enabled, the path to the CA certificate file to validate the MQTT server certificate.	OPTIONAL	`/etc/ssl/certs/ca-certificates.crt`
`MQTT_TLS_INSECURE`	If TLS is enabled, skip the hostname validation of the TLS certificate.	OPTIONAL	`false`
`MQTT_CLIENT_ID`	The MQTT client id to use for the MQTT connection.	OPTIONAL
`MQTT_USERNAME`	The MQTT username for MQTT authentication.	OPTIONAL
`MQTT_PASSWORD`	The MQTT password for MQTT authentication.	OPTIONAL
`MQTT_PASSWORD_FILE`	The filepath where the MQTT password is stored for MQTT authentication.	OPTIONAL
`MQTT_TOPIC_ACS_STATUS`	The MQTT topic to subscribe that contains the status messages of the ACS.	MANDATORY
`MQTT_TOPIC_DOOR_ACCESS`	The MQTT topic to subscribe that contains the door access information.	MANDATORY
`PUSHOVER_APP_TOKEN`	The application key of the pushover ACS application.	OPTIONAL
`PUSHOVER_APP_TOKEN_FILE`	The filepath of a file that contains the application key of the pushover ACS application.	MANDATORY
`PUSHOVER_USER_KEY`	The user key of the pushover account.	OPTIONAL
`PUSHOVER_USER_KEY_FILE`	The filepath of a file that contains the user key of the pushover account.	MANDATORY
`PROMETHEUS_LISTENER_ADDR`	The listener address to expose the prometheus exporter.	OPTIONAL	`0.0.0.0`
`PROMETHEUS_LISTENER_PORT`	The TCP listener port to expose the prometheus exporter.	OPTIONAL	`8080`
`TZ`	Timezone	OPTIONAL	`UTC`

HINT:

MQTT_PASSWORD_FILE will be priorized before MQTT_PASSWORD
PUSHOVER_APP_TOKEN_FILE will be priorized before PUSHOVER_APP_TOKEN, at least one of both needs to be defined
PUSHOVER_USER_KEY_FILE will be priorized before PUSHOVER_USER_KEY, at least one of both needs to be defined

⁠Docker compose configuration

services:
  pushover-bridge-service:
    restart: always
    user: 2100:2100
    image: oitc/acs.pushover-bridge-service:latest
    environment:
      MQTT_SERVER: test.mosquitto.org
      MQTT_PORT: 1883
      MQTT_PROTOCOL_VERSION: 3
      MQTT_TOPIC_ACS_STATUS: location/oitc-acs/general/status
      MQTT_TOPIC_DOOR_ACCESS: location/oitc-acs/entrypoints/+/access
      PUSHOVER_APP_TOKEN_FILE: /run/secrets/pushover_app_token
      PUSHOVER_USER_KEY_FILE: /run/secrets/pushover_user_key
    secrets:
      - pushover_app_token
      - pushover_user_key

secrets:
  pushover_app_token:
    file: /srv/docker/acs.pushover-bridge-service/secrets/pushover_app_token
  pushover_user_key:
    file: /srv/docker/acs.pushover-bridge-service/secrets/pushover_user_key

A bigger example can be found here: docker-compose.yaml⁠

⁠MQTT message formats

Please have a look to the main documentation: MQTT message reference⁠

⁠Donate

I would appreciate a small donation to support the further development of my open source projects.

Tag summary

Recent tags

Content type

Image

Digest

sha256:1cd8cd677…

Size

28.5 MB

Last updated

7 months ago

docker pull oitc/acs.pushover-bridge-service