From 353c27836c6c7f615ecf09ebdfaa7dbd90d6a312 Mon Sep 17 00:00:00 2001
From: Benjamin Dauvergne <bdauvergne@entrouvert.com>
Date: Fri, 8 Feb 2013 23:26:48 +0100
Subject: [PATCH] README: complete section on settings

---
 README | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 79 insertions(+), 1 deletion(-)

diff --git a/README b/README
index ead8a53..42964a1 100644
--- a/README
+++ b/README
@@ -51,4 +51,82 @@ Le fichier de configuration est dans /etc/polynum/local_settings.py
 
 Après tout changement il faut le relancer par
 
- /etc/init.d/polynum restart
+   /etc/init.d/polynum restart
+
+
+LDAP_URL
+LDAP_BIND_DN
+LDAP_BIND_PASSWORD
+LDAP_BASE
+LDAP_USER_QUERY ex.: 'supannAliasLogin=%s'
+
+    Configuration de la connection LDAP pour les connexions CAS
+
+MINIMUM_DELIVERY_DELAY:
+
+    Le temps minimum entre le dépôt d'une demande et sa date de livraison, par
+    défaut 2.
+
+MAXIMUM_DAYS_BEFORE_PURGE:
+
+    Le temps maximum avant la purge d'une demande, par défaut 545 jours.
+
+
+LDAP_COMPLETION_QUERY_FILTER:
+
+    template pour filtre LDAP les variabes '{0}' sont remplacés par les mots à
+    rechercher, ex.:
+
+        '(|(supannAliasLogin=*{0}*)(displayName=*{0}*))'
+
+    ce qui donne pour la recherche "john doe" le filtre suivant:
+
+        (|(supannAliasLogin=*john*doe*)(displayName=*john*doe*))
+
+LDAP_COMPLETION_QUERY_ATTRIBUTES:
+
+    La liste des attributs à récupérer, par défaut:
+
+        [ 'displayName', 'givenName', 'sn', 'updLogin', 'supannAliasLogin' ])
+
+LDAP_COMPLETION_QUERY_TEMPLATE =
+
+    Le template pour la construction du template de complétion, par défaut:
+
+    u'{displayName} ({updLogin})'
+
+OAI_ADMIN_EMAIL
+
+    Adresse email à place dans le flux OAI-PMH
+
+OAI_TEXT
+
+    Identification du système pour le flux OAI-PMH
+
+OAI_REPOSITORY_NAME
+
+    Identification du dépôt pour le flux OAI-PMH
+
+PAGINATE_BY:
+
+    Nombre de requête par page pour la pagination des résultats, par défaut 50.
+
+MAX_DOCUMENT_SIZE:
+
+    Taille maximum des documents, par défaut 50Mo.
+
+ENTITY_ROOT_DEPTH:
+
+    Niveau minimum de l'arbre des entités à présenter
+
+MIN_ENTITY_FILTER_DEPTH
+
+    Niveau minimum des entités pour permettre un filtrage
+
+MAX_ENTITY_FILTER_DEPTH
+
+    Niveau maximum des entités pour permettre un filtrage
+
+USE_PDF_VIEWER
+
+    Utiliser la visionneuse de PDF, par défaut False.