amqtt/docs_web/index.md

# Home

![assets/amqtt.svg](assets/amqtt.svg)

`aMQTT` is an open source [MQTT](http://www.mqtt.org) broker and client, natively implemented with Python's [asyncio](https://docs.python.org/3/library/asyncio.html).

## Features

- Full set of [MQTT 3.1.1](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html) protocol specifications
- Communication over TCP and/or websocket, including support for SSL/TLS
- Support QoS 0, QoS 1 and QoS 2 messages flow
- Client auto-reconnection on network lost
- Functionality expansion; plugins included: authentication and `$SYS` topic publishing

## Installation

`amqtt` is available on ![pypi](assets/python.svg) [PyPI](https://pypi.python.org/pypi/amqtt)

## Documentation

`amqtt` docs are available on ![readthedocs](assets/readthedocs.svg) [Read the Docs](http://amqtt.readthedocs.org/).

## Containerization

Launch from ![dockerhub](assets/docker.svg) [DockerHub](https://hub.docker.com/repositories/amqtt)

```shell
$ docker run -d -p 1883:1883 amqtt/amqtt:latest
```

## Testing

The `amqtt` project runs a test aMQTT broker/server at [test.amqtt.io](https://test.amqtt.io) which supports: MQTT, MQTT over TLS, websocket, secure websockets.


## Support

`amqtt` development is available on ![github](assets/github.svg) [GitHub](https://github.com/Yakifo/amqtt). Bug reports, patches and suggestions welcome!

![github](assets/github.svg) [Open an issue](https://github.com/Yakifo/amqtt/issues/new) or join the ![discord](assets/discord.svg) [discord community](https://discord.gg/S3sP6dDaF3).
amqtt.io (#206) * ignoring all files and adding back was causing confusion * adding in amqtt.io website * adding amqtt logo * removing mobile version of the dashboard menu * minor change to naming of logo * adding functionality to display statistics from amqtt broker * adding content about configuration * separating amqtt.io from test.amqtt.io * adding link to the test server page * remove unneeded state * docker file for building image * separating docker build into two phases to minimize image size. add documentation for docker launch / configure * updating docs with references to docker image * adding missing icons * adding docker compose samples. updating classifiers and version * fixing uv lock file version identifier * tweaking test.amqtt.io page to include broker start and uptime. fix project links. add gitter icon * missing image * update to include 'client' 2025-06-11 15:49:09 +00:00			`# Home`

			`![assets/amqtt.svg](assets/amqtt.svg)`

			`aMQTT` is an open source [MQTT](http://www.mqtt.org) broker and client, natively implemented with Python's [asyncio](https://docs.python.org/3/library/asyncio.html).

			`## Features`

			`- Full set of [MQTT 3.1.1](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html) protocol specifications`
			`- Communication over TCP and/or websocket, including support for SSL/TLS`
			`- Support QoS 0, QoS 1 and QoS 2 messages flow`
			`- Client auto-reconnection on network lost`
			- Functionality expansion; plugins included: authentication and `$SYS` topic publishing

			`## Installation`

			`amqtt` is available on ![pypi](assets/python.svg) [PyPI](https://pypi.python.org/pypi/amqtt)

			`## Documentation`

			`amqtt` docs are available on ![readthedocs](assets/readthedocs.svg) [Read the Docs](http://amqtt.readthedocs.org/).

			`## Containerization`

			`Launch from ![dockerhub](assets/docker.svg) [DockerHub](https://hub.docker.com/repositories/amqtt)`

			```shell
			`$ docker run -d -p 1883:1883 amqtt/amqtt:latest`
			```

path tweaks for v0.11.0 release 2025-06-17 14:58:48 +00:00			`## Testing`

			The `amqtt` project runs a test aMQTT broker/server at [test.amqtt.io](https://test.amqtt.io) which supports: MQTT, MQTT over TLS, websocket, secure websockets.


amqtt.io (#206) * ignoring all files and adding back was causing confusion * adding in amqtt.io website * adding amqtt logo * removing mobile version of the dashboard menu * minor change to naming of logo * adding functionality to display statistics from amqtt broker * adding content about configuration * separating amqtt.io from test.amqtt.io * adding link to the test server page * remove unneeded state * docker file for building image * separating docker build into two phases to minimize image size. add documentation for docker launch / configure * updating docs with references to docker image * adding missing icons * adding docker compose samples. updating classifiers and version * fixing uv lock file version identifier * tweaking test.amqtt.io page to include broker start and uptime. fix project links. add gitter icon * missing image * update to include 'client' 2025-06-11 15:49:09 +00:00			`## Support`

			`amqtt` development is available on ![github](assets/github.svg) [GitHub](https://github.com/Yakifo/amqtt). Bug reports, patches and suggestions welcome!

switching from gitter to discord 2025-06-11 16:43:25 +00:00			`![github](assets/github.svg) [Open an issue](https://github.com/Yakifo/amqtt/issues/new) or join the ![discord](assets/discord.svg) [discord community](https://discord.gg/S3sP6dDaF3).`
amqtt.io (#206) * ignoring all files and adding back was causing confusion * adding in amqtt.io website * adding amqtt logo * removing mobile version of the dashboard menu * minor change to naming of logo * adding functionality to display statistics from amqtt broker * adding content about configuration * separating amqtt.io from test.amqtt.io * adding link to the test server page * remove unneeded state * docker file for building image * separating docker build into two phases to minimize image size. add documentation for docker launch / configure * updating docs with references to docker image * adding missing icons * adding docker compose samples. updating classifiers and version * fixing uv lock file version identifier * tweaking test.amqtt.io page to include broker start and uptime. fix project links. add gitter icon * missing image * update to include 'client' 2025-06-11 15:49:09 +00:00