oitc/json2mqtt

By oitc

•Updated 17 days ago

Get a HTTP json endpoint and send the json payload to a MQTT topic.

Image

Message queues

Internet of things

Developer tools

602

Overview Tags

oitc/json2mqtt repository overview

⁠Quick reference

Maintained by: Michael Oberdorf IT-Consulting⁠

Source code: GitHub⁠

Container image: DockerHub⁠

⁠Supported tags and respective `Dockerfile` links

⁠Summary

The container image is based on Alpine Linux and sends a curl request result with the mosquitto-client⁠ to a MQTT server topic.

This is the generic version of the other tools:

⁠Prerequisites to run the docker container

You need an MQTT server to send the data to it.

⁠Configuration

⁠Container configuration

The container grab the configuration via environment variables.

Environment 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_TLS_enabled`	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
`MQTT_TLS_no_hostname_validation`	If TLS is enabled, skip the hostname validation of the TLS certificate	OPTIONAL	`false`
`MQTT_USER`	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`	The MQTT topic to send the Github statistics to	MANDATORY
`MQTT_RETAIN`	Set the retain flag when publishing the Github statistics to MQTT topic	OPTIONAL	`false`
`ENDPOINT`	The http(s) endpoint from where to get the json	MANDATORY
`ADD_TIMESTAMP`	Add a timestamp field to the 1st level of the json object.	OPTIONAL	`true`
`TIMESTAMP_ATTR`	The timestamp field attribute name to add the timestamp.	OPTIONAL	`timestamp`

⁠Docker compose configuration

services:
  json2mqtt:
    restart: "no"
    user: 3851:3851
    image: oitc/json2mqtt:latest
    environment:
      MQTT_SERVER: test.mosquitto.org
      MQTT_PORT: 1883
      MQTT_TOPIC: com/github/repositories/metrics
      ENDPOINT: https://naas.isalman.dev/no

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

⁠Donate

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

⁠License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Tag summary

Recent tags

Content type

Image

Digest

sha256:3c1e6acf0…

Size

7.5 MB

Last updated

17 days ago

docker pull oitc/json2mqtt