[SKIP CI] update readme

2019-10-19 13:46:00 +00:00 · 2019-10-19 13:46:00 +00:00 · 550c61ab1d
commit 550c61ab1d
parent 1fc8087ade
1 changed files with 167 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1,2 +1,169 @@
 # xoxys.ucs
  
+[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.ucs/status.svg)](https://drone.rknet.org/ansible/xoxys.ucs)
+
+
+Role to configure a univention corporate server
+
+## Table of content
+
+* [Default Variables](#default-variables)
+  * [ucs_custom_tls_enabled](#ucs_custom_tls_enabled)
+  * [ucs_custom_tls_apache2_enabled](#ucs_custom_tls_apache2_enabled)
+  * [ucs_custom_tls_dovecot_enabled](#ucs_custom_tls_dovecot_enabled)
+  * [ucs_custom_tls_postfix_enabled](#ucs_custom_tls_postfix_enabled)
+  * [ucs_tls_certs_dir](#ucs_tls_certs_dir)
+  * [ucs_tls_key_dir](#ucs_tls_key_dir)
+  * [ucs_tls_cert_path](#ucs_tls_cert_path)
+  * [ucs_tls_key_path](#ucs_tls_key_path)
+  * [ucs_filesystem_acl](#ucs_filesystem_acl)
+  * [ucs_system_groups](#ucs_system_groups)
+  * [ucs_repository_unmaintained_enabled](#ucs_repository_unmaintained_enabled)
+  * [ucs_registry_extra](#ucs_registry_extra)
+* [Dependencies](#dependencies)
+* [License](#license)
+* [Author](#author)
+
+---
+
+## Default Variables
+
+### ucs_custom_tls_enabled
+
+#### Default value
+
+```YAML
+ucs_custom_tls_enabled: false
+```
+
+### ucs_custom_tls_apache2_enabled
+
+#### Default value
+
+```YAML
+ucs_custom_tls_apache2_enabled: false
+```
+
+### ucs_custom_tls_dovecot_enabled
+
+#### Default value
+
+```YAML
+ucs_custom_tls_dovecot_enabled: false
+```
+
+### ucs_custom_tls_postfix_enabled
+
+#### Default value
+
+```YAML
+ucs_custom_tls_postfix_enabled: false
+```
+
+### ucs_tls_certs_dir
+
+#### Default value
+
+```YAML
+ucs_tls_certs_dir: /etc/pki/tls/certs
+```
+
+### ucs_tls_key_dir
+
+#### Default value
+
+```YAML
+ucs_tls_key_dir: /etc/pki/tls/private
+```
+
+### ucs_tls_cert_path
+
+#### Default value
+
+```YAML
+ucs_tls_cert_path: /etc/pki/tls/certs/mycert.pem
+```
+
+### ucs_tls_key_path
+
+#### Default value
+
+```YAML
+ucs_tls_key_path: /etc/pki/tls/private/mykey.pem
+```
+
+### ucs_filesystem_acl
+
+#### Default value
+
+```YAML
+ucs_filesystem_acl: []
+```
+
+#### Example usage
+
+```YAML
+ucs_filesystem_acl:
+  - path: /shares/mydocuments  needs to be set
+    entity: john  needs to be set
+    etype: user  needs to be set
+    permissions: rw  needs to be set
+    state:  defaults to 'query'
+    recursive:  defaults to 'no'
+```
+
+### ucs_system_groups
+
+#### Default value
+
+```YAML
+ucs_system_groups: []
+```
+
+#### Example usage
+
+```YAML
+ucs_system_groups:
+  - name: fs-mydocuments-rw  needs to be set
+    description:  defaults to not set
+    subpath:  defaults to not set
+    ou:  defaults to not set
+    state:  defaults to 'present'
+```
+
+### ucs_repository_unmaintained_enabled
+
+#### Default value
+
+```YAML
+ucs_repository_unmaintained_enabled: false
+```
+
+### ucs_registry_extra
+
+#### Default value
+
+```YAML
+ucs_registry_extra: []
+```
+
+#### Example usage
+
+```YAML
+ucs_registry_extra:
+  - path: timeserver
+    value: "ntp.example.com"
+    state: present
+```
+
+## Dependencies
+
+None.
+
+## License
+
+MIT
+
+## Author
+
+xoxys