diff --git a/.gitignore b/.gitignore index c240040..f91ec48 100644 --- a/.gitignore +++ b/.gitignore @@ -57,5 +57,4 @@ # Misc examples/ .idea -affiliations-rnsr/swagger.json out.tar.gz diff --git a/README.md b/README.md index 1e5fc1f..a21d01f 100644 --- a/README.md +++ b/README.md @@ -334,3 +334,55 @@ L'URL fournie sert à la configuration de l'instance, et permet la mise à jour du programme. + +## Publication d'une instance + +Pour configurer Prometheus (monitoring interne) et le reverse proxy +automatiquement, il faut avoir renseigné le fichier `swagger.json` dans le +répertoire de l'instance et lancé `make publish` (avec le répertoire comme +paramètre). + +Ex de `swagger.json`: + +```json +{ + "info": { + "title": "ark-tools - Génération des identifiants ARK", + "summary": "Permet la génération d'identifiants ARK uniques et pérennes.", + "version": "1.0.0", + "termsOfService": "https://objectif-tdm.inist.fr/", + "contact": { + "name": "Inist-CNRS", + "url": "https://www.inist.fr/nous-contacter/" + } + }, + "servers": [ + { + "x-comment": "Will be automatically completed by the ezs server." + }, + { + "url": "http://vptdmservices.intra.inist.fr:49194/", + "description": "Latest version for production", + "x-profil": "Standard" + } + ], + "tags": [ + { + "name": "ark-tools", + "description": "Génération des identifiants ARK", + "externalDocs": { + "description": "Plus de documentation", + "url": "https://gitbucket.inist.fr/tdm/web-services/tree/master/ark-tools" + } + } + ] +} +``` + +Champs importants: dans `servers`, champ `url`. + +Lancer avec: + +```bash +make publish +``` diff --git a/affiliation-rnsr/swagger.json b/affiliation-rnsr/swagger.json new file mode 100644 index 0000000..100ea9f --- /dev/null +++ b/affiliation-rnsr/swagger.json @@ -0,0 +1,32 @@ +{ + "info": { + "title": "affiliation-rnsr - Détection d'un RNSR à partir d'une affiliation", + "summary": "Utilise un modèle créé par apprentissage pour affecter un RNSR à une affiliation.", + "version": "2.0.0", + "termsOfService": "https://objectif-tdm.inist.fr/", + "contact": { + "name": "Inist-CNRS", + "url": "https://www.inist.fr/nous-contacter/" + } + }, + "servers": [ + { + "x-comment": "Will be automatically completed by the ezs server." + }, + { + "url": "http://vptdmservices.intra.inist.fr:49239/", + "description": "Latest version for production", + "x-profil": "Standard" + } + ], + "tags": [ + { + "name": "affiliation-rnsr", + "description": "Détection d'un RNSR à partir d'une affiliation", + "externalDocs": { + "description": "Plus de documentation", + "url": "https://github.com/Inist-CNRS/ezmaster-apps/tree/main/applications/ws-affiliation-rnsr" + } + } + ] +} \ No newline at end of file