Merge pull request #1762 from heidemn-faro/doc/ldap-example

[doc/example] Make LDAP example functional again by running OpenLDAP with docker-compose

Documentation/connectors/ldap.md

@@ -13,16 +13,17 @@ The connector executes two primary queries:
 
 The dex repo contains a basic LDAP setup using [OpenLDAP][openldap].
 
-First start the LDAP server using the example script. This will run the OpenLDAP daemon and seed it with an initial set of users.
+First start the LDAP server using docker-compose. This will run the OpenLDAP daemon in a Docker container, and seed it with an initial set of users.
 
 ```
-./scripts/slapd.sh
+cd examples/ldap
+docker-compose up
 ```
 
-This script sets the LDAP daemon to debug mode, and is expected to print several error messages which are normal. Once the server is up, run dex.
+This container is expected to print several warning messages which are normal. Once the server is up, run dex in another terminal.
 
 ```
-./bin/dex serve examples/config-ldap.yaml
+./bin/dex serve examples/ldap/config-ldap.yaml
 ```
 
 Then run the OAuth client in another terminal.

examples/ldap/config-ldap.ldif

@@ -1,8 +1,10 @@
-dn: dc=example,dc=org
-objectClass: dcObject
-objectClass: organization
-o: Example Company
-dc: example
+# Already included in default config of Docker image osixia/openldap:1.4.0.
+#
+# dn: dc=example,dc=org
+# objectClass: dcObject
+# objectClass: organization
+# o: Example Company
+# dc: example
 
 dn: ou=People,dc=example,dc=org
 objectClass: organizationalUnit

examples/ldap/config-ldap.yaml

@@ -11,7 +11,7 @@ connectors:
   name: OpenLDAP
   id: ldap
   config:
-    host: localhost:10389
+    host: localhost:389
 
     # No TLS for this setup.
     insecureNoSSL: true

examples/ldap/docker-compose.yaml

@@ -0,0 +1,16 @@
+version: "3"
+
+services:
+  ldap:
+    image: osixia/openldap:1.4.0
+    # Copying is required because the entrypoint modifies the *.ldif files.
+    # For verbose output, use:  command: ["--copy-service", "--loglevel", "debug"]
+    command: ["--copy-service"]
+    # https://github.com/osixia/docker-openldap#seed-ldap-database-with-ldif
+    # Option 1: Add custom seed file -> mount to         /container/service/slapd/assets/config/bootstrap/ldif/custom/
+    # Option 2: Overwrite default seed file -> mount to  /container/service/slapd/assets/config/bootstrap/ldif/
+    volumes:
+    - ./config-ldap.ldif:/container/service/slapd/assets/config/bootstrap/ldif/custom/config-ldap.ldif
+    ports:
+    - 389:389
+    - 636:636