tagoio/relay repository overview

⁠TagoIO MQTT Relay Docker Overview

⁠Quick Reference

• Maintained by:
  TagoIO Team⁠
• Where to get help:
  Github Documentation⁠, TagoIO Community⁠, or GitHub Issues⁠

⁠Supported Tags

• latest
• bookworm
• alpine

⁠What is TagoIO MQTT Relay?

TagoIO MQTT Relay⁠ is a fast, open-source, and scalable solution written in Rust that bridges your MQTT Broker and the TagoIO platform. It allows seamless integration and data flow between your IoT devices and the TagoIO platform.

⁠How to Use This Image

⁠Basic Usage

To run the TagoIO MQTT Relay using Docker, use the following command:

docker run -p 3001:3001 -it --rm --name my-relay tagoio/relay start

NOTE: This will run TagoIO MQTT Relay without any persistent storage. If you plan to run the relay continually, we recommend establishing a way to keep the application data outside of the Docker container.

⁠Environment Variables

TagoIO MQTT Relay accepts several environment variables that can be overridden in your own Dockerfile or Docker Compose file.

• TAGOIO__RELAY__NETWORK_TOKEN: Your TagoIO Network Token
• TAGOIO__RELAY__AUTHORIZATION_TOKEN: Your TagoIO Authorization Token
• TAGOIO__RELAY__TAGOIO_URL: URL for TagoIO API (default: https://api.tago.io)
• TAGOIO__RELAY__DOWNLINK_PORT: Port for incoming messages from TagoIO (default: 3001)
• TAGOIO__RELAY__MQTT__CLIENT_ID: MQTT client ID (default: tagoio-relay)
• TAGOIO__RELAY__MQTT__TLS_ENABLED: Enable TLS for MQTT (default: false)
• TAGOIO__RELAY__MQTT__ADDRESS: MQTT Broker address (default: localhost)
• TAGOIO__RELAY__MQTT__PORT: MQTT Broker port (default: 1883)
• TAGOIO__RELAY__MQTT__SUBSCRIBE: MQTT topics to subscribe to (default: ["/tago/#", "/topic/+"])
• TAGOIO__RELAY__MQTT__USERNAME: MQTT Broker username
• TAGOIO__RELAY__MQTT__PASSWORD: MQTT Broker password
• TAGOIO__RELAY__MQTT__BROKER_TLS_CA: MQTT Broker TLS CA certificate (optional)
• TAGOIO__RELAY__MQTT__BROKER_TLS_CERT: MQTT Broker TLS certificate (optional)
• TAGOIO__RELAY__MQTT__BROKER_TLS_KEY: MQTT Broker TLS key (optional)

⁠Persistent Storage

To keep the application data outside of the Docker container, you can use Docker volumes. For example:

docker run -p 3001:3001 -v /path/to/config:/app/config -it --rm --name my-relay tagoio/relay start

⁠Image Variants

The tagoio/relay images come in multiple variants, each designed for specific use cases.

⁠tagoio/relay:<version>

This is the main image. If you are unsure about what your needs are, you probably want to use this one.

⁠tagoio/relay:bookworm

This image is based on version 11 of Debian⁠, available in the debian official image⁠.

⁠tagoio/relay:alpine

This image is based on Alpine Linux, a security-oriented, lightweight Linux distribution.

⁠License

The TagoIO MQTT Relay is licensed under the Apache License. See the LICENSE⁠ file for more details.

For more detailed instructions and documentation, please visit the GitHub repository⁠. Thank you for using TagoIO MQTT Relay! If you have any questions or need further assistance, feel free to reach out via GitHub Issues⁠ or our community forum⁠. 🚀