[SKIP CI] update readme
This commit is contained in:
parent
0455a41582
commit
0a37c10a01
254
README.md
254
README.md
@ -8,23 +8,23 @@ Role to setup an openldap proxy
|
||||
## Table of content
|
||||
|
||||
* [Default Variables](#default-variables)
|
||||
* [ldap_proxy_base_dir](#ldap_proxy_base_dir)
|
||||
* [ldap_proxy_urls](#ldap_proxy_urls)
|
||||
* [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_tls_ca_source](#ldap_proxy_tls_ca_source)
|
||||
* [ldap_proxy_tls_cert_path](#ldap_proxy_tls_cert_path)
|
||||
* [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_base_dir](#ldap_proxy_base_dir)
|
||||
* [ldap_proxy_custom_schemas](#ldap_proxy_custom_schemas)
|
||||
* [ldap_proxy_loglevel](#ldap_proxy_loglevel)
|
||||
* [ldap_proxy_options](#ldap_proxy_options)
|
||||
* [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_key_source](#ldap_proxy_tls_key_source)
|
||||
* [ldap_proxy_urls](#ldap_proxy_urls)
|
||||
* [Dependencies](#dependencies)
|
||||
* [License](#license)
|
||||
* [Author](#author)
|
||||
@ -33,119 +33,6 @@ Role to setup an openldap proxy
|
||||
|
||||
## Default Variables
|
||||
|
||||
### ldap_proxy_base_dir
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_base_dir: /etc/openldap
|
||||
```
|
||||
|
||||
### ldap_proxy_urls
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_urls:
|
||||
- ldapi:/// ldap:///
|
||||
```
|
||||
|
||||
### ldap_proxy_options
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_options: []
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_enabled
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_enabled: false
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_cert_source
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_cert_source: mycert.pem
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_key_source
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_key_source: mykey.pem
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_ca_source
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_ca_source: ca.pem
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_cert_path
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_cert_path: '{{ ldap_proxy_base_dir }}/certs/mycert.pem'
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_key_path
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_key_path: '{{ ldap_proxy_base_dir }}/certs/mykey.pem'
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_ca_path
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_ca_path: '{{ ldap_proxy_base_dir }}/certs/ca.path'
|
||||
```
|
||||
|
||||
### ldap_proxy_server
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_server: ldap://ad.example.com:389
|
||||
```
|
||||
|
||||
### ldap_proxy_server_suffix
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_server_suffix: dc=example,dc=com
|
||||
```
|
||||
|
||||
### ldap_proxy_readonly_enabled
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_readonly_enabled: true
|
||||
```
|
||||
|
||||
### ldap_proxy_loglevel
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_loglevel: 0
|
||||
```
|
||||
|
||||
### ldap_proxy_acl_file
|
||||
|
||||
#### Default value
|
||||
@ -166,6 +53,14 @@ ldap_proxy_acls:
|
||||
- '* read'
|
||||
```
|
||||
|
||||
### ldap_proxy_base_dir
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_base_dir: /etc/openldap
|
||||
```
|
||||
|
||||
### ldap_proxy_custom_schemas
|
||||
|
||||
#### Default value
|
||||
@ -174,6 +69,111 @@ ldap_proxy_acls:
|
||||
ldap_proxy_custom_schemas: []
|
||||
```
|
||||
|
||||
### ldap_proxy_loglevel
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_loglevel: 0
|
||||
```
|
||||
|
||||
### ldap_proxy_options
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_options: []
|
||||
```
|
||||
|
||||
### ldap_proxy_readonly_enabled
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_readonly_enabled: true
|
||||
```
|
||||
|
||||
### ldap_proxy_server
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_server: ldap://ad.example.com:389
|
||||
```
|
||||
|
||||
### ldap_proxy_server_suffix
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_server_suffix: dc=example,dc=com
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_ca_path
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_ca_path: '{{ ldap_proxy_base_dir }}/certs/ca.path'
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_ca_source
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_ca_source: ca.pem
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_cert_path
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_cert_path: '{{ ldap_proxy_base_dir }}/certs/mycert.pem'
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_cert_source
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_cert_source: mycert.pem
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_enabled
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_enabled: false
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_key_path
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_key_path: '{{ ldap_proxy_base_dir }}/certs/mykey.pem'
|
||||
```
|
||||
|
||||
### ldap_proxy_tls_key_source
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_tls_key_source: mykey.pem
|
||||
```
|
||||
|
||||
### ldap_proxy_urls
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
ldap_proxy_urls:
|
||||
- ldapi:/// ldap:///
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
None.
|
||||
|
Loading…
Reference in New Issue
Block a user