docs

README.md

@@ -8,6 +8,38 @@ A docker image to run OpenLDAP. Latest release: 1.1.0 / OpenLDAP 2.4.40 - [Chang
 
 Support TLS, multi-master replication and quick bootstrap.
 
+- [Quick Start](#quick-start)
+- [Beginner Guide](#beginner-guide)
+	- [Create new ldap server](#create-new-ldap-server)
+		- [Data persitance](#data-persitance)
+		- [Edit your server configuration](#)
+	- [Use an existing ldap database](#use-an-existing-ldap-database)
+	- [Backup](#backup)
+	- [Administrate Your Ldap Server](#administrate-your-ldap-server)
+	- [TLS](#tls)
+		- [Use auto-generated certificate](#use-auto-generated-certificate)
+		- [Use your own certificate](#use-your-own-certificate)
+		- [Disable TLS](#disable-tls)
+	- [Multi master replication](#multi-master-replication)
+	- [Debug](#debug)
+
+- [Environment Variables](#environment-variables)
+	- [default.yaml](#default.yaml)
+	- [default.yaml.startup](#default.yaml.startup)
+	- [Set your own environment variables](#set-your-own-environment-variables)
+		- [Use command line argument](#use-command-line-argument)
+		- [Link environment file](#link-environment-file)
+		- [Make your own image or extend this image](#make-your-own-image-or-extend-this-image)
+
+- [Advanced User Guide](#advanced-user-guide)
+	- [Extend osixia/openldap:1.1.0 image](#extend-osixia/openldap:1.1.0-image)
+	- [Make your own openldap image](#make-your-own-openldap-image)
+	- [Kubernetes](#kubernetes)
+	- [Under the hood: osixia/light-baseimage](#under-the-hood:-osixia/light-baseimage)
+- [Tests](#tests)
+- [Changelog](#changelog)
+- [Contributing](#contributing)
+
 ## Quick Start
 Run OpenLDAP docker image:
 
@@ -76,19 +108,17 @@ simply mount this directories as a volume to `/var/lib/ldap` and `/etc/ldap/slap
 You can also use data volume containers. Please refer to:
 > [https://docs.docker.com/userguide/dockervolumes/](https://docs.docker.com/userguide/dockervolumes/)
 
+### Backup
+A simple solution to backup your ldap server, is our openldap-backup docker image:
+> [osixia/openldap-backup](https://github.com/osixia/docker-openldap-backup)
 
-### Debug
-
-The container default log level is **info**.
-Available levels are: `none`, `error`, `warning`, `info`, `debug` and `trace`.
-
-Example command to run the container in `debug` mode:
-
-	docker run --detach osixia/openldap:1.1.0 --loglevel debug
+### Administrate Your Ldap Server
+If you are looking for a simple solution to administrate your ldap server you can take a look at our phpLDAPadmin docker image:
+> [osixia/phpldapadmin](https://github.com/osixia/docker-phpLDAPadmin)
 
 ### TLS
 
-#### Use autogenerated certificate
+#### Use auto-generated certificate
 By default TLS is enable, a certificate is created with the container hostname (it can be set by docker run --hostname option eg: ldap.example.org).
 
 	docker run --hostname ldap.my-company.com --detach osixia/openldap:1.1.0
@@ -148,15 +178,17 @@ Search on the second ldap server, and billy should show up!
 	objectClass: inetOrgPerson
 	[...]
 
-## Administrate Your Ldap Server
-If you are looking for a simple solution to administrate your ldap server you can take a look at our phpLDAPadmin docker image:
-> [osixia/phpldapadmin](https://github.com/osixia/docker-phpLDAPadmin)
+### Debug
+
+The container default log level is **info**.
+Available levels are: `none`, `error`, `warning`, `info`, `debug` and `trace`.
+
+Example command to run the container in `debug` mode:
+
+	docker run --detach osixia/openldap:1.1.0 --loglevel debug
 
-## Backup
-A simple solution to backup your ldap server, is our openldap-backup docker image:
-> [osixia/openldap-backup](https://github.com/osixia/docker-openldap-backup)
 
-## Default Environment Variables
+## Environment Variables
 Environment variables defaults are set in **image/environment/default.yaml** and **image/environment/default.yaml.startup**.
 
 See how to [set your own environment variables](#set-your-own-environment-variables)
@@ -218,7 +250,7 @@ Other environment variables:
 - **LDAP_REMOVE_CONFIG_AFTER_SETUP**: delete config folder after setup. Defaults to `true`
 
 
-### Set your own environment variables:
+### Set your own environment variables
 
 #### Use command line argument
 Environment variables can be set by adding the --env argument in the command line, for example:
@@ -295,7 +327,7 @@ More information:
 
 osixia-openldap kubernetes examples are available in **example/kubernetes**
 
-### Under the hood : osixia/light-baseimage
+### Under the hood: osixia/light-baseimage
 
 This image is based on osixia/light-baseimage.
 It uses the following features: