1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/mosquitto_ynh.git synced 2024-09-03 19:45:54 +02:00
mosquitto_ynh/README.md

52 lines
2.1 KiB
Markdown
Raw Normal View History

2022-06-20 01:41:52 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2017-10-26 13:01:33 +02:00
2022-06-20 01:41:52 +02:00
# Mosquitto for YunoHost
2017-10-26 21:14:30 +02:00
2022-06-20 01:41:52 +02:00
[![Integration level](https://dash.yunohost.org/integration/mosquitto.svg)](https://dash.yunohost.org/appci/app/mosquitto) ![Working status](https://ci-apps.yunohost.org/ci/badges/mosquitto.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mosquitto.maintain.svg)
2021-02-13 18:14:54 +01:00
[![Install Mosquitto with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mosquitto)
2017-10-26 13:01:33 +02:00
2021-02-13 18:14:54 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2017-10-26 13:01:33 +02:00
2021-02-13 18:14:54 +01:00
> *This package allows you to install Mosquitto quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
2017-10-26 13:01:33 +02:00
2021-02-13 18:14:54 +01:00
## Overview
2017-10-26 13:01:33 +02:00
2021-02-13 18:14:54 +01:00
[Mosquitto](https://mosquitto.org/) gives you interconnect your objects and applications with an open source MQTT broker. Client can publish or subscribe after authentication (username, password).
2017-10-26 13:01:33 +02:00
2021-02-13 18:14:54 +01:00
2022-06-20 01:41:52 +02:00
**Shipped version:** 2.0.8~ynh1
2021-02-13 18:14:54 +01:00
2022-06-20 01:41:52 +02:00
**Demo:** https://demo.example.com
## Disclaimers / important information
2021-02-13 18:14:54 +01:00
2022-06-20 01:41:52 +02:00
## TODO
2021-02-13 18:14:54 +01:00
2022-06-20 01:41:52 +02:00
- [ ] Add MQTTS (MQTT with TLS)
2021-02-13 18:14:54 +01:00
2022-06-20 01:41:52 +02:00
## Documentation and resources
2021-02-13 18:14:54 +01:00
2022-06-20 01:41:52 +02:00
* Official app website: <https://mosquitto.org>
* Official user documentation: <https://yunohost.org/apps>
* Official admin documentation: <https://mosquitto.org/documentation/>
* Upstream app code repository: <https://some.forge.com/example/example>
* YunoHost documentation for this app: <https://yunohost.org/app_mosquitto>
* Report a bug: <https://github.com/YunoHost-Apps/mosquitto_ynh/issues>
2021-02-13 18:14:54 +01:00
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mosquitto_ynh/tree/testing).
To try the testing branch, please proceed like that.
2022-06-20 01:41:52 +02:00
``` bash
2021-02-13 18:14:54 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/mosquitto_ynh/tree/testing --debug
or
sudo yunohost app upgrade mosquitto -u https://github.com/YunoHost-Apps/mosquitto_ynh/tree/testing --debug
```
2022-06-20 01:41:52 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>