cleanup readme

This commit is contained in:
Robert Kaussow 2020-01-30 22:58:49 +01:00
parent 7a817f81db
commit 1531849d27
1 changed files with 6 additions and 161 deletions

167
README.md
View File

@ -1,169 +1,14 @@
# xoxys.ucs
[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.ucs/status.svg)](https://drone.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)
Configure an univention corporate server
## Table of content
### License
* [Default Variables](#default-variables)
* [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)
* [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
### 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
```
## Dependencies
None.
## License
MIT
## Author
[xoxys](https://gitea.rknet.org/xoxys)
[Robert Kaussow](https://gitea.rknet.org/xoxys)