Skip to content

Commit

Permalink
deplace doc signature du README vers antora
Browse files Browse the repository at this point in the history
et suppression prefixe wiki
  • Loading branch information
lea-raya authored and Léa Raya DÉCORNOD committed Jan 23, 2025
1 parent 29f1195 commit b98c901
Show file tree
Hide file tree
Showing 13 changed files with 68 additions and 70 deletions.
61 changes: 3 additions & 58 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ ESUP STAGE est la refonte de l'application pStage. L'application a été complè
link:src/docs/modules/ROOT/pages/index.adoc[→ Documentation technique Esup-Stage]

ifndef::env-github[]
include::src/docs/modules/ROOT/pages/wiki/ESUP-STAGE.adoc[tag=compilation]
include::src/docs/modules/ROOT/pages/ESUP-STAGE.adoc[tag=compilation]
endif::[]
ifdef::env-github[]
== link:src/docs/modules/ROOT/pages/wiki/ESUP-STAGE.adoc#compilation[→ Compilation]
== link:src/docs/modules/ROOT/pages/ESUP-STAGE.adoc#compilation[→ Compilation]
endif::[]


Expand Down Expand Up @@ -68,62 +68,7 @@ il faut ajouter la ligne suivante au fichier `estage.properties` :
cas.response_type=xml
----

== Signature électronique (optionnel)

La signature électronique est activée si au moins une des configuration ci-dessous est paramétrée. Si plusieurs solutions configurées, Docaposte prendra le dessus.

=== Docaposte

____
*ATTENTION :* Les paramètres ne doivent pas être ajoutés s'ils ne sont pas utilisés
____

Les paramètres Docaposte se trouve dans le fichier `estage.properties` :

[,properties]
----
# docaposte
docaposte.uri=https://demo-parapheur.dfast.fr/parapheur-soap/soap/v1/Documents
docaposte.siren=xxx
docaposte.keystore.path=<chemin du fichier .p12>
docaposte.keystore.password=xxx
docaposte.truststore.path=<chemin du fichier .jks>
docaposte.truststore.password=xxx
----

Les certificats pour Docaposte peuvent être déposés où vous le souhaitez en dehors du projet.

=== ESUP-Signature (mode solution externe)

____
*ATTENTION :* Les paramètres ne doivent pas être ajoutés s'ils ne sont pas utilisés
____

ESUP-Stage met à disposition des api "public" accessible avec un des tokens paramétrés dans `appli.public.tokens`. La liste des api se trouve dans `/public/swagger-ui.html`.

Le paramétrage "webhook" correspondent à l'appel vers une api externe pour la signature électronique (cette solution est à mettre en place par chaque établissement). Les api vers ESUP-Signature sont intégrés dans ESUP-Stage mais la configuration est la même pour une solution externe.

`webhook.signature.uri` : uri de l'api externe +
`webhook.signature.token` : token d'accès

[,properties]
----
# tokens d'accès d'esup-stage permettant d'autoriser les webhook à accéder aux api /public/api d'esup-stage séparés par des ; (exemple : token1;token2;token3)
appli.public.tokens=xxxx
### Paramétrage webhooks ###
# uri du webhook de signature
webhook.signature.uri=http://localhost:8080/webhook/esup-signature
# token permettant d'accéder au webhook signature
webhook.signature.token=yyyyy
### -------------------- ###
### Paramétrage esup-signature ###
# numero du circuit
esupsignature.uri=http://localhost:8880/ws
esupsignature.circuit=123
### -------------------- ###
----
== link:src/docs/modules/ROOT/pages/signature.adoc[→ Signature électronique (optionnel)]

== Procédure d'installation en environnement de dev

