From b2be151d94ce5830679f5669e93751489bcc3b95 Mon Sep 17 00:00:00 2001 From: DroneShipper Date: Fri, 22 Nov 2019 23:07:18 +0000 Subject: [PATCH] [SKIP CI] update readme --- README.md | 94 +++++++++++++++++++++++++++---------------------------- 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index b15109e..05b7f15 100644 --- a/README.md +++ b/README.md @@ -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,64 +44,65 @@ ucs_custom_tls_apache2_enabled: false ucs_custom_tls_dovecot_enabled: false ``` -### ucs_custom_tls_postfix_enabled +### ucs_custom_tls_enabled #### Default value ```YAML -ucs_custom_tls_postfix_enabled: false +ucs_custom_tls_enabled: false ``` -### ucs_tls_certs_dir +### ucs_custom_tls_postfix_enabled #### Default value ```YAML -ucs_tls_certs_dir: /etc/pki/tls/certs +ucs_custom_tls_postfix_enabled: false ``` -### ucs_tls_key_dir +### ucs_filesystem_acl #### Default value ```YAML -ucs_tls_key_dir: /etc/pki/tls/private +ucs_filesystem_acl: [] ``` -### ucs_tls_cert_path - -#### Default value +#### Example usage ```YAML -ucs_tls_cert_path: /etc/pki/tls/certs/mycert.pem +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_tls_key_path +### ucs_registry_extra #### Default value ```YAML -ucs_tls_key_path: /etc/pki/tls/private/mykey.pem +ucs_registry_extra: [] ``` -### ucs_filesystem_acl - -#### Default value +#### Example usage ```YAML -ucs_filesystem_acl: [] +ucs_registry_extra: + - path: timeserver + value: "ntp.example.com" + state: present ``` -#### Example usage +### ucs_repository_unmaintained_enabled + +#### Default value ```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_repository_unmaintained_enabled: false ``` ### ucs_system_groups @@ -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