From 0a37c10a01a8ff3388d624d3b258b53f3a01fa97 Mon Sep 17 00:00:00 2001 From: DroneShipper Date: Fri, 22 Nov 2019 23:13:58 +0000 Subject: [PATCH] [SKIP CI] update readme --- README.md | 98 +++++++++++++++++++++++++++---------------------------- 1 file changed, 49 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index f62405f..ec59531 100644 --- a/README.md +++ b/README.md @@ -8,23 +8,23 @@ Role to setup an openldap proxy ## Table of content * [Default Variables](#default-variables) + * [ldap_proxy_acl_file](#ldap_proxy_acl_file) + * [ldap_proxy_acls](#ldap_proxy_acls) * [ldap_proxy_base_dir](#ldap_proxy_base_dir) - * [ldap_proxy_urls](#ldap_proxy_urls) + * [ldap_proxy_custom_schemas](#ldap_proxy_custom_schemas) + * [ldap_proxy_loglevel](#ldap_proxy_loglevel) * [ldap_proxy_options](#ldap_proxy_options) - * [ldap_proxy_tls_enabled](#ldap_proxy_tls_enabled) - * [ldap_proxy_tls_cert_source](#ldap_proxy_tls_cert_source) - * [ldap_proxy_tls_key_source](#ldap_proxy_tls_key_source) + * [ldap_proxy_readonly_enabled](#ldap_proxy_readonly_enabled) + * [ldap_proxy_server](#ldap_proxy_server) + * [ldap_proxy_server_suffix](#ldap_proxy_server_suffix) + * [ldap_proxy_tls_ca_path](#ldap_proxy_tls_ca_path) * [ldap_proxy_tls_ca_source](#ldap_proxy_tls_ca_source) * [ldap_proxy_tls_cert_path](#ldap_proxy_tls_cert_path) + * [ldap_proxy_tls_cert_source](#ldap_proxy_tls_cert_source) + * [ldap_proxy_tls_enabled](#ldap_proxy_tls_enabled) * [ldap_proxy_tls_key_path](#ldap_proxy_tls_key_path) - * [ldap_proxy_tls_ca_path](#ldap_proxy_tls_ca_path) - * [ldap_proxy_server](#ldap_proxy_server) - * [ldap_proxy_server_suffix](#ldap_proxy_server_suffix) - * [ldap_proxy_readonly_enabled](#ldap_proxy_readonly_enabled) - * [ldap_proxy_loglevel](#ldap_proxy_loglevel) - * [ldap_proxy_acl_file](#ldap_proxy_acl_file) - * [ldap_proxy_acls](#ldap_proxy_acls) - * [ldap_proxy_custom_schemas](#ldap_proxy_custom_schemas) + * [ldap_proxy_tls_key_source](#ldap_proxy_tls_key_source) + * [ldap_proxy_urls](#ldap_proxy_urls) * [Dependencies](#dependencies) * [License](#license) * [Author](#author) @@ -33,77 +33,80 @@ Role to setup an openldap proxy ## Default Variables -### ldap_proxy_base_dir +### ldap_proxy_acl_file #### Default value ```YAML -ldap_proxy_base_dir: /etc/openldap +ldap_proxy_acl_file: '{{ ldap_proxy_base_dir }}/slapd.access' ``` -### ldap_proxy_urls +### ldap_proxy_acls #### Default value ```YAML -ldap_proxy_urls: - - ldapi:/// ldap:/// +ldap_proxy_acls: + - access_to: + - '*' + access_by: + - '* read' ``` -### ldap_proxy_options +### ldap_proxy_base_dir #### Default value ```YAML -ldap_proxy_options: [] +ldap_proxy_base_dir: /etc/openldap ``` -### ldap_proxy_tls_enabled +### ldap_proxy_custom_schemas #### Default value ```YAML -ldap_proxy_tls_enabled: false +ldap_proxy_custom_schemas: [] ``` -### ldap_proxy_tls_cert_source +### ldap_proxy_loglevel #### Default value ```YAML -ldap_proxy_tls_cert_source: mycert.pem +ldap_proxy_loglevel: 0 ``` -### ldap_proxy_tls_key_source +### ldap_proxy_options #### Default value ```YAML -ldap_proxy_tls_key_source: mykey.pem +ldap_proxy_options: [] ``` -### ldap_proxy_tls_ca_source +### ldap_proxy_readonly_enabled #### Default value ```YAML -ldap_proxy_tls_ca_source: ca.pem +ldap_proxy_readonly_enabled: true ``` -### ldap_proxy_tls_cert_path +### ldap_proxy_server #### Default value ```YAML -ldap_proxy_tls_cert_path: '{{ ldap_proxy_base_dir }}/certs/mycert.pem' +ldap_proxy_server: ldap://ad.example.com:389 ``` -### ldap_proxy_tls_key_path +### ldap_proxy_server_suffix #### Default value ```YAML -ldap_proxy_tls_key_path: '{{ ldap_proxy_base_dir }}/certs/mykey.pem' +ldap_proxy_server_suffix: dc=example,dc=com ``` ### ldap_proxy_tls_ca_path @@ -114,64 +117,61 @@ ldap_proxy_tls_key_path: '{{ ldap_proxy_base_dir }}/certs/mykey.pem' ldap_proxy_tls_ca_path: '{{ ldap_proxy_base_dir }}/certs/ca.path' ``` -### ldap_proxy_server +### ldap_proxy_tls_ca_source #### Default value ```YAML -ldap_proxy_server: ldap://ad.example.com:389 +ldap_proxy_tls_ca_source: ca.pem ``` -### ldap_proxy_server_suffix +### ldap_proxy_tls_cert_path #### Default value ```YAML -ldap_proxy_server_suffix: dc=example,dc=com +ldap_proxy_tls_cert_path: '{{ ldap_proxy_base_dir }}/certs/mycert.pem' ``` -### ldap_proxy_readonly_enabled +### ldap_proxy_tls_cert_source #### Default value ```YAML -ldap_proxy_readonly_enabled: true +ldap_proxy_tls_cert_source: mycert.pem ``` -### ldap_proxy_loglevel +### ldap_proxy_tls_enabled #### Default value ```YAML -ldap_proxy_loglevel: 0 +ldap_proxy_tls_enabled: false ``` -### ldap_proxy_acl_file +### ldap_proxy_tls_key_path #### Default value ```YAML -ldap_proxy_acl_file: '{{ ldap_proxy_base_dir }}/slapd.access' +ldap_proxy_tls_key_path: '{{ ldap_proxy_base_dir }}/certs/mykey.pem' ``` -### ldap_proxy_acls +### ldap_proxy_tls_key_source #### Default value ```YAML -ldap_proxy_acls: - - access_to: - - '*' - access_by: - - '* read' +ldap_proxy_tls_key_source: mykey.pem ``` -### ldap_proxy_custom_schemas +### ldap_proxy_urls #### Default value ```YAML -ldap_proxy_custom_schemas: [] +ldap_proxy_urls: + - ldapi:/// ldap:/// ``` ## Dependencies