[SKIP CI] update readme

This commit is contained in:
Drone Shipper 2019-11-22 23:07:18 +00:00
parent 6f68c3444b
commit b2be151d94

110
README.md
View File

@ -8,18 +8,18 @@ Configure an 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_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_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)
@ -28,14 +28,6 @@ Configure an univention corporate server
## Default Variables
### ucs_custom_tls_enabled
#### Default value
```YAML
ucs_custom_tls_enabled: false
```
### ucs_custom_tls_apache2_enabled
#### Default value
@ -52,6 +44,14 @@ ucs_custom_tls_apache2_enabled: false
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
@ -60,38 +60,6 @@ ucs_custom_tls_dovecot_enabled: false
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
@ -112,6 +80,31 @@ ucs_filesystem_acl:
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
@ -131,29 +124,36 @@ ucs_system_groups:
state: defaults to 'present'
```
### ucs_repository_unmaintained_enabled
### ucs_tls_cert_path
#### Default value
```YAML
ucs_repository_unmaintained_enabled: false
ucs_tls_cert_path: /etc/pki/tls/certs/mycert.pem
```
### ucs_registry_extra
### ucs_tls_certs_dir
#### Default value
```YAML
ucs_registry_extra: []
ucs_tls_certs_dir: /etc/pki/tls/certs
```
#### Example usage
### ucs_tls_key_dir
#### Default value
```YAML
ucs_registry_extra:
- path: timeserver
value: "ntp.example.com"
state: present
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