Documentation pour administrateur Application AER Etape 1 - Déploiement de l application 1.1. Préliminaires L application AER est déployée sur une machine VPS (Virtual Private Server). Il s agit d un serveur privé virtuel que l on doit soi-même gérer. L url du serveur est http://vps56080.ovh.net/ Un serveur est un ordinateur comme un autre et doit posséder un système d exploitation. Celui que nous avons choisi est Debian 7 (Wheezy) pour sa stabilité et sa sécurité. L avantage de Debian est que les mises à jour sont peu fréquentes et que quasiment aucune d entre elles ne nécessite un redémarrage du serveur. Ensuite, l application AER utilise comme support Play! 2.2.2. (voyez ceci comme une alternative à Apache). http://www.playframework.com/ Ce genre de framework suit le modèle MVC : Models, Views, Controllers. - Models : Gère la base de données. - Views* : Gère l affichage des pages HTML - Controllers : Gère le comportement du serveur en réponses aux requêtes du client *Si jamais vous voulez modifier du texte, cherchez le texte dans views. Et vous pouvez éditer un fichier.scala.html (avec par exemple NotePad++ http://notepad-plus-plus.org/). Vous devez établir une connexion avec le serveur afin de le contrôler à distance. Pour cela, utilisez le logiciel sous Windows suivant : Bitvise SSH Client http://www.bitvise.com/ssh-clientdownload. Une fois le logiciel installé et lancé, voici ce que vous pouvez voir : Assurez-vous que les informations que vous entrez sont celles qui sont sur cette capture d écran. Le mot de passe est le mot de passe fourni par OVH lors de l installation de Debian sur le serveur VPS. Une fois toutes les informations entrées, cliquez sur Login. 1
Deux fenêtres s ouvrent : Parlons déjà de la première que nous appellerons «Terminal». C est ici que vous pouvez administrez le serveur en entrant des commandes. En fait, ce terminal est exactement ce que le serveur afficherait si on avait branché un écran dessus et qu on était devant lui. Si l application est déjà installée sur le serveur, vous pouvez sauter 1.2. 1.2. Installation de l application sur le serveur 1.2.1. Installation des logiciels Le serveur est une distribution de Debian qui ne possède que le strict minimum pour fonctionner (un serveur n a pas besoin de faire autre chose que sa tâche de serveur contrairement à votre ordinateur personnel). Vous devez installer les logiciels dont vous avez besoin. Pour ceci, entrez la commande suivante : apt-get install openjdk-7-jdk mysql-server-5.5 unzip git Ceci installe 4 logiciels : - openjdk-7-jdk Java, car l application fonctionne en Java. - mysql-server-5.5 Le serveur mysql, car on utilise une base mysql - unzip Pour décompresser une archive.zip - git Pour récupérer le code source de l application AER La console va alors afficher des messages, s il vous demande confirmation, taper y pour «yes» et l installation commence. Vous devez définir un mot de passe pour la base mysql. Choisissez-un en. 1.2.2. Configuration de MySQL (base de données) Maintenant, vous devez configurer mysql. Pour ceci, entrez la commande suivante : 2
mysql u root p On vous demande le mot de passe root de mysql. Entrez celui que vous avez choisi. Maintenant, un petit mysql> est apparu dans le terminal. Vous pouvez écrire des requêtes mysql. Exécutez (en tapant) les commandes suivantes : > CREATE DATABASE aer; > CREATE USER aer IDENTIFIED BY motdepasse ; > GRANT ALL PRIVILEGES ON aer.* TO aer @ localost INDENTIFIED BY motdepasse ; > source /root/backup.sql La 1ère commande crée la base AER. La 2ème et la 3ème permettre à l application de se connecter à la base. motdepasse correspond au mot de passe que vous choisissez pour que l application AER accède à la base de données. La 4ème remplie la base de données avec le contenu du fichier backup.sql, qui est un fichier back-up de la base. 1.2.3. Installation de Play! 2.2.2. Dans le terminal, exécutez les commandes suivantes : wget http://downloads.typesafe.com/play/2.2.2/play-2.2.2.zip unzip play-2.2.2.zip ln s play-2.2.2/play /usr/bin/local La première commande télécharge Play!. Vous pourrez voir la barre de progression du téléchargement. La deuxième décompresse l archive téléchargée. La troisième permet d exécuter play. Play! est maintenant installé et prêt à l emploi. 1.2.4. Lancement de l application Vous devez télécharger le code source de l application pour ceci, faites la commande suivante : Git clone https://github.com/siriusxiv/aer Puis, il faut éditer les fichiers de configuration : cd AER nano conf/application.conf Ici, vous gérer la configuration de l application. Vous pouvez naviguez avec les flèches directionnelles. Vous devez indiquer le mot de passe : Editer la ligne #db.default.password= pour qu elle devienne : 3
db.default.password=motdepasse Ensuite, s il y a un # devant la ligne «evolutionplugin=disabled», enlevez-le. Ensuite éditez les lignes à partir de «domain.name» pour qu elles deviennent ceci : # Domain name of the app domain.name="http://vps56080.ovh.net" # Endroit où sont stockées les images image.path="/root/img/" # Endroit où sont stockées les fichiers.xls générés xls_generes.path="/root/xls/" # Emailer ( https://github.com/typesafehub/play-plugins/t smtp.host=ssl0.ovh.net #smtp.port= smtp.ssl=yes smtp.tls=no smtp.user=" " smtp.password=" " smtp.from=" " Appuyez sur Ctrl+O puis sur Entrée pour sauvegarder les changements. Maintenant, faites la commande suivante : play start 80 Des messages s affichent. Si tout se déroule bien, cela se termine à la fin par «Listening for HTTP on /0:0:0:0:0:0:0:0:80». Vous pouvez dès lors accéder à l application via n importe quel navigateur. Vous n avez plus qu à appuyer sur Ctrl+D et à fermer le terminal, c est terminé! 1.3. Back-up de la base Là, on utilisera un peu la deuxième fenêtre. Cette fenêtre vous permet de voir les fichiers sur le serveur et de les télécharger sur votre ordinateur et inversement. Déjà, dans le terminal, écrivez la commande suivante : mysqldump aer u root p > backup.sql Ecrivez le mot de passe root de mysql. Ceci sauvegardera toute la base dans le fichier «backup.sql». Pour récupérer le fichier back-up, utilisez l autre fenêtre. Au besoin, cliquez sur Remote -> Refresh pour rafraîchir la liste des fichiers sur le serveur, à droite. Faites clic droit sur «backup.sql» et choisissez «Download». Il sera téléchargé dans le dossier courant de votre ordinateur (à gauche). Conservez le fichier back-up précieusement. Pour remettre le fichier backup.sql sur le serveur, il suffit de le glisser déplacer sur la partie droite de la fenêtre. Maintenant, supposons qu il arrive malheur à la base. Pour repopuler la base de données, il suffit de lancer le script backup.sql. Pour cela, reportez-vous à la fin de la partie 1.2.2. 4
5
Etape 2 Utilisation de l application L admin a pour fonction d assigner les experts, de gérer les groupes et sous-groupes d espèces, et de modérer les demandes d inscriptions. 2.1. Assigner des experts Page très simple : vous avez la liste des groupes et vous indiquer en face de chaque groupe qui sont les expert. «Rétrograder expert» enlève le statut d expert à un membre dans le groupe donné. «Ajouter un autre expert» ajoute un autre expert. Le rôle d un expert est de modérer les témoignages qui sont dans son domaine d expertise. 2.2. Gérer les groupes et les sous-groupes Un groupe est subdivisé en sous-groupe. Les sousgroupes sont un ensemble d espèces qui pour une raison qu un expert défend, sont mises ensemble. Un groupe contient forcément au moins un sousgroupe et une espèce appartient à strictement un sous-groupe. Dans l application, il est intrinsèquement impossible de faire appartenir une espèce à plusieurs sous-groupes. Une espèce doit posséder un sous-groupe, sous peine de n avoir aucune existence aux yeux des experts (et aussi de faire planter l application par endroits). D ailleurs, si une espèce est sans sous-groupe, l application vous le précisera avec un message d erreur sur cette page, vous exhortant à la mettre dans un sous-groupe. Si vous voulez ajouter un groupe, cliquez sur «Créer un nouveau groupe». Ensuite, vous devez créer au moins un sous-groupe pour ce groupe. Cliquez sur «Créer un nouveau sous-groupe». Vous pouvez ajouter autant de sous-groupes que vous le souhaitez. «Suppr» supprime définitivement un groupe. À utiliser avec modération Si vous cliquez sur un petit triangle, un menu déroulant apparaît. «Déplacer» permet de déplacer un sous-groupe dans un autre groupe. (Du coup, la juridiction des espèces dans ce sous-groupe changera d expert) «Suppr» supprime le sous-groupe. Encore une fois, à utiliser avec modération, car toutes les informations relatives au sous-groupe seront 6
supprimées (dates charnières et les droits d expert de l expert en ce groupe). Vous pouvez renommer un groupe comme un sous-groupe en double-cliquant sur son nom, puis après avoir entré le nouveau nom, pressez «Entrée». «Détail» ouvre une nouvelle fenêtre et permet de choisir les espèces dans ce sous-groupe. Cette fenêtre affiche la liste des ordres, super-familles, familles, sous-familles et espèces inclues dans ce sous-groupe. Dans le cas présent, le sous-groupe Caelifera contient les super-familles Tetrigoidea et Acridoidea. Avec le bouton «Ajouter», vous pouvez ajouter un ordre, une super-famille, une famille, une sousfamille ou une espèce dans le sous-groupe. Sous vous ajouter un ordre, toutes les espèces dans cet ordre rentreront dans le sous-groupe. De même pour super-famille, famille et sous-famille. Le liste déroulante au-dessus de «Ajouter» ne contient que les éléments ajoutables! Normalement, toutes les espèces possèdent un sous-groupe donc il n y a aucun élément ajoutable. Un élément n est pas ajoutable lorsque son ajout permettrait à une espèce d être dans deux sous-groupes différents. Ce qu on peut conclure, c est qu on final, vous n utiliserez cette page que si vous ajoutez des nouvelles espèces ou des nouveaux groupes. Si un expert en arachnide se manifeste, vous devrez commencer par créer les nouveaux ordres, super-familles, familles, sous-familles, espèces dans la page adéquate (Cf. 2.3. Gérer la liste des espèces). Après quoi, vous collerez une étiquette de sousgroupe à chacune de ses espèces. 2.3. Gérer la liste des espèces C est ici qu on s occupe des ajouts, suppressions d espèces, sous-familles, familles, super-familles, ordres, ainsi que du renommage, etc. En haut de la page se trouvent les options pour ajouter ou supprimer des espèces. Cela sera utile si d'autres experts se joignent à l'aer ou si de nouvelles espèces sont découvertes. Pour rajouter une espèce il faut connaître sa sous-famille, pour rajouter une sous-famille il faut connaître sa famille, et 7
ainsi de suite, donc en cas d'ajouts importants, il faut commencer par les ordres, puis les superfamilles, etc. Cette partie de la page indique aussi s'il y a des sous-familles, familles, super-familles ou ordres vides d'espèce, et permet de les supprimer si c'est le cas. C'est le seul moyen de supprimer ces regroupements d'espèces. Du coup, pour supprimer une famille, il faut d'abord la vider de ses espèces. NB : Supprimer un ordre vide d'espèces supprime également toutes les sous-familles, familles et super-familles qu'il contient (qui sont, par extension, vide). 8
Pour ajouter une espèce, après avoir cliqué sur "Ajouter une espèce", il faut remplir les champs demandés. On remarquera un choix entre "A une sous-famille" et "Pas de sous-famille", choix que l'on retrouve pour l'ajout des familles. Comme toutes les espèces n'ont pas de sous-famille, il est nécessaire de choisir un des deux boutons, ce qui change la liste qui apparaît juste après (liste des sous-familles ou des familles). On ne peut pas encore rajouter de synonyme à cet étape de l'ajout (cela viendra plus tard dans cette page). En-dessous de tous les boutons pour ajouter, se trouve la liste des espèces. Cette liste est toujours triée par ordre systématique, cependant des filtres peuvent être placés en fonction des sous-familles, familles, super-familles, ordres, sous-groupes et groupes grâce aux liste déroulantes en haut du tableau. Lorsque l'on travaille sur une espèce il est fortement conseillé de la cibler le plus précisément possible (en fonction de sa sous-famille ou famille si possible) afin d'éviter de ralentir son ordinateur. Les listes déroulantes sont classées par ordre alphabétique. Passons à présent à l'autre fonction de la page : la modification de données sur les espèces, sousfamilles, familles, super-familles et ordres. En cliquant sur une espèce, un autre tableau s'ouvre sous cette espèce et nous permet de modifier les informations sur cette espèce. Pour le nom, l'auteur et les commentaires, il suffit de double-cliquer pour faire apparaître un champ permettant de changer ces valeurs. L'appui sur la touche Entrée du clavier valide le changement. On peut également changer la sous-famille (ou la famille) d'une espèce, voire faire en sorte qu'elle n'ait plus qu'une famille (le bouton du bas "Cliquez ici" ou "Retour" permet de basculer la liste entre liste des familles et liste des sous-familles ou l'inverse). Enfin, c'est ici qu'on peut rajouter des synonymes 9
et les supprimer (croix rouge en-dessous des synonymes). Les synonymes d'origine AER sont en rouge. De même manière, en cliquant sur les sous-familles, familles, super-familles et ordres, on peut changer les informations qui leurs sont liées. NB : il est important de noter que pour les changements de nom, d'auteur ou de commentaires la page ne se recharge pas toute seule, et donc ne se met à jour qu'une fois rechargée (le champ modifié indique cependant le changement). On peut aussi supprimer l'espèce avec le bouton "! SUPPRIMER!" en bas du mini-tableau de l'espèce, mais pour éviter de détruire les témoignages liés à cette espèce cela n'est possible que si cette espèce n'a pas de témoignages. Un message d'alerte s'ouvre quand même, le même que pour les autres suppressions. Supprimer une espèce change le numéro systématique de celles qui suivent, le baissant de un (de la même manière, en ajouter une les fait se décaler). Cette page a surtout pour but d'ajouter et de supprimer des espèces, et il est plus que conseillé d'utiliser la page de modifications des espèces des Experts, qui gère moins d'informations dans la base de données et qui est donc plus rapide. 2.4. Demandes d inscription Cette page a deux parties et sert à deux choses : - Accepter ou refuser l inscription d un témoin. Quand un témoin s inscrit, l admin reçoit une notification par mail. - Permettre à un témoin déjà dans la base de se connecter. Dans le deuxième cas, l admin doit entrer le nom du témoin et son adresse mail. Cette adresse mail deviendra le login du témoin. Le témoin recevra alors un mail l invitant à choisir un mot de passe. À partir du moment où il aura choisi un mot de passe, il pourra se connecter. Petite info : une fois que vous avez cliqué sur OK, la page se recharge et vous ne voyez aucune notification, c est normal, tout s est déroulé normalement. (Explication : j ai eu la flemme de rajouter une notification) 10
2.5. Liste des membres Cette page contient la liste des témoins. Vous pouvez utiliser la fonction «Recherche», ou bien cliquer sur le haut d une colonne pour réordonner la liste. Vous pouvez éditer les informations personnelles des témoins avec le bouton «Editer». Quand vous cliquez sur «Editer», une ligne apparaît en haut de la page et vous laisser éditer ces informations. Les experts peuvent aussi faire cela, à la différence près qu ils n ont pas le champ «inscrit» de visible. Vous ne pouvez pas changer l adresse mail car c est l identifiant d un utilisateur. Il ne peut pas y avoir non plus deux témoins avec le même nom (sinon, ce serait la cacophonie pour les témoignages). 2.6. Liste des communes Cette page contient la liste des communes dans la base. La seule action que vous pouvez faire ici est changer le nom «AER» de la commune, qui est le nom qui est affiché sur les rapports. Il vous suffit pour cela de double cliquer sur le champ contenant le nom de la commune, d entrer le nouveau nom et d appuyer sur «Entrée». C est toujours le nom réel qui est utilisé pour déposer les témoignages (pour éviter les communes qui portent le même nom). 2.7. Informations personnelles Ici, vous pouvez changer vos infos personnelles. Cette page est commune à tous les gens inscrits, que cela soit l admin, les experts ou les témoins. Dans le cas de l admin (qui n est pas un témoin à proprement parler), la seule chose qui nous intéresse est le changement de l adresse e-mail de l admin (celle qui reçoit les notifications d inscription) et le changement de mot de passe. Le changement d adresse mail comme le changement de mot de passe nécessite de renseigner son mot de passe dans le champ approprié. Lorsque vous changer d adresse mail, vous recevez un mail de notification dans votre nouvelle adresse. 2.8. Se déconnecter N oubliez pas de vous déconnecter, surtout quand vous utilisez un ordinateur partagé. 11