From 7a83e1fdcf938a8a13923bbe221488e7b9af7b83 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Wed, 22 Jan 2020 22:30:36 +0000 Subject: [PATCH] commit 904f25eb4d6708f24e2554ffe4af89262a4373cd Author: Robert Kaussow Date: Wed Jan 22 23:24:46 2020 +0100 force run --- index.md | 252 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 252 insertions(+) create mode 100644 index.md diff --git a/index.md b/index.md new file mode 100644 index 0000000..fd35fff --- /dev/null +++ b/index.md @@ -0,0 +1,252 @@ +--- +title: mosquitto +type: docs +--- + +Role to setup mosquitto mqtt broker + +* [Default Variables](#default-variables) + * [mosquitto_acl](#mosquitto-acl) + * [mosquitto_acl_enabled](#mosquitto-acl-enabled) + * [mosquitto_acl_file](#mosquitto-acl-file) + * [mosquitto_base_dir](#mosquitto-base-dir) + * [mosquitto_bind_address](#mosquitto-bind-address) + * [mosquitto_ca_path](#mosquitto-ca-path) + * [mosquitto_group](#mosquitto-group) + * [mosquitto_packages_extra](#mosquitto-packages-extra) + * [mosquitto_password_auth_enabled](#mosquitto-password-auth-enabled) + * [mosquitto_password_auth_file](#mosquitto-password-auth-file) + * [mosquitto_password_auth_users](#mosquitto-password-auth-users) + * [mosquitto_persistence_enabled](#mosquitto-persistence-enabled) + * [mosquitto_persistence_path](#mosquitto-persistence-path) + * [mosquitto_pid_file](#mosquitto-pid-file) + * [mosquitto_port](#mosquitto-port) + * [mosquitto_tls_cert_path](#mosquitto-tls-cert-path) + * [mosquitto_tls_cert_source](#mosquitto-tls-cert-source) + * [mosquitto_tls_ciphers](#mosquitto-tls-ciphers) + * [mosquitto_tls_enabled](#mosquitto-tls-enabled) + * [mosquitto_tls_key_path](#mosquitto-tls-key-path) + * [mosquitto_tls_key_source](#mosquitto-tls-key-source) + * [mosquitto_user](#mosquitto-user) +* [Dependencies](#dependencies) + +--- + +## Default Variables + +### mosquitto_acl + +#### Default value + +```YAML +mosquitto_acl: [] +``` + +#### Example usage + +```YAML +mosquitto_acl: + - name: iot + user: admin + acls: + - acl_base: topic (topic|pattern, defaults to topic) + acl_topic: "" + acl_policy: readwrite + - name: readonly_iot + user: user1 + acls: + - acl_base: topic + acl_topic: my/devices + acl_policy: readwrite +``` + +### mosquitto_acl_enabled + +#### Default value + +```YAML +mosquitto_acl_enabled: false +``` + +### mosquitto_acl_file + +#### Default value + +```YAML +mosquitto_acl_file: '{{ mosquitto_base_dir }}/aclfile' +``` + +### mosquitto_base_dir + +#### Default value + +```YAML +mosquitto_base_dir: /etc/mosquitto +``` + +### mosquitto_bind_address + +#### Default value + +```YAML +mosquitto_bind_address: '{{ ansible_default_ipv4.address }}' +``` + +### mosquitto_ca_path + +#### Default value + +```YAML +mosquitto_ca_path: /etc/pki/tls/certs/ +``` + +### mosquitto_group + +#### Default value + +```YAML +mosquitto_group: mosquitto +``` + +### mosquitto_packages_extra + +#### Default value + +```YAML +mosquitto_packages_extra: [] +``` + +### mosquitto_password_auth_enabled + +#### Default value + +```YAML +mosquitto_password_auth_enabled: false +``` + +### mosquitto_password_auth_file + +#### Default value + +```YAML +mosquitto_password_auth_file: '{{ mosquitto_base_dir }}/passwd' +``` + +### mosquitto_password_auth_users + +#### Default value + +```YAML +mosquitto_password_auth_users: [] +``` + +#### Example usage + +```YAML +mosquitto_password_auth_users: + - name: admin + password: mysecret + state: present + - name: user1 + password: very_secure + state: absent +``` + +### mosquitto_persistence_enabled + +#### Default value + +```YAML +mosquitto_persistence_enabled: false +``` + +### mosquitto_persistence_path + +#### Default value + +```YAML +mosquitto_persistence_path: /var/lib/mosquitto/mosquitto.db +``` + +### mosquitto_pid_file + +#### Default value + +```YAML +mosquitto_pid_file: /var/run/mosquitto.pid +``` + +### mosquitto_port + +#### Default value + +```YAML +mosquitto_port: 1883 +``` + +### mosquitto_tls_cert_path + +#### Default value + +```YAML +mosquitto_tls_cert_path: '{{ mosquitto_base_dir }}/tls/certs/mycert.pem' +``` + +### mosquitto_tls_cert_source + +#### Default value + +```YAML +mosquitto_tls_cert_source: mycert.pem +``` + +### mosquitto_tls_ciphers + +#### Default value + +```YAML +mosquitto_tls_ciphers: + - DEFAULT + - '!aNULL' + - '!eNULL' + - '!LOW' + - '!EXPORT' + - '!SSLv2' + - '@STRENGTH' +``` + +### mosquitto_tls_enabled + +#### Default value + +```YAML +mosquitto_tls_enabled: false +``` + +### mosquitto_tls_key_path + +#### Default value + +```YAML +mosquitto_tls_key_path: '{{ mosquitto_base_dir }}/tls/private/mykey.pem' +``` + +### mosquitto_tls_key_source + +#### Default value + +```YAML +mosquitto_tls_key_source: mykey.pem +``` + +### mosquitto_user + +#### Default value + +```YAML +mosquitto_user: mosquitto +``` + +## Dependencies + +None.