[SKIP CI] update readme
This commit is contained in:
parent
00c18c72ed
commit
d7beb3425e
204
README.md
204
README.md
|
|
@ -8,28 +8,28 @@ Role to setup mosquitto mqtt broker
|
|||
## Table of content
|
||||
|
||||
* [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_pid_file](#mosquitto_pid_file)
|
||||
* [mosquitto_user](#mosquitto_user)
|
||||
* [mosquitto_group](#mosquitto_group)
|
||||
* [mosquitto_port](#mosquitto_port)
|
||||
* [mosquitto_bind_address](#mosquitto_bind_address)
|
||||
* [mosquitto_ca_path](#mosquitto_ca_path)
|
||||
* [mosquitto_group](#mosquitto_group)
|
||||
* [mosquitto_packages_extra](#mosquitto_packages_extra)
|
||||
* [mosquitto_persistence_enabled](#mosquitto_persistence_enabled)
|
||||
* [mosquitto_persistence_path](#mosquitto_persistence_path)
|
||||
* [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_acl_enabled](#mosquitto_acl_enabled)
|
||||
* [mosquitto_acl_file](#mosquitto_acl_file)
|
||||
* [mosquitto_acl](#mosquitto_acl)
|
||||
* [mosquitto_tls_enabled](#mosquitto_tls_enabled)
|
||||
* [mosquitto_tls_ciphers](#mosquitto_tls_ciphers)
|
||||
* [mosquitto_ca_path](#mosquitto_ca_path)
|
||||
* [mosquitto_tls_cert_source](#mosquitto_tls_cert_source)
|
||||
* [mosquitto_tls_key_source](#mosquitto_tls_key_source)
|
||||
* [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)
|
||||
* [License](#license)
|
||||
* [Author](#author)
|
||||
|
|
@ -38,6 +38,48 @@ Role to setup mosquitto mqtt broker
|
|||
|
||||
## 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
|
||||
|
|
@ -46,38 +88,6 @@ Role to setup mosquitto mqtt broker
|
|||
mosquitto_base_dir: /etc/mosquitto
|
||||
```
|
||||
|
||||
### mosquitto_pid_file
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
mosquitto_pid_file: /var/run/mosquitto.pid
|
||||
```
|
||||
|
||||
### mosquitto_user
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
mosquitto_user: mosquitto
|
||||
```
|
||||
|
||||
### mosquitto_group
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
mosquitto_group: mosquitto
|
||||
```
|
||||
|
||||
### mosquitto_port
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
mosquitto_port: 1883
|
||||
```
|
||||
|
||||
### mosquitto_bind_address
|
||||
|
||||
#### Default value
|
||||
|
|
@ -86,6 +96,22 @@ mosquitto_port: 1883
|
|||
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
|
||||
|
|
@ -94,22 +120,6 @@ mosquitto_bind_address: '{{ ansible_default_ipv4.address }}'
|
|||
mosquitto_packages_extra: []
|
||||
```
|
||||
|
||||
### 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_password_auth_enabled
|
||||
|
||||
#### Default value
|
||||
|
|
@ -146,54 +156,52 @@ mosquitto_password_auth_users:
|
|||
state: absent
|
||||
```
|
||||
|
||||
### mosquitto_acl_enabled
|
||||
### mosquitto_persistence_enabled
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
mosquitto_acl_enabled: false
|
||||
mosquitto_persistence_enabled: false
|
||||
```
|
||||
|
||||
### mosquitto_acl_file
|
||||
### mosquitto_persistence_path
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
mosquitto_acl_file: '{{ mosquitto_base_dir }}/aclfile'
|
||||
mosquitto_persistence_path: /var/lib/mosquitto/mosquitto.db
|
||||
```
|
||||
|
||||
### mosquitto_acl
|
||||
### mosquitto_pid_file
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
mosquitto_acl: []
|
||||
mosquitto_pid_file: /var/run/mosquitto.pid
|
||||
```
|
||||
|
||||
#### 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_tls_enabled
|
||||
### mosquitto_port
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
mosquitto_tls_enabled: false
|
||||
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
|
||||
|
|
@ -211,20 +219,20 @@ mosquitto_tls_ciphers:
|
|||
- '@STRENGTH'
|
||||
```
|
||||
|
||||
### mosquitto_ca_path
|
||||
### mosquitto_tls_enabled
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
mosquitto_ca_path: /etc/pki/tls/certs/
|
||||
mosquitto_tls_enabled: false
|
||||
```
|
||||
|
||||
### mosquitto_tls_cert_source
|
||||
### mosquitto_tls_key_path
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
mosquitto_tls_cert_source: mycert.pem
|
||||
mosquitto_tls_key_path: '{{ mosquitto_base_dir }}/tls/private/mykey.pem'
|
||||
```
|
||||
|
||||
### mosquitto_tls_key_source
|
||||
|
|
@ -235,20 +243,12 @@ mosquitto_tls_cert_source: mycert.pem
|
|||
mosquitto_tls_key_source: mykey.pem
|
||||
```
|
||||
|
||||
### mosquitto_tls_cert_path
|
||||
### mosquitto_user
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
mosquitto_tls_cert_path: '{{ mosquitto_base_dir }}/tls/certs/mycert.pem'
|
||||
```
|
||||
|
||||
### mosquitto_tls_key_path
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
mosquitto_tls_key_path: '{{ mosquitto_base_dir }}/tls/private/mykey.pem'
|
||||
mosquitto_user: mosquitto
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
|
|
|||
Loading…
Reference in New Issue