cleanup readme

2020-01-30 22:58:49 +01:00 · 2020-01-30 22:58:49 +01:00 · 5462047671
commit 5462047671
parent 904f25eb4d
1 changed files with 6 additions and 256 deletions
--- a/README.md
+++ b/README.md
@ -1,264 +1,14 @@
 # xoxys.mosquitto

-[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.mosquitto/status.svg)](https://drone.rknet.org/ansible/xoxys.mosquitto)
+[![Build Status](https://img.shields.io/drone/build/ansible/xoxys.mosquitto?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.mosquitto)


 Role to setup mosquitto mqtt broker

-## Table of content
+### License

-* [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)
-* [License](#license)
-* [Author](#author)
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---
+### Maintainers and Contributors

-## 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.
-
-## License
-
-MIT
-
-## Author
-
-[xoxys](https://gitea.rknet.org/xoxys)
+[Robert Kaussow](https://gitea.rknet.org/xoxys)