From 903cd2860aef3288bc83acb5f2cfaaf76660aac5 Mon Sep 17 00:00:00 2001
From: Artur Neumann <artur@jankaritech.com>
Date: Tue, 21 Apr 2020 13:58:08 +0545
Subject: [PATCH] fix user related documentation (#138)

* fix docs: ldap is the default REVA_USERS_DRIVER

* fix docs: update LDAP defaults
---
 README.md     |  2 ++
 docs/users.md | 23 ++++++++++++-----------
 2 files changed, 14 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 78993c3c96..cf20b16609 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,8 @@ make generate build
 
 To run a demo installation you can use the preconfigured defaults and start all necessary services:
 ```
+export REVA_USERS_DRIVER=demo
+
 bin/ocis-reva frontend & \
 bin/ocis-reva gateway & \
 bin/ocis-reva users & \
diff --git a/docs/users.md b/docs/users.md
index ef5be45b68..475c21290f 100644
--- a/docs/users.md
+++ b/docs/users.md
@@ -9,16 +9,20 @@ geekdocFilePath: users.md
 
 ### Demo driver
 
-This is the default user driver.It contains three users:
+This is a simple user driver for testing. It contains three users:
 ```
 einstein:relativity
 marie:radioactivty
 richard:superfluidity
 ```
+In order to use the `demo` driver you need to export the relevant environment variable:
+```
+export REVA_USERS_DRIVER=demo
+```
 
 ### JSON driver
 
-In order to switch from the `demo` driver to JSON based users you need to export the relevant environment variables:
+In order to switch from the `ldap` driver to JSON based users you need to export the relevant environment variables:
 ```
 export REVA_USERS_DRIVER=json
 export REVA_USERS_JSON=/path/to/users.json
@@ -28,23 +32,20 @@ For the format of the users.json have a look at the [reva examples](https://gith
 
 ### LDAP driver
 
-In order to switch from the `demo` driver to LDAP you need to export the relevant environment variable:
-```
-export REVA_USERS_DRIVER=ldap
-```
+This is the default user driver.
 
 If the below defaults don't match your environment change them accordingly:
 ```
 export REVA_LDAP_HOSTNAME=localhost
-export REVA_LDAP_PORT=636
-export REVA_LDAP_BASE_DN='dc=owncloud,dc=com'
+export REVA_LDAP_PORT=9126
+export REVA_LDAP_BASE_DN='dc=example,dc=org'
 export REVA_LDAP_USERFILTER='(&(objectclass=posixAccount)(cn=%s))'
 export REVA_LDAP_GROUPFILTER='(&(objectclass=posixGroup)(cn=%s))'
-export REVA_LDAP_BIND_DN='cn=admin,dc=owncloud,dc=com'
-export REVA_LDAP_BIND_PASSWORD=admin
+export REVA_LDAP_BIND_DN='cn=reva,ou=sysusers,dc=example,dc=org'
+export REVA_LDAP_BIND_PASSWORD=reva
 export REVA_LDAP_SCHEMA_UID=uid
 export REVA_LDAP_SCHEMA_MAIL=mail
-export REVA_LDAP_SCHEMA_DISPLAYNAME=displayName
+export REVA_LDAP_SCHEMA_DISPLAYNAME=sn
 export REVA_LDAP_SCHEMA_CN=cn
 ```