diff --git a/src/docs/modules/ROOT/images/wiki/001a98b2-ec5e-4a2c-b24e-b6a0911f6196.png b/src/docs/modules/ROOT/images/wiki/001a98b2-ec5e-4a2c-b24e-b6a0911f6196.png new file mode 100644 index 00000000..1a2f21e6 Binary files /dev/null and b/src/docs/modules/ROOT/images/wiki/001a98b2-ec5e-4a2c-b24e-b6a0911f6196.png differ diff --git a/src/docs/modules/ROOT/images/wiki/366f4814-a881-435b-9fcd-57195695b1bd.png b/src/docs/modules/ROOT/images/wiki/366f4814-a881-435b-9fcd-57195695b1bd.png new file mode 100644 index 00000000..efd1bec8 Binary files /dev/null and b/src/docs/modules/ROOT/images/wiki/366f4814-a881-435b-9fcd-57195695b1bd.png differ 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 new file mode 100644 index 00000000..f4f2ae36 Binary files /dev/null and b/src/docs/modules/ROOT/images/wiki/fe18f0b8-1f06-4c17-813e-bc8868b60c62.png differ diff --git a/src/docs/modules/ROOT/nav.adoc b/src/docs/modules/ROOT/nav.adoc index 26d09497..4fabd346 100644 --- a/src/docs/modules/ROOT/nav.adoc +++ b/src/docs/modules/ROOT/nav.adoc @@ -3,4 +3,9 @@ * xref::decisions.adoc[] * xref::flux.adoc[] * xref::archi-tech.adoc[] -* xref::event-storming.adoc[] \ No newline at end of file +* 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] diff --git a/src/docs/modules/ROOT/pages/wiki/Docaposte_Signature-electronique.adoc b/src/docs/modules/ROOT/pages/wiki/Docaposte_Signature-electronique.adoc new file mode 100644 index 00000000..7843fc75 --- /dev/null +++ b/src/docs/modules/ROOT/pages/wiki/Docaposte_Signature-electronique.adoc @@ -0,0 +1,233 @@ += Signature Électronique Docaposte +:imagesdir: ../../images + +== Tomcat certificats + +Documentation d'aide à la configuration des certificats TLS gérés du process Java relatif à Esup-Stage. + +=== Définitions + +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 + +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. + +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 + +* 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. + +. Découpez la chaîne des certificats publics contenu dans le fichier ca.crt** ++ +[source,console] +---- +[user@computer ~/tmp]$ csplit -s -z -f cacrt- ca.crt '/-----BEGIN CERTIFICATE-----/' '{*}' +[user@computer ~/tmp]$ ls -1 +cacrt-00 +cacrt-01 +ca.crt +---- + +. Créez/Importez la série des certificats issus du ca.crt dans un nouveau truststore ++ +[source,console] +---- +[user@computer ~/tmp]$ ls -1 cacrt-* | while read item; do \ + echo "Import un certificat de la chaine de certification '${item}' :"; \ + keytool -keystore truststore.jks -storepass my_password \ + -alias ${item} -import -noprompt -file ${item}; \ + done +Import un certificat de la chaine de certification 'cacrt-00' : +Certificate was added to keystore +Import un certificat de la chaine de certification 'cacrt-01' : +Certificate was added to keystore +[user@computer ~/tmp]$ +---- + +. Vérifiez le contenu du truststore + ++ +[source,console] +---- +[user@computer ~/tmp]$ keytool -list -v -keystore truststore.jks -storepass my_password \ + | grep -C 5 'Entry type: trustedCertEntry' \ + | grep -E '^(Alias name|Entry type|Issuer|Valid from):' +Alias name: cacrt-00 +Entry type: trustedCertEntry +Issuer: ... +Valid from: ... +Alias name: cacrt-01 +Entry type: trustedCertEntry +Issuer: ... +Valid from: ... +[user@computer ~/tmp]$ +---- + +. 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. ++ +* récupérez le certificat de ce service externe +* importez ce fichier certificat manuellement dans le truststore + +.Exemple avec l'API de test de Docaposte +. Récupérez le certificat ++ +[source,console] +---- +[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 ++ +[source,console] +---- +[user@computer ~/tmp]$ keytool -keystore truststore.jks -storepass my_password \ + -alias 'demo-parapheur' -import -noprompt -file demo-parapheur.pem +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. ++ +* 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 + +== Lanceur Tomcat + +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 : + +* `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 + +Exemple avec un apache-tomcat-9.0 packagé en Red Hat + +* /etc/sysconfig/tomcat9.0 +[source,shell] +---- +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) +[source,shell] +---- + +# TOMCAT > MEMOIRE +export CATALINA_OPTS="$CATALINA_OPTS -Xms2048m -Xmx4096m" +... +# TOMCAT > TRUSTSTORE certificats acceptés +export CATALINA_OPTS="$CATALINA_OPTS -Djavax.net.ssl.trustStore=/etc/ssl/catalina.truststore" +export CATALINA_OPTS="$CATALINA_OPTS -Djavax.net.ssl.trustStoreType=JKS" +export CATALINA_OPTS="$CATALINA_OPTS -Djavax.net.ssl.trustStorePassword=my_password" +---- + +Vérifiez que les variables sont bien chargées après le redémarrage du tomcat + +[source,console] +---- +[root@server ~]# ps aux | grep tomcat +tomcat ... /usr/bin/java ... -Djavax.net.ssl.trustStore=/etc/ssl/catalina.truststore -Djavax.net.ssl.trustStoreType=JKS -Djavax.net.ssl.trustStorePassword=my_password ... +[root@server ~]# +---- + +== 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. + +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] +---- +[root@server ~]# keytool -list -v -keystore /data/certificat.p12 -storepass my_password \ + | grep -C 6 '^Entry type: PrivateKeyEntry' \ + | grep -E '^(Alias name|Creation date|Entry type|Owner|Issuer|Valid from):' +Alias name: 1 +Creation date: May 16, 2023 +Entry type: PrivateKeyEntry +Owner: ... +Issuer: ... +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] +---- +[root@server ~]# openssl pkcs12 -in certificat.p12 -out docaposte.crt -nodes +Enter Import Password: ***** +[root@server ~]# cat docaposte.crt +... +-----BEGIN CERTIFICATE----- +... +-----END CERTIFICATE----- +... +-----BEGIN CERTIFICATE----- +... +-----END CERTIFICATE----- +[root@server ~]# +---- + +== Paramétrage dans ESUP-Stage + +=== Fichier estage.properties + +Dans le fichier `/etc/estage/estage.properties` du serveur ESUP-Stage, complétez les informations suivantes : + +[source,properties] +---- +# uri vers le webservice Docaposte +docaposte.uri=https://demo-parapheur.dfast.fr/parapheur-soap/soap/v1/Documents +# numéro siren fourni par Docaposte +docaposte.siren=0123456789 +# chemin absolu du fichier .p12 +docaposte.keystore.path=/data/certificat.p12 +# mot de passe permettant la lecture du fichier p12 +docaposte.keystore.password=xxx +# chemin absolu du fichier .pks +docaposte.truststore.path=/data/ProductionFAST.jks +# mot de passe permettant la lecture du fichier jks +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 : + +* 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. + +=== 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 + +* 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) : +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 +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 new file mode 100644 index 00000000..aecd6f16 --- /dev/null +++ b/src/docs/modules/ROOT/pages/wiki/ESUP-SISCOL.adoc @@ -0,0 +1,177 @@ += 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). + +[discrete] +=== Versions + +* APOGEE `6.4.x` +* JDK `11`, `8` +* APOGEE WS `62031` ...`62070` + +[discrete] +=== 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..._ + +*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 +---- + +[discrete] +=== Clonage et installation + +[source,shell] +---- +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] +---- + + gouv.education.apogee + apo-webservices-client + version-ws-apogee-a-définir-ici + +---- + +[discrete] +=== Fichier de paramétrage + +Nous allons créer un répertoire où nous placerons les fichiers de configurations de l'application esup-siscol : + +[source,shell] +---- +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 +[source,yaml] +---- +spring: + ldap: + urls: + - ldap://ldap-paris.fr:389 + username: uid=xxxx,ou=admins,dc=u-paris10,dc=fr + password: xxxx + base: dc=u-paris10,dc=fr + +springdoc: + version: '@springdoc.version@' + api-docs: + groups: + enabled: true + swagger-ui: + + display-request-duration: true + groups-order: ASC + operationsSorter: method + disable-swagger-default-url: true + use-root-path: true + path: /swagger-ui.html + url: /api-docs.yaml + +server: + error: + include-exception: true + whitelabel: + enabled: true + path: /error.html + include-stacktrace: always + +app: + ldap: + stringFilterTeacher: (|(eduPersonAffiliation=teacher)(eduPersonAffiliation=faculty)) + stringFilterStudent: (eduPersonAffiliation=student) + stringFilterStaff: (eduPersonAffiliation=staff) + repoStringFilterStudent: (eduPersonAffiliation=student) + repoStringFilterStudentBySn: (&(eduPersonAffiliation=student)(sn={0})) + repoStringFilterStudentByUId: (&(eduPersonAffiliation=student)(uid={0})) + repoStringFilterStudentByNumEtu: (&(eduPersonAffiliation=student)(numlEtu={0})) + dnPeople: ou=people + + apogee: + startYearMonth: 09 + startYearDay: 01 + universityCode: UPN + urlService: + administratifMetier: http://wsapogee.monuniv.fr/aws/services/AdministratifMetier + etudiantMetier: http://wsapogee.monuniv.fr/aws/services/EtudiantMetier + pedagogiqueMetier: http://wsapogee.monuniv.fr/aws/services/PedagogiqueMetier + geographieMetier: http://wsapogee.monuniv.fr/aws/services/GeographieMetier + referentielMetier: http://wsapogee.monuniv.fr/aws/services/ReferentielMetier + offreFormationMetier: http://wsapogee.monuniv.fr/aws/services/OffreFormationMetier + + credential: + userscredential: + root: + username: root + password: un-super-mot-de-passe-a-remplacer-ici + roles: + - ADMIN + - USER + - USER_APOGEE + - USER_LDAP + autorisation: + supann: + - USER_LDAP + - ADMIN + referentiel: + - USER_APOGEE + - ADMIN + + cache: + # Chargement au demarrage des caches + onStartup: + # Active ou non, par defaut : false + enabled: true + # Time-To-Live du cache temporaire, en minutes, par defaut : 60 [minutes] + #ttl-tmp: + # Time-To-Live du cache permanent, en heures, par defaut : 0 [heures] + # Si 0, aucune limite de temps + #ttl-permanent: + # Cron pour un rechargement periodique des caches + scheduling: + # Active ou non, par defaut : false + enabled: false + # Expression cron, par defaut : aucune + cron: 0 0 7-22 * * * +---- + +Vous devez modifier en cohérence avec vos spécificités : + +* la section "LDAP" +* 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 + +Pour compiler le projet et générer le WAR dans le répertoire "./target/", lancez les commandes : + +[source,shell] +---- +mvn clean compile +mvn install +---- + +[discrete] +=== 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. + +Si votre Tomcat est installé sur le chemin suivant : \{tomcat_path}=/usr/share/tomcat, il faut copier votre fichier esup-siscol-x.x.x.war dans le webapp pour son déploiement : + +[source,shell] +---- +cp target/esup-siscol-x.x.x.war {tomcat_path}/webapps/esup-siscol.war +---- + +Après déploiement, vous pourrez y accéder à l'adresse : http://localhost:8080/esup-siscol diff --git a/src/docs/modules/ROOT/pages/wiki/ESUP-STAGE.adoc b/src/docs/modules/ROOT/pages/wiki/ESUP-STAGE.adoc new file mode 100644 index 00000000..f319f88d --- /dev/null +++ b/src/docs/modules/ROOT/pages/wiki/ESUP-STAGE.adoc @@ -0,0 +1,185 @@ += ESUP STAGE + +=== Prérequis + +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é) + +=== Clonage du projet + +[source,shell] +---- +cd /opt +git clone https://github.com/EsupPortail/esup-stage.git +---- + +[#la-base-de-donnees] +=== La base de données + +==== Création de la base et de l'utilisateur + +[source,SQL] +---- +CREATE DATABASE estage; +CREATE USER 'esupstage_user'@'%' IDENTIFIED BY 'password'; +GRANT ALL PRIVILEGES ON estage.* TO 'esupstage_user'@'%'; +FLUSH PRIVILEGES; +---- + +==== Import de la base pStage et passage du patch + +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 +____ + +____ +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) : + +[source,shell] +---- +zcat /opt/estage/mysql-pstage-2022-01-25-16h00.sql.gz | mysql -u esupstage_user -p estage +cat /opt/estage/src/main/resources/db/changelog/init-changelog.sql | mysql -u esupstage_user -p estage +---- + +=== Modification du fichier de configuration + +[source,shell] +---- +cd /etc +mkdir estage +cd estage +cp /opt/esup-stage/etc/estage/estage-example.properties estage.properties +---- + +Modifier le fichier de configuration + +[source,properties] +---- +# parametres des URLs pour l'authentication CAS +cas.url.login=https://cas.monuniv.fr/cas/login?service={service} +cas.url.service=https://cas.monuniv.fr/cas/p3/serviceValidate?service={service}&ticket={ticket}&format=json +cas.url.logout=https://cas.monuniv.fr/cas/logout + +# parametres base de donnees +appli.datasource.url=jdbc:mariadb://monserversql.monuniv.fr:3306/estage +appli.datasource.username=estage +appli.datasource.password=xxx +appli.datasource.driver=org.mariadb.jdbc.Driver + +# url de l'application (notamment utilisée pour envoyer des liens par mail) +appli.url=http://esupstage.monuniv.fr:8080/frontend/#/ + +# logins des admin technique, séparés par des ; (utilisateurs à créer au 1er lancement pour paramétrer l'application) +appli.admin_technique=xxx;yyy + +# identifiant pour l'accès au web services référentiel (cela correspond aux identifiants du WS esup-SIscol) +referentiel.ws.login=root +referentiel.ws.password=xxx +# url du service LDAP +referentiel.ws.ldap_url=https://referentiel.monuniv.fr/ldap +# url du service Apogée +referentiel.ws.apogee_url=https://referentiel.monuniv.fr/apogee + +# mailer +appli.mailer.protocol=smtp +appli.mailer.host=smtp.monuniv.fr +appli.mailer.port=25 +appli.mailer.auth=true +appli.mailer.username=username@monuniv.fr +appli.mailer.password=xxx +appli.mailer.from=from@monuniv.fr +appli.mailer.disable_delivery=true +# paramètres pour le développement, par défaut disable_delivery=false, delivery_address=null +# si appli.mailer.disable_delivery=true alors l'envoi de mail est désactivé sinon si false alors l'envoi de mail est activé +appli.mailer.delivery_address=user@monuniv.fr +# Permet de rediriger les mails vers une adresse mail. Si adresse mail renseignée alors les mails sont redirigés vers cette adresse. Si null alors les mails sont envoyés aux utilisateurs. + +# chemin vers le dossier contenant les uploads +# pour les logos des centres de gestion il faut que le dossier ${appli.data_dir}/centregestion/logos soit existant sur le serveur +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* +____ + +=== Compilation du projet + +[source,shell] +---- +cd /opt/esup-stage +mvn -Dmaven.test.skip=true clean package +---- + +=== 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 +____ + +==== 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 + +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 + +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* + +[source,shell] +---- +cp /opt/esupstage/target/ROOT.war /opt/tomcat-esup-stage/webapp/ +---- + +On arrête le tomcat avant et on le redémarre ensuite + +[source,shell] +---- +/opt/tomcat-esup-stage/bin/shutdown.sh +---- + +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 +---- + +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 + +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] +---- + + ServerAdmin admin@monuniv.fr + ServerName esup-stage.monuniv.fr + DefaultType text/html + ProxyRequests off + ProxyPreserveHost On + ProxyPass / http://localhost:8080/ + ProxyPassReverse / http://localhost:8080/ + +---- 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 new file mode 100644 index 00000000..e1ec29a6 --- /dev/null +++ b/src/docs/modules/ROOT/pages/wiki/Gestion-des-conditions-dans-les-templates.adoc @@ -0,0 +1,46 @@ += Gestion des conditions dans les templates +:sectnums: +:imagesdir: ../../images + +Dans les modèles (templates) de convention de stage, il est possible d'afficher +les variables en fonction de conditions. Les conditions, pour fonctionner, +doivent respecter les règles suivantes : + +== Conditions simples + +[literal] +$IF condition +vContenu si la condition est vraie. +$ELSE +Contenu si la condition est fausse. +$ENDIF + +== Conditions multiples + +[literal] +$IF condition1 +Contenu si condition1 est vraie. +$ELSEIF condition2 +Contenu si condition2 est vraie. +$ELSE +Contenu si aucune condition n'est vraie. +$ENDIF + +== Utilisation avec des variables dynamiques + +[literal] +$IF user.name != '' +Bonjour, ${user.name} ! +$ELSE +Bonjour, utilisateur anonyme. +$ENDIF + +== La structure $IF ... $FI + +Cela encadre une condition. Si la condition est vraie, le contenu placé entre $IF et $ENDIF sera affiché. + + +== Opérateurs logiques + +image:wiki/fe18f0b8-1f06-4c17-813e-bc8868b60c62.png[image] + +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/Liste-des-changements.adoc b/src/docs/modules/ROOT/pages/wiki/Liste-des-changements.adoc new file mode 100644 index 00000000..29d0d873 --- /dev/null +++ b/src/docs/modules/ROOT/pages/wiki/Liste-des-changements.adoc @@ -0,0 +1,26 @@ += Liste des changements + +== Versions stables + +* https://github.com/EsupPortail/esup-stage[ESUP-Stage 2.1.9] +* https://github.com/EsupPortail/esup-siscol[ESUP-SIScol 1.0.28] + +''' + +== Version(s) à venir + +=== ESUP-Stage + +* Page d'erreur personnalisée - Gestion des cas ou favicon et logo possiblement null +* A la connexion : récupération du nom et prénom depuis le LDAP au lieu de pointer sur le retour du CAS + +=== ESUP-SIScol + +* {blank} + +== RAS + +== Releases passées + +* https://github.com/EsupPortail/esup-stage/releases[ESUP-Stage] +* https://github.com/EsupPortail/esup-siscol/releases[ESUP-SIScol] diff --git a/src/docs/modules/ROOT/pages/wiki/Prerequis.adoc b/src/docs/modules/ROOT/pages/wiki/Prerequis.adoc new file mode 100644 index 00000000..b50f2e0d --- /dev/null +++ b/src/docs/modules/ROOT/pages/wiki/Prerequis.adoc @@ -0,0 +1,174 @@ += Prérequis + +_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 + +Sur RHEL 8 / CentOS 8 + +[source,shell] +---- +yum install git +---- + +Sur Ubuntu 20.04 / Debian + +[source,shell] +---- +apt-get install git +---- + +==== 2. Java + +Version de java minimale : Java OpenJdk 11 (seul cette version a été testé pour ESUP Stage) + +===== Installation java OpenJdk 11 + +*Sous RHEL 8 / CentOS 8* + +[source,shell] +---- +sudo yum -y install java-11-openjdk java-11-openjdk-devel +---- + +Vérification de l'installation + +[,console] +---- +$ java -version +openjdk version "11.0.12" 2021-07-20 LTS +OpenJDK Runtime Environment 18.9 (build 11.0.12+7-LTS) +OpenJDK 64-Bit Server VM 18.9 (build 11.0.12+7-LTS, mixed mode, sharing) + +$ which java +/usr/bin/java +---- + +Définir les variables d'environnement Java + +[source,shell] +---- +sudo tee /etc/profile.d/java11.sh <>) : + +[source,properties] +---- +# url du service LDAP +referentiel.ws.ldap_url=https://referentiel.monuniv.fr/ldap +# url du service Apogée +referentiel.ws.apogee_url=https://referentiel.monuniv.fr/apogee +---- \ No newline at end of file diff --git a/src/docs/modules/ROOT/pages/wiki/Processus-de-creation-d-un-utilisateur.adoc b/src/docs/modules/ROOT/pages/wiki/Processus-de-creation-d-un-utilisateur.adoc new file mode 100644 index 00000000..2bc39b03 --- /dev/null +++ b/src/docs/modules/ROOT/pages/wiki/Processus-de-creation-d-un-utilisateur.adoc @@ -0,0 +1,15 @@ += Processus de création d'un utilisateur + +Voici la procédure de création des utilisateurs dans ESUP-Stage. Un utilisateur se connecte à l'application : + +. On recherche dans l'application s'il existe déjà +** S'il existe déjà alors il hérite du même rôle et des mêmes droits +** S'il n'existe pas, on passe à l'étape 2 +. On recherche l'utilisateur dans l'annuaire LDAP +** Ce sera un étudiant si /ldap/etudiant indique qu'il s'agit d'un étudiant +** Ce sera un enseignant si /ldap/tuteur/ indique qu'il s'agit d'un enseignant +** Ce sera un enseignant et gestionnaire si /ldap/tuteur/ indique qu'il s'agit d'un enseignant et qu'il est rattaché à un centre de gestion +** Si l'utilisateur n'est dans aucun des cas précédents alors on passe à l'étape 3 +. On doit créer à la main l'utilisateur via le menu de création de la gestion des utilisateurs + +Vous pouvez visualiser les appels /ldap/etudiant et /ldap/tuteur/ via le Swagger UI mis à disposition avec ESUP-SIScol. diff --git a/src/docs/modules/ROOT/pages/wiki/index.adoc b/src/docs/modules/ROOT/pages/wiki/index.adoc new file mode 100644 index 00000000..8b16fa5c --- /dev/null +++ b/src/docs/modules/ROOT/pages/wiki/index.adoc @@ -0,0 +1,62 @@ +: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]