Expand Down
13 changes: 7 additions & 6 deletions src/docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
.Documentation d’installation
* xref:wiki/Prerequis.adoc[]
* xref:wiki/ESUP-SISCOL.adoc[]
* xref:wiki/ESUP-STAGE.adoc[]
* xref:wiki/Docaposte_Signature-electronique.adoc[]
* xref:Prerequis.adoc[]
* xref:ESUP-SISCOL.adoc[]
* xref:ESUP-STAGE.adoc[]
* xref:signature.adoc[]
** xref:Docaposte_Signature-electronique.adoc[]
.Autres documents
* xref:wiki/Processus-de-creation-d-un-utilisateur.adoc[]
* xref:wiki/Gestion-des-conditions-dans-les-templates.adoc[]
* xref:Processus-de-creation-d-un-utilisateur.adoc[]
* xref:Gestion-des-conditions-dans-les-templates.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ 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]
image: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]
image:366f4814-a881-435b-9fcd-57195695b1bd.png[image]
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

== Prérequis

.Les xref:wiki/Prerequis.adoc[prérequis] sont les suivants sur votre serveur :
.Les xref:Prerequis.adoc[prérequis] sont les suivants sur votre serveur :
* Git
* Java OpenJdk 11
* Apache Maven
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,14 @@ rm -f apache-maven-3.6.2-bin.tar.gz

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]
La création de la base et d'un utilisateur sont décrit dans la partie xref:ESUP-STAGE.adoc#la-base-de-donnees[La base de données]

== 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]
* La procédure d'installation xref:ESUP-SISCOL.adoc[ESUP-SISCOL]

Après installation, vous avez 2 URLs qui seront utilisés dans le fichier de configuration d'ESUP-STAGE :

Expand Down
2 changes: 1 addition & 1 deletion src/docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ 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] +
xref: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.

Expand Down
52 changes: 52 additions & 0 deletions src/docs/modules/ROOT/pages/signature.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
= Signature électronique (optionnel)

La signature électronique est activée si au moins une des configuration ci-dessous est paramétrée. Si plusieurs solutions configurées, Docaposte prendra le dessus.

== Docaposte

WARNING: Les paramètres ne doivent pas être ajoutés s'ils ne sont pas utilisés

Les paramètres Docaposte se trouve dans le fichier `estage.properties` :

[,properties]
----
# docaposte
docaposte.uri=https://demo-parapheur.dfast.fr/parapheur-soap/soap/v1/Documents
docaposte.siren=xxx
docaposte.keystore.path=<chemin du fichier .p12>
docaposte.keystore.password=xxx
docaposte.truststore.path=<chemin du fichier .jks>
docaposte.truststore.password=xxx
----

Les certificats pour Docaposte peuvent être déposés où vous le souhaitez en dehors du projet.

== ESUP-Signature (mode solution externe)

WARNING: Les paramètres ne doivent pas être ajoutés s'ils ne sont pas utilisés

ESUP-Stage met à disposition des api "public" accessible avec un des tokens paramétrés dans `appli.public.tokens`. La liste des api se trouve dans `/public/swagger-ui.html`.

Le paramétrage "webhook" correspondent à l'appel vers une api externe pour la signature électronique (cette solution est à mettre en place par chaque établissement). Les api vers ESUP-Signature sont intégrés dans ESUP-Stage mais la configuration est la même pour une solution externe.

`webhook.signature.uri` : uri de l'api externe +
`webhook.signature.token` : token d'accès

[,properties]
----
# tokens d'accès d'esup-stage permettant d'autoriser les webhook à accéder aux api /public/api d'esup-stage séparés par des ; (exemple : token1;token2;token3)
appli.public.tokens=xxxx
### Paramétrage webhooks ###
# uri du webhook de signature
webhook.signature.uri=http://localhost:8080/webhook/esup-signature
# token permettant d'accéder au webhook signature
webhook.signature.token=yyyyy
### -------------------- ###
### Paramétrage esup-signature ###
# numero du circuit
esupsignature.uri=http://localhost:8880/ws
esupsignature.circuit=123
### -------------------- ###
----

0 comments on commit b98c901

Please sign in to comment.