This repository has been archived on 2023-02-21. You can view files and clone it, but cannot push or open issues or pull requests.
polynum/README

141 lines
3.3 KiB
Plaintext

Polycopiés numériques, projet UPD+UNPIdF
Installation
------------
Avec PostgreSQL:
$ createdb polynum
$ echo "DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': 'polynum' }}" >local_settings.py
Configure the following keys in your local_settings.py:
CAS_SERVER_URL - the CAS server URL
LDAP_URL - the LDAP server URL
LDAP_BIND_DN - the DN to authenticate to the LDAP server
LDAP_BIND_PASSWORD - the password
LDAP_USER_QUERY - the query to retrieve user, use %s as a placeholder for the CAS username
LDAP_BASE - the base DN for the query
$ ./manage.py syncdb
Index
-----
Certaines requêtes nécessitent des index pour êtres performantes, n'oubliez pas
des créer à l'aide des commandes suivantes.
Avec SQLite::
python manage.py sqlindexes | sqlite3 polynum.db
Avec PostgreSQL:
python manage.py sqlindexes | psql <db_name>
Logs
----
Les logs sont envoyés vers le syslog local via /dev/log avec pour nom de
service local0. Les logs de niveau debug ne sont envoyés que si l'option DEBUG
est à True dans votre fichier local_settings.py.
Pour récupérer ces logs dans un fichier à part vous pouvez ajouter la
ligne suivante dans le fichier de configuration du démon syslog local.::
local0.* -/var/log/polynum.log
Configuration
-------------
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
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.
Environment
-----------
FORCE_SOUTH
If this variable is defined in the environment, you can use south with
sqlite.