Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite readme using MD rules instead of RST #30

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 47 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down