Code source wiki de Accueil Hypercerts
Version 21.1 par Matthieu Manginot le 22/07/2020 - 16:32
Masquer les derniers auteurs
| author | version | line-number | content |
|---|---|---|---|
 |
4.1 | 1 | Vous cherchez à délivrer aux étudiants de votre université des attestations de réussite dématérialisées ? Hypercerts vous permettera de générer et envoyer des attestations officielles, numériques, et infalsifiable. |
| |
1.1 | 2 | |
| |
4.1 | 3 | Ces dernières pourront être envoyées par mail, déposées dans le nuage, et même être certifiées authentiques et intègres grâce à une blockchain dédiée. |
| |
1.1 | 4 | |
| |
4.1 | 5 | Une fois l'application connectée à Apogée et au LDAP, les gestionnaires de composantes pourront demander la génération et l'envoi des attestations de réussite en un clic. |
| 6 | |||
| |
3.1 | 7 | {{info}} |
| |
9.1 | 8 | La version 1.0.x est une beta. Bien que le cœur de l'application soit fonctionnel, les dépôts de documents dans les coffres digisposte et la certification cryptographique sont en cours de dévelopement actif. |
| |
3.1 | 9 | {{/info}} |
| |
1.1 | 10 | |
| |
7.1 | 11 | == Prérequis == |
| |
3.1 | 12 | |
| |
5.1 | 13 | Hypercerts est une application Java qui se connecte à Apogée et au LDAP. Elle requiert l'utilisation d'une base MariaDB pour son fonctionnement interne. Elle se déploie sur des serveurs comme une application SpringBoot classique. Le WAR pourra être pris en charge par un tomcat et servir les utilisateur•ices via l'URL configuré. |
| |
3.1 | 14 | |
| |
2.1 | 15 | |=((( |
| |
3.1 | 16 | Technologie |
| |
2.1 | 17 | )))|=((( |
| |
3.1 | 18 | Version |
| |
2.1 | 19 | ))) |
| 20 | |((( | ||
| |
3.1 | 21 | JDK |
| |
2.1 | 22 | )))|((( |
| |
3.1 | 23 | 11+ |
| |
2.1 | 24 | ))) |
| |
3.1 | 25 | |(% colspan="1" %)((( |
| 26 | SpringBoot | ||
| 27 | )))|(% colspan="1" %)((( | ||
| 28 | 2.3 | ||
| 29 | ))) | ||
| 30 | |(% colspan="1" %)((( | ||
| 31 | Vaadin (Frontend) | ||
| 32 | )))|(% colspan="1" %)((( | ||
| 33 | 14 | ||
| 34 | ))) | ||
| |
2.1 | 35 | |((( |
| |
3.1 | 36 | Tomcat |
| |
2.1 | 37 | )))|((( |
| |
3.1 | 38 | 9+ |
| 39 | ))) | ||
| 40 | |(% colspan="1" %)((( | ||
| 41 | MariaDB | ||
| 42 | )))|(% colspan="1" %)((( | ||
| 43 | 14+ | ||
| 44 | ))) | ||
| 45 | |(% colspan="1" %)((( | ||
| 46 | Maven | ||
| 47 | )))|(% colspan="1" %)((( | ||
| 48 | 3.6+ | ||
| 49 | ))) | ||
| 50 | |(% colspan="1" %)((( | ||
| 51 | Connection Apogée | ||
| 52 | )))|(% colspan="1" %)((( | ||
| |
2.1 | 53 | \\ |
| 54 | ))) | ||
| |
3.1 | 55 | |(% colspan="1" %)((( |
| 56 | Connection Apogée via WS | ||
| 57 | )))|(% colspan="1" %)((( | ||
| |
2.1 | 58 | \\ |
| |
3.1 | 59 | ))) |
| 60 | |(% colspan="1" %)((( | ||
| 61 | Connection LDAP | ||
| 62 | )))|(% colspan="1" %)((( | ||
| |
2.1 | 63 | \\ |
| 64 | ))) | ||
| |
3.1 | 65 | |(% colspan="1" %)((( |
| 66 | Docker (optionnel) | ||
| 67 | )))|(% colspan="1" %)((( | ||
| 68 | docker-compose 3 | ||
| 69 | ))) | ||
| |
1.1 | 70 | |
| |
4.1 | 71 | == Téléchargement des sources == |
| 72 | |||
| 73 | Provisoirement, les sources de l'application peuvent être téléchargées à [[cet endroit>>url:http://download-sig.univ-lorraine.fr/home/download-sig/public/hypercerts||shape="rect"]]. | ||
| 74 | |||
| |
2.1 | 75 | == Personalisation d'Hypercerts == |
| 76 | |||
| |
12.1 | 77 | === Configuration l'application === |
| |
4.1 | 78 | |
| |
10.1 | 79 | Créer et compléter un fichier **application.yaml** à la racine du projet sur le modèle de **application-sample.yaml** |
| 80 | |||
| |
19.1 | 81 | === **Éléments de configuration important ** === |
| 82 | |||
| 83 | ==== Property //app.production// ==== | ||
| 84 | |||
| 85 | Pour les tests, mettre **app.production** à false pour obtenir une année supplémentaire (N-2) pour la génération, ainsi des diplômes avec résultats seront plus facilement trouvables. | ||
| 86 | |||
| 87 | En étant à false, cette property autorise également l'interception de tout les mails applicatifs. | ||
| 88 | |||
| 89 | ==== **Envoi de mail** ==== | ||
| 90 | |||
| |
15.1 | 91 | (% style="color: rgb(0,51,102);" %)__**Sur votre environnement de test/développement**, pour empêcher l'envoi de mails de test en réel, il est conseillé :__ |
| |
11.1 | 92 | |
| 93 | * d'utiliser un mail catcher ([[https:~~/~~/mailcatcher.me/>>url:https://mailcatcher.me/||shape="rect"]]) en remplacement de votre smtp | ||
| 94 | * ou de configurer l'application pour intercepter tout les mails applicatifs avec ces valeurs : | ||
| 95 | ** **app.production** à false | ||
| 96 | ** **spring.mail.intercept.active** à true | ||
| 97 | ** et **spring.mail.intercept.mails** contenant une ou plusieurs adresses de réception des mails | ||
| 98 | |||
| |
20.1 | 99 | ==== WebServices Apogée ==== |
| 100 | |||
| |
21.1 | 101 | {{status colour="Yellow" title="TODO"/}} |
| |
20.1 | 102 | |
| |
12.1 | 103 | === Configurer et lancer le projet dans Eclipse === |
| 104 | |||
| 105 | * Importer le projet Maven dans eclipse. | ||
| |
19.1 | 106 | * Lorsque la configuration est terminée, démarrer l'application en faisant un clic droit sur {{code language="none"}}fr.univlorraine.hypercerts.Application.java{{/code}} et en choisissant 'Run As / Java Application'. |
| |
12.1 | 107 | |
| |
14.1 | 108 | === Customisation des services === |
| 109 | |||
| |
18.1 | 110 | Plusieurs services sont personnalisables en fonction de votre environnement. |
| |
14.1 | 111 | |
| |
17.1 | 112 | Sous fr.univlorraine.hypercerts.apogee.service.customs : |
| |
16.1 | 113 | |
| |
17.1 | 114 | * ApogeeUserServiceCustomExample |
| |
18.1 | 115 | ** Personnalisation de la récupération des adresses mails des utilisateurs Apogée à partir de l'uid LDAP |
| |
17.1 | 116 | * BlocageServiceCustomExample |
| |
18.1 | 117 | ** Personnalisation de la récupération des blocages/interdits à partir d'un code étudiant Apogée |
| |
17.1 | 118 | * ComposanteServiceCustomExample |
| |
18.1 | 119 | ** Personnalisation de la récupération : |
| 120 | *** de toutes les composantes | ||
| 121 | *** des composantes pour un utilisateur à partir de l'uid LDAP | ||
| 122 | *** du nombre de composantes pour un utilisateur à partir de l'uid LDAP | ||
| |
16.1 | 123 | |
| |
21.1 | 124 | {{status colour="Yellow" title="TODO"/}} |
| 125 | |||
| |
17.1 | 126 | === Customisation de Digiposte === |
| 127 | |||
| 128 | //Documentation à venir.// | ||
| 129 | |||
| |
12.1 | 130 | === Tâches Maven === |
| 131 | |||
| 132 | * Lancer l'application (hors d'un IDE) : | ||
| 133 | |||
| 134 | {{code language="bash" theme="Eclipse"}} | ||
| 135 | mvn spring-boot:run | ||
| 136 | {{/code}} | ||
| 137 | |||
| 138 | * Lancer les tests : | ||
| 139 | |||
| 140 | {{code language="bash" theme="Eclipse"}} | ||
| 141 | mvn verify | ||
| 142 | {{/code}} | ||
| 143 | |||
| 144 | * Créer le package pour production : | ||
| 145 | |||
| 146 | {{code language="bash" theme="Eclipse"}} | ||
| 147 | mvn clean package -Pproduction | ||
| 148 | {{/code}} | ||
| 149 | |||
| |
13.1 | 150 | === Makefile === |
| 151 | |||
| 152 | Un Makefile est également disponible. A la racine, utilisez `make help` pour obtenir les commandes disponibles. | ||
| 153 | |||
| |
14.1 | 154 | == Tests unitaires == |
| |
4.1 | 155 | |
| |
13.1 | 156 | Pour s'assurez que les résultats d'admission de vos étudiants soient bien correct, et afin d'éviter les faux positifs (donc envoyer une attestation de réussite à un•e étudiant•e non reçu•e aux examens), vous pouvez ajouter vos jeux de données |
| |
4.1 | 157 | |
| |
14.1 | 158 | {{status colour="Red" title="FONCTIONNEMENT A PRECISER"/}} |
| 159 | |||
| |
5.1 | 160 | == Mise en service de l'application == |
| |
2.1 | 161 | |
| |
4.1 | 162 | \\ |
| 163 | |||
| |
1.1 | 164 | {{section}} |
| 165 | {{column width="60%"}} | ||
| 166 | {{recently-updated/}} | ||
| 167 | {{/column}} | ||
| 168 | |||
| |
2.1 | 169 | {{column width="5%"}} |
| 170 | \\ | ||
| 171 | {{/column}} | ||
| |
1.1 | 172 | |
| 173 | {{column width="35%"}} | ||
| 174 | ====== Navigate space ====== | ||
| 175 | |||
| 176 | {{locationSearch reference="WebHome"/}} | ||
| 177 | |||
| 178 | {{pagetree/}} | ||
| 179 | {{/column}} | ||
| 180 | {{/section}} |