gsalomao / maxmq Goto Github PK

Description

The broker must allow clients to publish QoS 1 messages when it receives an MQTT PUBLISH packet.

Description

The project must allow anyone to install the broker on a Kubernetes cluster using Helm Chart.

Description

The broker must keep the clients connected, this means that it must respond with PINGRESP when the client sends the PINGREQ packet, based on the MQTT specification.
When the client does not send the PINGREQ within the Keep Alive window, the broker must disconnect the client.

Description

The broker must create subscriptions when it receives MQTT SUBSCRIBE packets. The subscriptions created must be associated with the session of the client who sent the SUBSCRIBE packet.

Description

Allow clients to connect to the broker using the MQTT protocol.
The broker must conform with the standard versions 3.1, 3.1.1, or 5.0.

Description

Allow the administrator to override the configurations defined in the maxmq.conf using environment variables.

Description

The broker must export Prometheus metrics to monitor its operation.

Description

The broker must be started and stopped by the command line.

The command line must have at least the following commands:

• --help to show the available commands
• --version to show the application version
• start to start the broker

The broker must stop on SIGINT signal.

Description

The project must allow anyone generates a Docker image with everything needed to start the broker.

Description

The application must load its configuration from the maxmq.conf file on startup. The file can be stored at the following locations with the following order:

• Same location of the binary
• In the path above the binary
• /etc/maxmq
• /etc

Description

The generated logs shall be outputted to the console using colours to improve the readability.

Description

Allow logging using different formats and destinations.

The allowed formats are:

• pretty where the output is in text with colours
• text where the output is in plain text (no colours)
• json where the output is in JSON format

The allowed destinations are:

• console where the output goes to the console
• file where the output goes to a file

The format and destination shall be chosen by configuration (maxmq.conf or environment variables).

Description

The broker must allow clients to publish QoS 0 messages when it receives an MQTT PUBLISH packet.

Description

The broker must disconnect the clients when it receives the MQTT DISCONNECT packet.

Description

The broker must remove the subscription when it receives MQTT UNSUBSCRIBE packets. The subscription associated with the session must be removed.

The broker must allow clients to publish QoS 2 messages when it receives an MQTT PUBLISH packet.