Add docs, requirements and systemd

mother-of-all-self-hosting · Jul 3, 2023 · e5f845e · e5f845e
1 parent a581feb
commit e5f845e
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 1 deletion.
diff --git a/docs/services/mosquitto.md b/docs/services/mosquitto.md
@@ -0,0 +1,23 @@
+# Mosquitto Ansible Role
+
+
+[Mosquitto](https://mosquitto.org/) is an open source [MQTT](https://en.wikipedia.org/wiki/MQTT) broker.
+
+
+## Configuration
+
+To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
+
+```yaml
+mosquitto_enabled: true
+```
+
+## Usage
+
+After installation, you can use `just run-tags mosquitto-add-user --extra-vars=username=<username> --extra-vars=password=<password>"` to create a user. For the setting to take effect, you must restart the container.
+
+You can then start to send and subscribe to MQTT topics. Use port 1883 and the servers IP or any domain you configured to point at this server.
+
+## Alternatives
+
+* [rumqttd](rumqttd.md) is another MQTT broker
diff --git a/docs/services/rumqttd.md b/docs/services/rumqttd.md
@@ -35,3 +35,7 @@ rumqttd_enabled: true
 ## Usage
 
 You can then start to send and subscribe to MQTT topics. Use port 1883 and the servers IP or any domain you configured to point at this server.
+
+## Alternatives
+
+* [Mosquitto](mosquitto.md) is another, more feature-complete MQTT broker
diff --git a/docs/supported-services.md b/docs/supported-services.md
@@ -27,6 +27,7 @@
 | [MariaDB](https://mariadb.org/) | A powerful, open source object-relational database system | [Link](services/mariadb.md) |
 | [Matrix Rooms Search API](https://gitlab.com/etke.cc/mrs/api) | A fully-featured, standalone, matrix rooms search service. | [Link](services/mrs.md) |
 | [MongoDB](https://www.mongodb.com/) | A source-available cross-platform document-oriented (NoSQL) database program. | [Link](services/mongodb.md) |
+| [Mosquitto](https://mosquitto.org/) | An open-source MQTT broker | [Link](services/mosquitto.md) |
 | [Miniflux](https://miniflux.app/) | Minimalist and opinionated feed reader. | [Link](services/miniflux.md) |
 | [Mobilizon](https://joinmobilizon.org/en/) | An ActivityPub/Fediverse server to create and share events. | [Link](services/mobilizon.md) |
 | [Navidrome](https://www.navidrome.org/) | [Subsonic-API](http://www.subsonic.org/pages/api.jsp) compatible music server | [Link](services/navidrome.md)

diff --git a/group_vars/mash_servers b/group_vars/mash_servers
@@ -149,6 +149,8 @@ devture_systemd_service_manager_services_list_auto: |
     +
     ([{'name': (mongodb_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'mongodb']}] if mongodb_enabled else [])
     +
+    ([{'name': (mosquitto_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'mosquitto']}] if mosquitto_enabled else [])
+    +
     ([{'name': (mrs_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'mrs']}] if mrs_enabled else [])
     +
     ([{'name': (navidrome_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'navidrome']}] if navidrome_enabled else [])
@@ -1766,7 +1768,33 @@ mongodb_managed_databases_auto: |
 #                                                                      #
 ########################################################################
 
+########################################################################
+#                                                                      #
+# mosquitto                                                           #
+#                                                                      #
+########################################################################
+
+mosquitto_enabled: false
+
+mosquitto_identifier: "{{ mash_playbook_service_identifier_prefix }}mosquitto"
+
+mosquitto_base_path: "{{ mash_playbook_base_path }}/{{ mash_playbook_service_base_directory_name_prefix }}mosquitto"
 
+mosquitto_uid: "{{ mash_playbook_uid }}"
+mosquitto_gid: "{{ mash_playbook_gid }}"
+
+mosquitto_systemd_required_services_list: |
+  {{
+    (['docker.service'])
+  }}
+
+
+
+########################################################################
+#                                                                      #
+# /mosquitto                                                          #
+#                                                                      #
+########################################################################
 
 
 ########################################################################

diff --git a/requirements.yml b/requirements.yml
@@ -105,7 +105,10 @@
   name: mobilizon
 - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-mongodb.git
   version: v6.0.6-0
-  name: mongodb
+  name: mosquitto
+- src: git+https://github.com/mother-of-all-self-hosting/ansible-role-mosquitto.git
+  version: v2.0.15-0
+  name: mosquitto
 - src: git+https://gitlab.com/etke.cc/mrs/ansible-role-mrs.git
   version: v0.0.0-9
   name: mrs

diff --git a/setup.yml b/setup.yml
@@ -104,6 +104,8 @@
 
     - role: galaxy/mobilizon
 
+    - role: galaxy/mosquitto
+
     - role: galaxy/navidrome
 
     - role: galaxy/netbox