From b9f16198651cab2abf6943f8763bf849e6cd8e14 Mon Sep 17 00:00:00 2001 From: Marco Marinello Date: Wed, 18 Mar 2020 19:01:21 +0100 Subject: [PATCH] Rewrite readme using MD rules instead of RST Signed-off-by: Marco Marinello --- README.md | 95 +++++++++++++++++++++++++++---------------------------- 1 file changed, 47 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 081cbe1..2c0a5b8 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,68 @@ -openldap_server -=============== +# openldap\_server This roles installs the OpenLDAP server on the target machine. It has the option to enable/disable SSL by setting it in defaults or overriding it. -Requirements ------------- +## Requirements This role requires Ansible 1.4 or higher, and platform requirements are listed in the metadata file. -Role Variables --------------- +## Role Variables The variables that can be passed to this role and a brief description about them are as follows: - openldap_serverdomain_name: example.com # The domain prefix for ldap - openldap_serverrootpw: passme # This is the password for admin for openldap - openldap_serverenable_ssl: true # To enable/disable ssl for the ldap - openldap_servercountry: US # The self signed ssl certificate parameters - openldap_serverstate: Oregon - openldap_serverlocation: Portland - openldap_serverorganization: IT - - -Examples --------- - -1) Configure an OpenLDAP server without SSL: - - - hosts: all - sudo: true - roles: - - role: bennojoy.openldap_server - openldap_server_domain_name: example.com - openldap_server_rootpw: passme - openldap_server_enable_ssl: false - -2) Configure an OpenLDAP server with SSL: - - - hosts: all - sudo: true - roles: - - role: bennojoy.openldap_server - openldap_server_domain_name: example.com - openldap_server_rootpw: passme - openldap_server_enable_ssl: true - openldap_server_country: US - openldap_server_state: Oregon - openldap_server_location: Portland - openldap_server_organization: IT - -Dependencies ------------- +``` +openldap_serverdomain_name: example.com # The domain prefix for ldap +openldap_serverrootpw: passme # This is the password for admin for openldap +openldap_serverenable_ssl: true # To enable/disable ssl for the ldap +openldap_servercountry: US # The self signed ssl certificate parameters +openldap_serverstate: Oregon +openldap_serverlocation: Portland +openldap_serverorganization: IT +``` + + +## Examples + +1. Configure an OpenLDAP server without SSL: + +``` +- hosts: all + sudo: true + roles: + - role: bennojoy.openldap_server + openldap_server_domain_name: example.com + openldap_server_rootpw: passme + openldap_server_enable_ssl: false +``` + +2. Configure an OpenLDAP server with SSL: + +``` +- hosts: all + sudo: true + roles: + - role: bennojoy.openldap_server + openldap_server_domain_name: example.com + openldap_server_rootpw: passme + openldap_server_enable_ssl: true + openldap_server_country: US + openldap_server_state: Oregon + openldap_server_location: Portland + openldap_server_organization: IT +``` + +## Dependencies None -License -------- +## License BSD -Author Information ------------------- +## Author Information Benno Joy