]> nos-oignons.net Git - gestion-adh.git/blobdiff - README
Correction ('reçu' ou 'récépissé' se dit 'receipt' en anglais, et non
[gestion-adh.git] / README
diff --git a/README b/README
index 0aafd0a4a48bda823599b97bdf8e1780dc44d3b1..f0eb47eedbe4db5618f1e781ff4acf7c1ba608f2 100644 (file)
--- a/README
+++ b/README
@@ -109,6 +109,33 @@ Le fichier utiliser pour garder la liste des envois déjà effectués est soit
 celui indiqué par la variable d'environnement `NOS_OIGNONS_REMINDER_DB`, ou
 le fichier si elle est vide `var/reminders.yaml`.
 
+`send-member-emails-to-advisors`
+--------------------------------
+
+Envoie la liste des emails des membres à jour de cotisation au comité
+de déontologie.
+
+Ce script a vocation a être executé tous les mois afin que le comité
+puisse convoquer une assemblée générale extraordinaire, même en cas de
+défaillance du conseil d'administration.
+
+`create-membership-fee-receipt`
+-------------------------------
+
+Permet de créer un reçu de cotisation pour les membres en faisant
+la demande.
+
+Exemple d'utilisation :
+
+    bin/create-membership-fee-receipt 000042 10,00
+
+Cela crééra un reçu pour le membre 000042 pour une cotisation d'un
+montant de 10,00€. Le reçu est généré sous forme d'un fichier PDF dans
+le répertoire spécifié par la variable d'environnement NOS_OIGNONS_RECEIPTS_DIR
+(ou le répertoire `receipts` dans le répertoire courant).
+
+Il faut créer le répertoire avant utilisation s'il n'existe pas déjà.
+
 Développement
 =============
 
@@ -135,9 +162,56 @@ Installer les dépendences :
     ruby1.9.1 /usr/bin/bundle install --deployment \
                                       --without=development \
                                       --path=vendor/bundle
+    chmod -R o+rX vendor/bundle
+
+Il faut donner les droits d'écriture à `wiki-ca` sur le répertoire `var`.
+
+Pour rendre facilement accessible `list-members-emails`, on peut ajouter dans
+`/usr/local/bin` un mini script tel que celui-ci :
+
+    #!/bin/sh
+    NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src \
+        /srv/ikiwiki/wiki-ca/gestion-adh/bin/list-emails
+
+Ne pas oublier de le rendre exécutable.
+
+Pour permettre au script `update-ag-subscribers` de fonctionner, il est
+nécessaire de l'autoriser à exécuter certaines commandes de Mailman.
+Pour cela, on va créer un fichier dans `/etc/sudoers.d` :
+
+    Defaults:wiki-ca !requiretty
+
+    Cmnd_Alias AG_MANAGEMENT = /usr/sbin/list_members ag,\
+                               /usr/sbin/add_members -r - ag,\
+                               /usr/sbin/remove_members -f - ag
+
+    wiki-ca ALL = (list) NOPASSWD: AG_MANAGEMENT
+
+Ensuite, pour exécuter régulièrement les scripts via le *crontab* du compte
+`wiki-ca`, il faut y ajouter :
+
+    42 * * * * BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/update-ag-subscribers
+    42 6 * * * BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/send-membership-reminders
+    21 0 1 * * BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/send-member-emails-to-advisors
+
+Pour installer le `pre-commit` *hook* sur le dépôt utilisé par
+Ikiwiki, on met dans `/srv/ikiwiki/wiki-ca/src/.git/hooks/pre-commit` :
+
+    if ! BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/pre-commit-hook; then
+            # Reset changes that do not pass the pre-commit hook to prevent
+            # wrong changes to lay in the Ikiwiki source directory.
+            git reset --hard
+            exit 1
+    fi
+
+Ne pas oublier de le rendre exécutable.
+
+Pour installer le `pre-receive` *hook* sur le dépôt central, on met dans
+`/srv/git/.gitolite/hooks/wiki-ca/hooks/pre-receive` :
+
+    #!/bin/sh
+    BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/pre-receive-hook
 
-Il faut ensuite mettre en place le lien symbolique vers le script
-`pre-receive-hooks`. XXX: à détailler
+Ne pas oublier de le rendre exécutable. Il faut ensuite faire un lien symbolique :
 
-XXX: configuration sudoers
-XXX: crontab pour update-ag-subscribers
+    ln -s ../../../.gitolite/hooks/wiki-ca/pre-receive /srv/git/repositories/wiki-ca.git/hooks/pre-receive