diff --git a/antora-playbook.yml b/antora-playbook.yml
index 88be8e47..0eb56e3e 100644
--- a/antora-playbook.yml
+++ b/antora-playbook.yml
@@ -32,29 +32,6 @@ asciidoc:
attributes:
icons: font
page-pagination: '@'
- appendix-caption: Annexe
- appendix-refsig: Annexe
- caution-caption: Attention
- chapter-signifier: Chapitre
- chapter-refsig: Chapitre
- example-caption: Exemple
- figure-caption: Figure
- important-caption: Important
- last-update-label: Dernière mise à jour
- listing-caption: Liste
- manname-title: Nom
- note-caption: Note
- part-signifier: Partie
- part-refsig: Partie
- preface-title: Préface
- section-refsig: Section
- table-caption: Tableau
- tip-caption: Astuce
- toc-title: Table des matières
- page-toctitle: Table des matières
- untitled-label: Sans titre
- version-label: Version
- warning-caption: Avertissement
kroki-fetch-diagram: true
safe: safe
extensions:
diff --git a/src/docs/antora.yml b/src/docs/antora.yml
index c9ba82e3..e9a24837 100644
--- a/src/docs/antora.yml
+++ b/src/docs/antora.yml
@@ -1,5 +1,32 @@
name: ROOT
-title: Documentation technique Esup-Stage
+title: Esup-Stage
prerelease: true
nav:
- modules/ROOT/nav.adoc
+- modules/doc-technique/nav.adoc
+asciidoc:
+ attributes:
+ page-pagination: '@'
+ appendix-caption: Annexe
+ appendix-refsig: Annexe
+ caution-caption: Attention
+ chapter-signifier: Chapitre
+ chapter-refsig: Chapitre
+ example-caption: Exemple@
+ figure-caption: Figure@
+ important-caption: Important
+ last-update-label: Dernière mise à jour
+ listing-caption: false
+ manname-title: Nom
+ note-caption: Note
+ part-signifier: Partie
+ part-refsig: Partie
+ preface-title: Préface
+ section-refsig: Section
+ table-caption: Tableau
+ tip-caption: Astuce
+ toc-title: Table des matières
+ page-toctitle: Table des matières
+ untitled-label: Sans titre
+ version-label: Version
+ warning-caption: Avertissement
diff --git a/src/docs/modules/ROOT/images/wiki/fe18f0b8-1f06-4c17-813e-bc8868b60c62.png b/src/docs/modules/ROOT/images/wiki/fe18f0b8-1f06-4c17-813e-bc8868b60c62.png
deleted file mode 100644
index f4f2ae36..00000000
Binary files a/src/docs/modules/ROOT/images/wiki/fe18f0b8-1f06-4c17-813e-bc8868b60c62.png and /dev/null differ
diff --git a/src/docs/modules/ROOT/nav.adoc b/src/docs/modules/ROOT/nav.adoc
index 4fabd346..98f42bf6 100644
--- a/src/docs/modules/ROOT/nav.adoc
+++ b/src/docs/modules/ROOT/nav.adoc
@@ -1,11 +1,9 @@
-* xref::index.adoc[]
-* xref::vocabulaire.adoc[]
-* xref::decisions.adoc[]
-* xref::flux.adoc[]
-* xref::archi-tech.adoc[]
-* xref::event-storming.adoc[]
-* ESUP STAGE
-** xref::wiki/index.adoc[Home]
-** xref::wiki/Prerequis.adoc[Prérequis]
-** xref::wiki/ESUP-SISCOL.adoc[ESUP-SISCOL]
-** xref::wiki/ESUP-STAGE.adoc[ESUP-STAGE]
+.Documentation d’installation
+* xref:wiki/Prerequis.adoc[]
+* xref:wiki/ESUP-SISCOL.adoc[]
+* xref:wiki/ESUP-STAGE.adoc[]
+* xref:wiki/Docaposte_Signature-electronique.adoc[]
+
+.Autres documents
+* xref:wiki/Processus-de-creation-d-un-utilisateur.adoc[]
+* xref:wiki/Gestion-des-conditions-dans-les-templates.adoc[]
diff --git a/src/docs/modules/ROOT/pages/index.adoc b/src/docs/modules/ROOT/pages/index.adoc
index 3699347d..87330a2d 100644
--- a/src/docs/modules/ROOT/pages/index.adoc
+++ b/src/docs/modules/ROOT/pages/index.adoc
@@ -1,15 +1,31 @@
-= Documentation technique Esup-Stage
+= image:https://raw.github.com/EsupPortail/esup-stage/main/logo-esup-stage.png[ESUP STAGE]
:author: Université Lorraine
:imagesdir: ../images/
-:reftext: Documentation technique
-:navtitle: Documentation technique
+:reftext: ESUP Stage
+:navtitle: ESUP Stage
+== 🎓 Gestion Moderne des Conventions de Stage pour l'Enseignement Supérieur
+
+****
+ESUP-Stage est une application web nouvelle génération conçue pour simplifier
+la gestion des stages dans les établissements d'enseignement supérieur.
****
+
ESUP-Stage est l'application qui permet aux étudiants de créer et faire signer
leur(s) convention(s) de stage. Développée dans une technologie moderne, cette
solution est prévue pour s'interconnecter avec l'annuaire LDAP des
établissements ainsi qu'Apogée dans un premier temps.
+=== 🚀 Fonctionnalités
+
+[horizontal]
+.Fonctionnalités Principales
+--
+Création de Conventions:: Processus complet de génération et de validation des conventions de stage
+Intégration Système:: Compatible avec les infrastructures universitaires existantes
+Personnalisation:: Configuration souple et adaptable via l'interface utilisateur
+--
+
* Interface utilisateur modernisée,
* facilité de configuration de l'application selon les besoins de chaque
établissement,
@@ -24,9 +40,39 @@ est au cœur des préoccupations du groupe de travail œuvrant pour le
développement et l'évolution de ESUP-Stage. Aussi arrivera prochainement la
possibilité d'interfacer via un webservice la solution ESUP-Signature ou toute
solution commerciale compatible.
-****
-== xref:vocabulaire.adoc[]
-== xref:decisions.adoc[]
-== xref:flux.adoc[]
-== xref:archi-tech.adoc[]
+=== 🔗 Interconnexions
+
+* Intégration LDAP
+* Compatibilité Apogée
+* Pégase (Développement en cours)
+
+=== 📦 Partie du Consortium
+
+Développée et maintenue dans le cadre
+du consortium https://www.esup-portail.org/catalogue-des-services[ESUP Portail]
+
+'''
+
+=== Liste des changements
+
+xref:wiki/Liste-des-changements.adoc[Suivi des changements à venir et passés] +
+La liste des changements vous permettra de suivre l'évolution des applications
+ainsi que les corrections et évolutions associées.
+
+'''
+
+=== Liens vers le code source des applications
+
+[horizontal]
+.L'application ESUP-Stage se compose de deux applications que sont :
+ESUP-Stage:: https://github.com/EsupPortail/esup-stage
+ESUP-SIscol:: https://github.com/EsupPortail/esup-siscol
+
+'''
+
+=== Liste de diffusion
+
+.https://listes.esup-portail.org/sympa/info/esup-stage
+Cette liste permet de nous faire parvenir vos retours
+et d'échanger avec les autres établissements utilisateurs de l'application.
diff --git a/src/docs/modules/ROOT/pages/wiki/Docaposte_Signature-electronique.adoc b/src/docs/modules/ROOT/pages/wiki/Docaposte_Signature-electronique.adoc
index 7843fc75..1808ed9c 100644
--- a/src/docs/modules/ROOT/pages/wiki/Docaposte_Signature-electronique.adoc
+++ b/src/docs/modules/ROOT/pages/wiki/Docaposte_Signature-electronique.adoc
@@ -9,24 +9,30 @@ Documentation d'aide à la configuration des certificats TLS gérés du process
Java sépare le magasin de certificats à utiliser en 2 catégories :
-* keystore : magasin de certificats qui contient des clés privées d'authentification ou de sécurité
-* truststore : magasin de certificats qui contient les certificats publics qui sont acceptés
+* `keystore` : magasin de certificats qui contient des clés privées d'authentification ou de sécurité
+* `truststore` : magasin de certificats qui contient les certificats publics qui sont acceptés
Ces 2 magasins sont stockés dans des fichiers de type JKS ou PKCS12
=== Edition de votre truststore
-Les applications tomcat devront accepter certains certificats pour pouvoir accepter les appels web vers d'autres services de votre SI.
+Les applications tomcat devront accepter certains certificats pour pouvoir
+accepter les appels web vers d'autres services de votre SI.
-L'application Esup-Stage aura surement besoin de se connecter à votre serveur d'authentification SSO en HTTPS (certificat TLS), il faut donc rajouter la confiance de l'Autorité Certification (AC) qui émet les certificats de votre établissement dans le truststore dédié au tomcat.
+L'application Esup-Stage aura surement besoin de se connecter à votre serveur
+d'authentification SSO en HTTPS (certificat TLS), il faut donc rajouter la
+confiance de l'Autorité Certification (AC) qui émet les certificats de votre
+établissement dans le truststore dédié au tomcat.
-Nous allons pour cela créer un fichier truststore avec la chaine de certificat de l'AC émettant les certificats de votre établissement
+Nous allons pour cela créer un fichier truststore avec la chaine de certificat
+de l'AC émettant les certificats de votre établissement
* Récupérez le fichier ca.crt de l'AC de votre établissement
-Pour l'exemple de création du truststore, nous avons pris le mot de passe 'my_password' mais ceci reste à votre libre choix.
+Pour l'exemple de création du truststore, nous avons pris le mot de passe
+"my_password" mais ceci reste à votre libre choix.
-. Découpez la chaîne des certificats publics contenu dans le fichier ca.crt**
+. Découpez la chaîne des certificats publics contenu dans le fichier `ca.crt`
+
[source,console]
----
@@ -37,7 +43,7 @@ cacrt-01
ca.crt
----
-. Créez/Importez la série des certificats issus du ca.crt dans un nouveau truststore
+. Créez/Importez la série des certificats issus du `ca.crt` dans un nouveau `truststore`
+
[source,console]
----
@@ -53,7 +59,7 @@ Certificate was added to keystore
[user@computer ~/tmp]$
----
-. Vérifiez le contenu du truststore +
+. Vérifiez le contenu du `truststore`
+
[source,console]
----
@@ -72,10 +78,12 @@ Valid from: ...
----
. Ajoutez un autre service avec son certificat public +
-Si vous avez d'autres services HTTPS n'utilisant pas le CA de votre établissement, vous pouvez importer le certificat de service externe dans votre truststore.
+Si vous avez d'autres services HTTPS n'utilisant pas le CA
+de votre établissement, vous pouvez importer le certificat de service externe
+dans votre truststore.
+
* récupérez le certificat de ce service externe
-* importez ce fichier certificat manuellement dans le truststore
+* importez ce fichier certificat manuellement dans le `truststore`
.Exemple avec l'API de test de Docaposte
. Récupérez le certificat
@@ -85,7 +93,7 @@ Si vous avez d'autres services HTTPS n'utilisant pas le CA de votre établisseme
[user@computer ~/tmp]$ openssl s_client -showcerts -connect demo-parapheur.dfast.fr:443 /dev/null|openssl x509 -outform PEM > demo-parapheur.pem
----
-. Ajout au magasin trustore
+. Ajout au magasin `trustore`
+
[source,console]
----
@@ -95,33 +103,37 @@ Certificate was added to keystore
[user@computer ~/tmp]$
----
-. Exportez votre truststore +
-Exportez ce fichier 'truststore.jks' vers votre serveur esup-stage et retenez le mot de passe de celui-ci.
+. Exportez votre `truststore` +
+Exportez ce fichier `truststore.jks` vers votre serveur esup-stage et retenez le mot de passe de celui-ci.
+
-* Reportez cette config du truststore dans la variable 'CATALINA_OPTS' de votre tomcat (voir section suivante 'Lanceur Tomcat')
-* Reportez cette config du truststore dans la config d'esup-stage, voir les propriétés 'docaposte.truststore.*' dans le fichier /etc/estage/estage.properties
+* Reportez cette config du `truststore` dans la variable `CATALINA_OPTS`
+de votre tomcat (voir section suivante link:#tomcat[Lanceur Tomcat])
+* Reportez cette config du `truststore` dans la config d'esup-stage,
+voir les propriétés `docaposte.truststore.*` dans le fichier `/etc/estage/estage.properties`
+[#tomcat]
== Lanceur Tomcat
-Le tomcat doit être lancé avec les paramètres indiquant les paramètres de chargement du truststore.
+Le tomcat doit être lancé avec les paramètres indiquant les paramètres de chargement du `truststore`.
-Votre fichier de configuration devra contenir les variables 'CATALINA_OPTS' de lancement suivante :
+Votre fichier de configuration devra contenir les variables `CATALINA_OPTS` de lancement suivante :
* `javax.net.ssl.trustStore` : chemin du fichier truststore
* `javax.net.ssl.trustStoreType` : type de magazin (JKS ou PKCS12)
-* `javax.net.ssl.trustStorePassword` : mot de passe associé à votre fichier magazin truststore
+* `javax.net.ssl.trustStorePassword` : mot de passe associé à votre fichier magasin `truststore`
-Exemple avec un apache-tomcat-9.0 packagé en Red Hat
+=== Exemple avec un `apache-tomcat-9.0` packagé en Red Hat
-* /etc/sysconfig/tomcat9.0
[source,shell]
+./etc/sysconfig/tomcat9.0
----
CATALINA_OPTS=" -Xms2048m -Xmx4096m ... -Djavax.net.ssl.trustStore=/etc/ssl/catalina.truststore -Djavax.net.ssl.trustStoreType=JKS -Djavax.net.ssl.trustStorePassword=my_password ... "
----
-Exemple à partir d'un apache-tomcat binaire récupérer sur le site [Apache Tomcat](https://tomcat.apache.org/)
-* `${CATALINA_HOME}/bin/setenv.sh` (fichier exécutable à créer si inexistant)
+=== Exemple à partir d'un apache-tomcat binaire récupérer sur le site https://tomcat.apache.org/[Apache Tomcat]
+
[source,shell]
+.+${CATALINA_HOME}+/bin/setenv.sh _(fichier exécutable à créer si inexistant)_
----
# TOMCAT > MEMOIRE
@@ -144,15 +156,18 @@ tomcat ... /usr/bin/java ... -Djavax.net.ssl.trustStore=/etc/ssl/catalina.trusts
== Module Docaposte
-Pour le module "Docaposte" intégré dans https://github.com/EsupPortail/esup-stage/[esup-stage], le service "Docaposte" via l'organisme certificateur (Certinomis, ChamberSign, ...) vous a normalement fourni un fichier avec l'extension '.p12' (au format PKCS12) nécessaire à l'authentification auprès du service.
+Pour le module "Docaposte" intégrer dans
+https://github.com/EsupPortail/esup-stage/[esup-stage], le service "Docaposte"
+via l'organisme certificateur (Certinomis, ChamberSign, ...) vous a normalement
+fourni un fichier avec l'extension '.p12' (au format PKCS12) nécessaire à
+l'authentification auprès du service.
-Tout d'abord, il faut vérifier la validité de ce fichier 'certificat.p12' qui doit contenir la clé privée d'authentification et les certificats publics associés.
+Tout d'abord, il faut vérifier la validité de ce fichier `certificat.p12` qui
+doit contenir la clé privée d'authentification et les certificats publics
+associés.
-* Vérification de la présence d'une clé privée valide dans le fichier 'certificat.p12': Pour le module "Docaposte" intégrer dans https://github.com/EsupPortail/esup-stage/[esup-stage], le service "Docaposte" via l'organisme certificateur (Certinomis, ChamberSign, ...) vous a normalement fourni un fichier avec l'extension '.p12' (au format PKCS12) nécessaire à l'authentification auprès du service.
-Tout d'abord, il faut vérifier la validité de ce fichier 'certificat.p12' qui doit contenir la clé privée d'authentification et les certificats publics associés.
-* Vérification de la présence d'une clé privée valide dans le fichier 'certificat.p12':
-+
[source,console]
+.Vérification de la présence d'une clé privée valide dans le fichier `certificat.p12`:
----
[root@server ~]# keytool -list -v -keystore /data/certificat.p12 -storepass my_password \
| grep -C 6 '^Entry type: PrivateKeyEntry' \
@@ -166,9 +181,8 @@ Valid from: Tue Nov 22 08:12:07 CET 2022 until: Thu Nov 21 08:12:07 CET 2024
[root@server ~]#
----
-* Vérification de la présence des certificats publics présents dans le fichier 'certificat.p12' :
-+
[source,console]
+.Vérification de la présence des certificats publics présents dans le fichier `certificat.p12` :
----
[root@server ~]# openssl pkcs12 -in certificat.p12 -out docaposte.crt -nodes
Enter Import Password: *****
@@ -186,9 +200,10 @@ Enter Import Password: *****
== Paramétrage dans ESUP-Stage
-=== Fichier estage.properties
+=== Fichier `estage.properties`
-Dans le fichier `/etc/estage/estage.properties` du serveur ESUP-Stage, complétez les informations suivantes :
+Dans le fichier `/etc/estage/estage.properties` du serveur ESUP-Stage,
+complétez les informations suivantes :
[source,properties]
----
@@ -208,26 +223,47 @@ docaposte.truststore.password=xxx
=== Centre de gestion
-Au niveau de chaque centre de gestion qui doit donner droit à la signature électronique, renseignez dans l'onglet Signature électronique le code du circuit de signature paramétré dans Docaposte. Pour ce faire :
+Au niveau de chaque centre de gestion qui doit donner droit
+à la signature électronique, renseignez dans l'onglet Signature électronique
+le code du circuit de signature paramétré dans Docaposte.
+.Pour ce faire :
* Rendez-vous à l'emplacement _Centre de gestion > Liste des centre de gestion_ puis sélectionnez un centre de gestion.
* Dans ce centre de gestion, rendez vous dans l'onglet _Signature électronique_.
-Dans l'_Ordre de signature_, vous pouvez changer l'ordre des signataires à l'aide de la croix multidirectionnelle qui s'affiche en survolant avec la souris le nombre précédent l'intitulé du signataire. +
-Dans cette version, il n'est possible d'utiliser que des signatures OTP. Cela signifie que chaque signataire recevra un mail ou sms l'invitant à signer électroniquement la convention. La signature automatique (signature serveur) n'est pas prise en charge.
+Dans l'_Ordre de signature_, vous pouvez changer l'ordre des signataires à
+l'aide de la croix multidirectionnelle qui s'affiche en survolant avec la souris
+le nombre précédent l'intitulé du signataire.
+
+Dans cette version, il n'est possible d'utiliser que des signatures OTP. Cela
+signifie que chaque signataire recevra un mail ou sms l'invitant à signer
+électroniquement la convention. La signature automatique (signature serveur)
+n'est pas prise en charge.
=== Contrôle des métadonnées
-Dans Fast, vous avez la possibilité de contrôler la bonne transmission des métadonnées en allant dans le répertoire
+Dans Fast, vous avez la possibilité de contrôler la bonne transmission
+des métadonnées en allant dans le répertoire
-* Preuve => Cliquez sur un document dans la rubrique "A signer(OTP) puis en bas de page vous verrez le lien "Preuve". Dans une des pages s'afficheront les métadonnées.
-* OTP => Cliquez sur un document dans la rubrique "A signer(OTP) puis en bas de page vous verrez le lien "OTP". Seront affichées toutes les métadonnées disponibles. Si l'étape de signature associée à l'OTP n'a pas encore été dépassée, vous pouvez modifier manuellement les métadonnées. Cela est utile en cas d'erreur de saisi dans ESUP-Stage.
+* Preuve => Cliquez sur un document dans la rubrique
+"A signer(OTP) puis en bas de page vous verrez le lien "Preuve".
+Dans une des pages s'afficheront les métadonnées.
+* OTP => Cliquez sur un document dans la rubrique
+"A signer(OTP) puis en bas de page vous verrez le lien "OTP".
+Seront affichées toutes les métadonnées disponibles.
+Si l'étape de signature associée à l'OTP n'a pas encore été dépassée,
+vous pouvez modifier manuellement les métadonnées.
+Cela est utile en cas d'erreur de saisi dans ESUP-Stage.
=== Certificat personnel
-Il est possible de faire signer une convention avec le certificat personnel d'un utilisateur. Pour ce faire, vous devez choisir dans le paramétrage du centre de gestion le paramètre "Signature serveur". Dans Fast, vous devez renseigner à l'étape de signature concernée le paramètre Signature.
-Exemple de paramétrage d'un centre de gestion avec un workflow incluant une signature personnel (signature de l'étudiant) :
+Il est possible de faire signer une convention avec le certificat personnel d'un
+utilisateur. Pour ce faire, vous devez choisir dans le paramétrage du centre de
+gestion le paramètre "Signature serveur". Dans Fast, vous devez renseigner à
+l'étape de signature concernée le paramètre Signature.
+
+.Exemple de paramétrage d'un centre de gestion avec un workflow incluant une signature personnel (signature de l'étudiant) :
image:wiki/001a98b2-ec5e-4a2c-b24e-b6a0911f6196.png[image]
-Même exemple de workflow avec 4 signatures OTP et une signature avec un certificat personnel du côté de Fast
+.Même exemple de workflow avec 4 signatures OTP et une signature avec un certificat personnel du côté de Fast
image:wiki/366f4814-a881-435b-9fcd-57195695b1bd.png[image]
diff --git a/src/docs/modules/ROOT/pages/wiki/ESUP-SISCOL.adoc b/src/docs/modules/ROOT/pages/wiki/ESUP-SISCOL.adoc
index aecd6f16..086939ef 100644
--- a/src/docs/modules/ROOT/pages/wiki/ESUP-SISCOL.adoc
+++ b/src/docs/modules/ROOT/pages/wiki/ESUP-SISCOL.adoc
@@ -1,28 +1,38 @@
= ESUP SISCOL
-Cette application expose à l'application ESUP-STAGE des API REST (OPEN API - Swagger). Ainsi seule ESUP SIScol fait des accès au SI de l'établissement (Annuaire LDAP et Apogée).
+Cette application expose à l'application ESUP-STAGE
+des API REST (OPEN API - Swagger).
+Ainsi seule ESUP SIScol fait des accès au SI de l'établissement
+(Annuaire LDAP et Apogée).
-[discrete]
-=== Versions
+== Versions
* APOGEE `6.4.x`
* JDK `11`, `8`
* APOGEE WS `62031` ...`62070`
-[discrete]
-=== Installation du JAR client WS-APOGEE
+== Installation du JAR client WS-APOGEE
-_Avant de commencer l'installation, il faut vous procurer le client Web service Apogée soit auprès des collègues qui déploient Apogée dans votre établissement ou directement auprès de l'AMUE. Les WebServices Apogée doivent être installés selon les préconisations de l'AMUE et fonctionnelles sinon, il n'est pas nécessaire d'aller plus loin..._
+NOTE: Avant de commencer l'installation, il faut vous procurer le client Web
+service Apogée soit auprès des collègues qui déploient Apogée dans votre
+établissement ou directement auprès de l'AMUE. Les WebServices Apogée doivent
+être installés selon les préconisations de l'AMUE et fonctionnelles sinon, il
+n'est pas nécessaire d'aller plus loin...
-*Le jar client apo-webservices-client doit correspondre au web-service Apogée installé.* Votre fichier apo-webservices-client{mettre la version}.jar doit être installé ainsi :
+****
+Le jar client apo-webservices-client doit correspondre au web-service Apogée
+installé.
+****
+
+Votre fichier `apo-webservices-client__{mettre la version}__.jar` doit être
+installé ainsi :
[source,shell]
----
-mvn install:install-file -Dfile=apo-webservices-client{mettre la version}.jar -DgroupId=gouv.education.apogee -DartifactId=apo-webservices-client -Dversion={mettre la version} -Dpackaging=jar
+mvn install:install-file -Dfile=apo-webservices-client-version.jar -DgroupId=gouv.education.apogee -DartifactId=apo-webservices-client -Dversion={mettre la version} -Dpackaging=jar
----
-[discrete]
-=== Clonage et installation
+== Clonage et installation
[source,shell]
----
@@ -30,19 +40,21 @@ cd /opt
git clone https://github.com/EsupPortail/esup-siscol.git esup-siscol
----
-Il faut ajouter la bonne dépendance vers votre numéro de version du client Apogée, ex. 62070 au lieu de "*version-ws-apogee-a-définir-ici*" dans le pom.xml.
-
[source,xml]
+.pom.xml
----
gouv.education.apogee
apo-webservices-client
- version-ws-apogee-a-définir-ici
+ x.y.z
----
+<1> Il faut ajouter la bonne dépendance
+vers votre numéro de version du client Apogée, +
+ex. `62070` au lieu de `x.y.z` dans le `pom.xml`.
+
-[discrete]
-=== Fichier de paramétrage
+== Fichier de paramétrage
Nous allons créer un répertoire où nous placerons les fichiers de configurations de l'application esup-siscol :
@@ -52,7 +64,7 @@ mkdir /etc/esup-siscol
cp /opt/esup-siscol/src/main/resources/application.yml.sample /etc/esup-siscol/application.yml
----
-.Fichier /etc/esup-siscol/application.yml
+./etc/esup-siscol/application.yml
[source,yaml]
----
spring:
@@ -151,8 +163,7 @@ Vous devez modifier en cohérence avec vos spécificités :
* la section "APOGEE" en indiquant vos URL côté serveur WebService Apogée (installé en général par les administrateurs techniques Apogée)
* la section "credential" en modifiant votre mot de passe qui devra être renseigné aussi dans le fichier de configuration de l'application ESUP-STAGE
-[discrete]
-=== Compilation et génération du WAR
+== Compilation et génération du WAR
Pour compiler le projet et générer le WAR dans le répertoire "./target/", lancez les commandes :
@@ -162,8 +173,7 @@ mvn clean compile
mvn install
----
-[discrete]
-=== Déploiement sur un serveur Tomcat :
+== Déploiement sur un serveur Tomcat :
Si vous n'avez pas déjà installé votre serveur Tomcat, vous pouvez vous aider des prérequis de cette documentation. L'application ESUP SIScol peut-être déployée sur un serveur Tomcat indépendant (même serveur ou sur un autre serveur) ou utilisé le même serveur Tomcat que l'application ESUP Stage.
diff --git a/src/docs/modules/ROOT/pages/wiki/ESUP-STAGE.adoc b/src/docs/modules/ROOT/pages/wiki/ESUP-STAGE.adoc
index f319f88d..bfac4859 100644
--- a/src/docs/modules/ROOT/pages/wiki/ESUP-STAGE.adoc
+++ b/src/docs/modules/ROOT/pages/wiki/ESUP-STAGE.adoc
@@ -1,16 +1,15 @@
= ESUP STAGE
-=== Prérequis
+== Prérequis
-Les xref:wiki/Prerequis.adoc[prérequis] sont les suivants sur votre serveur :
+.Les xref:wiki/Prerequis.adoc[prérequis] sont les suivants sur votre serveur :
+* Git
+* Java OpenJdk 11
+* Apache Maven
+* Installation Mariadb
+* Installation du projet Esup-SIscol (sur le même serveur ou sur un serveur dédié)
-. Git
-. Java OpenJdk 11
-. Apache Maven
-. Installation Mariadb
-. Installation du projet Esup-SIscol (sur le même serveur ou sur un serveur dédié)
-
-=== Clonage du projet
+== Clonage du projet
[source,shell]
----
@@ -19,9 +18,9 @@ git clone https://github.com/EsupPortail/esup-stage.git
----
[#la-base-de-donnees]
-=== La base de données
+== La base de données
-==== Création de la base et de l'utilisateur
+=== Création de la base et de l'utilisateur
[source,SQL]
----
@@ -31,18 +30,14 @@ GRANT ALL PRIVILEGES ON estage.* TO 'esupstage_user'@'%';
FLUSH PRIVILEGES;
----
-==== Import de la base pStage et passage du patch
+=== Import de la base pStage et passage du patch
-Si vous n'avez pas de base pStage a reprendre, cette partie est inutile
+TIP: Si vous n'avez pas de base pStage a reprendre, cette partie est inutile
-____
Pour importer votre base pStage d'une installation en production, vous devez réaliser un dump, ici le fichier : +
-mysql-pstage-2022-01-25-16h00.sql.gz
-____
+`mysql-pstage-2022-01-25-16h00.sql.gz`
-____
-Votre dump ne doit pas comporter de CREATE DATABASE ou USE DATABASE
-____
+CAUTION: Votre dump ne doit pas comporter de `CREATE DATABASE` ou `USE DATABASE`
Les commandes suivantes permettent d'importer votre dump (pStage) dans votre base estage (ESUP STAGE) :
@@ -52,19 +47,18 @@ zcat /opt/estage/mysql-pstage-2022-01-25-16h00.sql.gz | mysql -u esupstage_user
cat /opt/estage/src/main/resources/db/changelog/init-changelog.sql | mysql -u esupstage_user -p estage
----
-=== Modification du fichier de configuration
+== Modification du fichier de configuration
[source,shell]
----
-cd /etc
-mkdir estage
-cd estage
-cp /opt/esup-stage/etc/estage/estage-example.properties estage.properties
+mkdir -p /etc/estage
+cp /opt/esup-stage/etc/estage/estage-example.properties /etc/estage/estage.properties
----
Modifier le fichier de configuration
[source,properties]
+./etc/estage/estage.properties
----
# parametres des URLs pour l'authentication CAS
cas.url.login=https://cas.monuniv.fr/cas/login?service={service}
@@ -110,11 +104,9 @@ appli.mailer.delivery_address=user@monuniv.fr
appli.data_dir=/data_esup_stage
----
-____
-Remarque : il faut que l'utilisateur faisant tourner votre *Tomcat puisse avoir les droits en écriture sur le répertoire data_esup_stage*
-____
+NOTE: il faut que l'utilisateur faisant tourner votre *Tomcat puisse avoir les droits en écriture sur le répertoire data_esup_stage*
-=== Compilation du projet
+== Compilation du projet
[source,shell]
----
@@ -122,23 +114,22 @@ cd /opt/esup-stage
mvn -Dmaven.test.skip=true clean package
----
-=== Déploiement / Lancement de l'application
+== Déploiement / Lancement de l'application
-____
-Après la compilation, le chemin complet du fichier de déploiement est le suivant : /opt/estage/target/ROOT.war
-____
+Après la compilation, le chemin complet du fichier de déploiement est le suivant : `/opt/estage/target/ROOT.war`
-==== Déploiement TOMCAT
+=== Déploiement TOMCAT
-Cette documentation ne va pas décrire l'installation d'un Tomcat. ESUP STAGE a été déployé et testé sur une version TOMCAT 9
+NOTE: Cette documentation ne va pas décrire l'installation d'un Tomcat.
+ESUP STAGE a été déployé et testé sur une version TOMCAT 9
-Vous pouvez télécharger tomcat ici : https://tomcat.apache.org/download-90.cgi
+TIP: Vous pouvez télécharger tomcat ici : https://tomcat.apache.org/download-90.cgi
-Nous considérons par exemple le chemin du répertoire tomcat ainsi : /opt/tomcat-esup-stage
+Nous considérons par exemple le chemin du répertoire tomcat ainsi : `/opt/tomcat-esup-stage`
-Supprimer (ou déplacer une sauvegarde) votre répertoire /opt/tomcat-esup-stage/webapp/ROOT avant le déploiement
+Supprimer (ou déplacer une sauvegarde) votre répertoire `/opt/tomcat-esup-stage/webapp/ROOT` avant le déploiement
-Copier directement votre fichier /opt/estage/target/ROOT.war dans votre répertoire *webapp de tomcat*
+Copier directement votre fichier `/opt/estage/target/ROOT.war` dans votre répertoire *`webapp` de tomcat*
[source,shell]
----
@@ -152,11 +143,10 @@ On arrête le tomcat avant et on le redémarre ensuite
/opt/tomcat-esup-stage/bin/shutdown.sh
----
-Pensez à paramétrer les espaces mémoire JVM : export JAVA\_OPTS="-Xms1024m -Xmx1024m -XX:MaxPermSize=256m"
+Pensez à paramétrer les espaces mémoire JVM : `export JAVA_OPTS="-Xms1024m -Xmx1024m -XX:MaxPermSize=256m"`
Démarrage :
-
[source,shell]
----
/opt/tomcat-esup-stage/bin/startup.sh
@@ -164,14 +154,12 @@ Démarrage :
Bravo, l'installation est terminée ! Vous pouvez y accéder sur http://localhost:8080
-Lancement direct du war (ne pas utiliser : en cours de debug) java -jar /opt/estage/target/ROOT.war
+Lancement direct du `war` (ne pas utiliser : en cours de debug) `java -jar /opt/estage/target/ROOT.war`
Dans le cas de l'utilisation d'un proxy (apache proxypass par exemple) il est conseillé d'utiliser le protocole AJP.
-Exemple de configuration Apache :
-
-
[source,apacheconf]
+.Exemple de configuration Apache :
----
ServerAdmin admin@monuniv.fr
diff --git a/src/docs/modules/ROOT/pages/wiki/Gestion-des-conditions-dans-les-templates.adoc b/src/docs/modules/ROOT/pages/wiki/Gestion-des-conditions-dans-les-templates.adoc
index e1ec29a6..9058612c 100644
--- a/src/docs/modules/ROOT/pages/wiki/Gestion-des-conditions-dans-les-templates.adoc
+++ b/src/docs/modules/ROOT/pages/wiki/Gestion-des-conditions-dans-les-templates.adoc
@@ -1,6 +1,7 @@
= Gestion des conditions dans les templates
:sectnums:
:imagesdir: ../../images
+:reftext: Gestion des conditions dans les modèles (templates) de convention
Dans les modèles (templates) de convention de stage, il est possible d'afficher
les variables en fonction de conditions. Les conditions, pour fonctionner,
@@ -41,6 +42,36 @@ Cela encadre une condition. Si la condition est vraie, le contenu placé entre $
== Opérateurs logiques
-image:wiki/fe18f0b8-1f06-4c17-813e-bc8868b60c62.png[image]
+[%header,cols="1m,1,1m"]
+|===
+|Opérateur
+|Signification
+|Exemple
+
+| ==
+| Égal à
+| $IF user.age == 18
+
+| !=
+| Différent de
+| $IF user.country != 'FR'
+
+| > / <
+| Supérieur / Inférieur
+| $IF product.price > 100
+
+| >= / +<=+
+| Supérieur ou égal / Inférieur ou égal
+| $IF user.age >= 18
+
+| AND
+| ET logique
+| $IF user.age > 18 AND user.member == true
+
+| OR
+| OU logique
+| $IF user.age < 18 OR user.student == true
+
+|===
WARNING: veuillez utiliser uniquement les simples quotes (pas celles courbées) lorsque vous utilisez cette syntaxe.
diff --git a/src/docs/modules/ROOT/pages/wiki/Prerequis.adoc b/src/docs/modules/ROOT/pages/wiki/Prerequis.adoc
index b50f2e0d..03499acf 100644
--- a/src/docs/modules/ROOT/pages/wiki/Prerequis.adoc
+++ b/src/docs/modules/ROOT/pages/wiki/Prerequis.adoc
@@ -1,8 +1,9 @@
= Prérequis
+:sectnums:
_Avant de lancer les installations, il est nécessaire de mettre en place un "écosystème" permettant de compiler, déployer et exécuter nos applications._
-==== 1. Git
+== Git
Sur RHEL 8 / CentOS 8
@@ -18,11 +19,11 @@ Sur Ubuntu 20.04 / Debian
apt-get install git
----
-==== 2. Java
+== Java
Version de java minimale : Java OpenJdk 11 (seul cette version a été testé pour ESUP Stage)
-===== Installation java OpenJdk 11
+=== Installation java OpenJdk 11
*Sous RHEL 8 / CentOS 8*
@@ -90,9 +91,9 @@ Remarque : pour changer la version par défaut (en cas de version multiple)
sudo update-alternatives --config java
----
-==== 3. Apache Maven
+== Apache Maven
-===== Installation
+=== Installation
Téléchargez Apache Maven depuis son site officiel ou utilisez la commande suivante pour télécharger Apache Maven 3.6.3.
@@ -108,7 +109,7 @@ Extraire maintenant l'archive téléchargée à l'aide de la commande suivante :
sudo tar xzf apache-maven-3.6.3-bin.tar.gz sudo ln -s apache-maven-3.6.3 maven
----
-===== Configuration des variables d'environnement
+=== Configuration des variables d'environnement
Définissez maintenant les variables d'environnement en créant un nouveau fichier /etc/profile.d/maven.sh
@@ -132,7 +133,7 @@ sudo chmod +x /etc/profile.d/maven.sh
source /etc/profile.d/maven.sh
----
-===== Vérifier la version de Maven
+=== Vérifier la version de Maven
Apache Maven a été configuré avec succès sur votre système. Utilisez la commande suivante pour vérifier la version de Maven installé sur votre système.
@@ -150,20 +151,20 @@ Enfin, supprimez le fichier d'archive téléchargé du système pour libérer de
rm -f apache-maven-3.6.2-bin.tar.gz
----
-==== 4. Installation Mariadb
+== Installation Mariadb
L'installation et la sécurisation de votre base de donnée ne sont pas décrites dans cette documentation.
La création de la base et d'un utilisateur sont décrit dans la partie xref:wiki/ESUP-STAGE.adoc#la-base-de-donnees[La base de données]
-==== 5. Installation du projet Esup-SIscol
+== Installation du projet Esup-SIscol
ESUP Stage dépend de ce module pour interroger le SI de scolarité (Apogée) et l'annuaire LDAP
* Le projet est hébergé ici : https://github.com/EsupPortail/esup-siscol
* La procédure d'installation xref:wiki/ESUP-SISCOL.adoc[ESUP-SISCOL]
-Après installation, vous avez 2 URLs qui seront utilisés dans le fichier de configuration d'ESUP-STAGE (<>) :
+Après installation, vous avez 2 URLs qui seront utilisés dans le fichier de configuration d'ESUP-STAGE :
[source,properties]
----
diff --git a/src/docs/modules/ROOT/pages/wiki/index.adoc b/src/docs/modules/ROOT/pages/wiki/index.adoc
deleted file mode 100644
index 8b16fa5c..00000000
--- a/src/docs/modules/ROOT/pages/wiki/index.adoc
+++ /dev/null
@@ -1,62 +0,0 @@
-:reftext: Home
-:navtitle: Home
-
-image::https://raw.github.com/EsupPortail/esup-stage/main/logo-esup-stage.png[ESUP STAGE LOGO]
-
-== 🎓 Gestion Moderne des Conventions de Stage pour l'Enseignement Supérieur
-
-ESUP-Stage est une application web nouvelle génération conçue pour simplifier la gestion des stages dans les établissements d'enseignement supérieur.
-
-=== 🚀 Fonctionnalités Principales
-
-[horizontal]
-Création de Conventions:: Processus complet de génération et de validation des conventions de stage
-Intégration Système:: Compatible avec les infrastructures universitaires existantes
-Personnalisation:: Configuration souple et adaptable via l'interface utilisateur
-
-=== 🔗 Interconnexions
-
-* Intégration LDAP
-* Compatibilité Apogée
-* Développement en cours pour Pégase
-
-=== 📦 Partie du Consortium
-
-Développée et maintenue dans le cadre du consortium https://www.esup-portail.org/catalogue-des-services[ESUP Portail]
-
-'''
-
-=== Liste des changements
-
-xref:wiki/Liste-des-changements.adoc[Suivi des changements à venir et passés] +
-La liste des changements vous permettra de suivre l'évolution des applications ainsi que les corrections et évolutions associées.
-
-'''
-
-=== Lien vers le code source des applications
-
-L'application ESUP-Stage se compose de deux applications que sont :
-
-* ESUP-Stage : https://github.com/EsupPortail/esup-stage
-* ESUP-SIscol : https://github.com/EsupPortail/esup-siscol
-
-'''
-
-=== Liste de diffusion
-
-.https://listes.esup-portail.org/sympa/info/esup-stage
-Cette liste permet de nous faire parvenir vos retours et d'échanger avec les autres établissements utilisateurs de l'application.
-
-'''
-
-=== Documentation d'installation
-
-* xref:wiki/Prerequis.adoc[Prérequis]
-* xref:wiki/ESUP-SISCOL.adoc[ESUP-SISCOL]
-* xref:wiki/ESUP-STAGE.adoc[ESUP-STAGE]
-* xref:wiki/Docaposte_Signature-electronique.adoc[Docaposte_Signature électronique]
-
-=== Autres documents
-
-* xref:wiki/Processus-de-creation-d-un-utilisateur.adoc[Processus-de-création-d'un-utilisateur]
-* xref:wiki/Gestion-des-conditions-dans-les-templates.adoc[Gestion des conditions dans les modèles (templates) de convention]
diff --git a/src/docs/modules/ROOT/images/event-storming-20250121.jpg b/src/docs/modules/doc-technique/images/event-storming-20250121.jpg
similarity index 100%
rename from src/docs/modules/ROOT/images/event-storming-20250121.jpg
rename to src/docs/modules/doc-technique/images/event-storming-20250121.jpg
diff --git a/src/docs/modules/doc-technique/nav.adoc b/src/docs/modules/doc-technique/nav.adoc
new file mode 100644
index 00000000..ac37b05c
--- /dev/null
+++ b/src/docs/modules/doc-technique/nav.adoc
@@ -0,0 +1,6 @@
+.Documentation technique
+* xref:vocabulaire.adoc[]
+* xref:decisions.adoc[]
+* xref:flux.adoc[]
+* xref:archi-tech.adoc[]
+* xref:event-storming.adoc[]
diff --git a/src/docs/modules/ROOT/pages/archi-tech.adoc b/src/docs/modules/doc-technique/pages/archi-tech.adoc
similarity index 100%
rename from src/docs/modules/ROOT/pages/archi-tech.adoc
rename to src/docs/modules/doc-technique/pages/archi-tech.adoc
diff --git a/src/docs/modules/ROOT/pages/decisions.adoc b/src/docs/modules/doc-technique/pages/decisions.adoc
similarity index 100%
rename from src/docs/modules/ROOT/pages/decisions.adoc
rename to src/docs/modules/doc-technique/pages/decisions.adoc
diff --git a/src/docs/modules/ROOT/pages/event-storming.adoc b/src/docs/modules/doc-technique/pages/event-storming.adoc
similarity index 61%
rename from src/docs/modules/ROOT/pages/event-storming.adoc
rename to src/docs/modules/doc-technique/pages/event-storming.adoc
index b44b600f..e4445925 100644
--- a/src/docs/modules/ROOT/pages/event-storming.adoc
+++ b/src/docs/modules/doc-technique/pages/event-storming.adoc
@@ -2,4 +2,4 @@
:author: Université Lorraine
:imagesdir: ../images/
-image::event-storming-20250121.jpg[event-storming]
+image::event-storming-20250121.jpg[event storming]
diff --git a/src/docs/modules/ROOT/pages/flux.adoc b/src/docs/modules/doc-technique/pages/flux.adoc
similarity index 100%
rename from src/docs/modules/ROOT/pages/flux.adoc
rename to src/docs/modules/doc-technique/pages/flux.adoc
diff --git a/src/docs/modules/ROOT/pages/vocabulaire.adoc b/src/docs/modules/doc-technique/pages/vocabulaire.adoc
similarity index 100%
rename from src/docs/modules/ROOT/pages/vocabulaire.adoc
rename to src/docs/modules/doc-technique/pages/vocabulaire.adoc