From 9c40b8fea5d437a474bcd6b4474e46eb624b44d6 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Thu, 30 Jan 2020 22:58:49 +0100 Subject: [PATCH] cleanup readme --- README.md | 185 ++---------------------------------------------------- 1 file changed, 6 insertions(+), 179 deletions(-) diff --git a/README.md b/README.md index ec59531..a8d7f78 100644 --- a/README.md +++ b/README.md @@ -1,187 +1,14 @@ # xoxys.ldap_proxy - -[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.ldap_proxy/status.svg)](https://drone.rknet.org/ansible/xoxys.ldap_proxy) + +[![Build Status](https://img.shields.io/drone/build/ansible/xoxys.ldap_proxy?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.ldap_proxy) Role to setup an openldap proxy -## Table of content +### License -* [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_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) +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. ---- +### Maintainers and Contributors -## Default Variables - -### ldap_proxy_acl_file - -#### Default value - -```YAML -ldap_proxy_acl_file: '{{ ldap_proxy_base_dir }}/slapd.access' -``` - -### ldap_proxy_acls - -#### Default value - -```YAML -ldap_proxy_acls: - - access_to: - - '*' - access_by: - - '* read' -``` - -### ldap_proxy_base_dir - -#### Default value - -```YAML -ldap_proxy_base_dir: /etc/openldap -``` - -### ldap_proxy_custom_schemas - -#### Default value - -```YAML -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. - -## License - -MIT - -## Author - -[xoxys](https://gitea.rknet.org/xoxys) +[Robert Kaussow](https://gitea.rknet.org/xoxys)