Skip to content

README.md

Latest commit

 

History

History
35 lines (21 loc) · 1.22 KB

README.md

File metadata and controls

35 lines (21 loc) · 1.22 KB
Raw

Mosquitto MQTT broker

The Flotilla MQTT broker is a Mosquitto broker with TLS and role-based authentication.

For authentication details, testing, and certificate management, see best_practices.md.

Prerequisites

Configuration

The broker expects the private key for its server x509 certificate, used for TLS, in the environment variable TLS_SERVER_KEY. This is a secret and should be treated as such — it is found in our key vault.

Create the configuration by running setup.sh from the repository root, which prompts you for the key. Alternatively, copy the template and fill it in manually:

cp .env.example .env

Docker Compose loads broker/.env by default on startup. See Using the "--env-file" option for more information.

Run

From the repository root:

make broker      # docker compose up broker --build

If the address is already in use, you may have to kill an existing Mosquitto process:

sudo pkill mosquitto