From 0676b65bc0286e480f93e221433dbc1f3d7c2774 Mon Sep 17 00:00:00 2001
From: Will Jallet <wilson.jallet@polytechnique.edu>
Date: Sat, 13 Oct 2018 12:29:58 +0200
Subject: [PATCH] document ldap_credentials.json in README

---
 README.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d8c43fe..4d2b8b0 100644
--- a/README.md
+++ b/README.md
@@ -62,7 +62,14 @@ On peut donc le configurer via des fichiers ou des variables d'environnement.
 L'API de Sigma nécessite de se connecter au LDAP Frankiz, à la fois pour obtenir des données et pour l'authentification des utilisateurs. Cela est fait à l'aide de la librairie [ldapjs](http://ldapjs.org) pour faire les requêtes au LDAP et [passportJS](http://www.passportjs.org/) pour l'authentification.
 
 * La configuration LDAP de base se situe dans [ldap_config.json](ldap_config.json).
-* Elle est importée dans l'application depuis [src/ldap/config.js](src/ldap/config.js).
+* Les identifiants utilisés que authentifier le serveur au LDAP sont dans [ldap_credentials.json](./ldap_credentials.json). Ils prennent la forme suivante:
+```json
+{
+    "dn": "uid=<username>,ou=eleves,dc=frankiz,dc=net",
+    "passwd": "<password>"
+}
+```
+* Elle est importée dans l'application depuis [src/ldap/config.ts](src/ldap/config.ts).
 * Si la variable d'environnement `LDAP_URI` est définie, l'adresse où trouver le LDAP est remplacée.
 
 **Exemple**
-- 
GitLab