[skip ci] automated docs update

2024-09-25 19:37:55 +00:00 · 2024-09-25 19:37:55 +00:00 · c2bd7d653f
commit c2bd7d653f
parent 124e3902de
1 changed files with 203 additions and 4 deletions
--- a/README.md
+++ b/README.md
@ -1,12 +1,211 @@
 # xoxys.ucs

+[![Source Code](https://img.shields.io/badge/gitea-source%20code-blue?logo=gitea&logoColor=white)](https://gitea.rknet.org/ansible/xoxys.ucs)
 [![Build Status](https://img.shields.io/drone/build/ansible/xoxys.ucs?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.ucs)
-[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitea.rknet.org/ansible/xoxys.ucs/src/branch/main/LICENSE)

-Configure an [Univention Corporate Server](https://www.univention.com/products/ucs/). UCS is a server appliance with an integrated management system for the central and cross-platform administration of servers, services, clients, desktops and users as well as virtualized computers operated in UCS.
+Configure an [Univention Corporate Server](https://www.univention.com/products/ucs/).
+UCS is a server appliance with an integrated management system for the central and
+cross-platform administration of servers, services, clients, desktops and users as well as
+virtualized computers operated in UCS.

-You can find the full documentation at [https://galaxy.geekdocs.de](https://galaxy.geekdocs.de/roles/cloud/ucs/).
+{{< hint type=important >}}
+This role covers only some really basic configurations and should be considered as not production ready.
+{{< /hint >}}
+
+## Table of content
+
+- [Requirements](#requirements)
+- [Default Variables](#default-variables)
+  - [ucs_cronjobs](#ucs_cronjobs)
+  - [ucs_custom_tls_apache2_enabled](#ucs_custom_tls_apache2_enabled)
+  - [ucs_custom_tls_dovecot_enabled](#ucs_custom_tls_dovecot_enabled)
+  - [ucs_custom_tls_enabled](#ucs_custom_tls_enabled)
+  - [ucs_custom_tls_postfix_enabled](#ucs_custom_tls_postfix_enabled)
+  - [ucs_filesystem_acl](#ucs_filesystem_acl)
+  - [ucs_registry_extra](#ucs_registry_extra)
+  - [ucs_repository_unmaintained_enabled](#ucs_repository_unmaintained_enabled)
+  - [ucs_system_groups](#ucs_system_groups)
+  - [ucs_tls_cert_path](#ucs_tls_cert_path)
+  - [ucs_tls_certs_dir](#ucs_tls_certs_dir)
+  - [ucs_tls_key_dir](#ucs_tls_key_dir)
+  - [ucs_tls_key_path](#ucs_tls_key_path)
+- [Discovered Tags](#discovered-tags)
+- [Dependencies](#dependencies)
+- [License](#license)
+- [Author](#author)
+
+---
+
+## Requirements
+
+- Minimum Ansible version: `2.10`
+
+## Default Variables
+
+### ucs_cronjobs
+
+#### Default value
+
+```YAML
+ucs_cronjobs: []
+```
+
+#### Example usage
+
+```YAML
+ucs_cronjobs:
+  - name: backup-cleanup
+    job: "find /var/univention-backup -mtime +7 -delete"
+    user: root
+    minute: 0
+    hour: 3
+    day: "*"
+    weekday: "*"
+    month: "*"
+    state: present
+```
+
+### 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_enabled
+
+#### Default value
+
+```YAML
+ucs_custom_tls_enabled: false
+```
+
+### ucs_custom_tls_postfix_enabled
+
+#### Default value
+
+```YAML
+ucs_custom_tls_postfix_enabled: false
+```
+
+### 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_registry_extra
+
+#### Default value
+
+```YAML
+ucs_registry_extra: []
+```
+
+#### Example usage
+
+```YAML
+ucs_registry_extra:
+  - path: timeserver
+    value: "ntp.example.com"
+    state: present
+```
+
+### ucs_repository_unmaintained_enabled
+
+#### Default value
+
+```YAML
+ucs_repository_unmaintained_enabled: false
+```
+
+### 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_tls_cert_path
+
+#### Default value
+
+```YAML
+ucs_tls_cert_path: /etc/pki/tls/certs/mycert.pem
+```
+
+### 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_key_path
+
+#### Default value
+
+```YAML
+ucs_tls_key_path: /etc/pki/tls/private/mykey.pem
+```
+
+## Discovered Tags
+
+**_tls_renewal_**
+
+## Dependencies
+
+None.

 ## License

-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+MIT
+
+## Author
+
+[Robert Kaussow](https://gitea.rknet.org/xoxys)