AJLSM - Contributions [fr]

Création de plugin pour Mirador

2023-09-18T09:31:16Z

Mhymonet : /* Références */

== Contexte ==
Ici nous allons chercher à créer un plugin pour Mirador 3 ainsi que l'intégrer.

== Création d'un plugin ==
=== Conventions ===
Dans un premier temps, il faut savoir que pour créer un plugin il faut respecter une certaine convention.
Il faut tout d'abord que le plugin possède au moins ces 3 propriétés :
<syntaxhighlight lang="javascript">
{
name: 'Demo',
target: 'WindowTopBarPluginMenu',
mode: 'add',
}
</syntaxhighlight>
- name: Tout simplement le nom du plugin

- target: Le composant de Mirador qui est ciblé par le plugin à savoir que seul les composants suivant peuvent être ciblés :
* Window
* BackgroundPluginArea
* WindowTopBarPluginMenu
* WorkspaceControlPanelButtons
* WorkspaceMenu
* WorkspaceOptionsMenu
- mode: Ce que fait le plugin donc ici "add" pour le faite qu'il ajoute une fonction

Ensuite, les propriétés s'accompagnent aussi d'habitude de ceci :
<syntaxhighlight lang="javascript">
{
component: DemoComponent,
}
</syntaxhighlight>
- component: La fonction, constante ou encore classe qui va indiquer ce que fait notre plugin.

=== Exemple ===
Le tout est montré dans l'exemple ci-dessous:
<syntaxhighlight lang="javascript">
const DemoComponent = props => {
console.log(props);
return <div id="add-plugin-component-anything">Hello World!</div>;
};

export default {
name: "Demo",
target: "WindowTopBarPluginMenu",
mode: "add",
component: DemoComponent
};
</syntaxhighlight>
On a donc toutes les propriétés qui se retrouvent dans la partie "export default" et l'action qu'effectue notre plugin dans "const DemoComponent", qui ici affiche donc juste un "Hello World!" dans le composant "WindowTopBarPluginMenu" de Mirador.

== Références ==

* cf. https://github.com/ProjectMirador/mirador/wiki/M3-Configuration-Recipes (Doc officielle de Mirador 3)
* cf. https://github.com/ProjectMirador/mirador-dl-plugin (Exemple Dl-Plugin)
* cf. https://github.com/mejackreed/mirador-plugin-example/tree/master/src (Exemple d'un petit plugin)
* cf. https://github.com/jbaiter/mirador/wiki/Plugin-Development-Guide (Doc non officielle)

Création de plugin pour Mirador

2023-03-27T12:10:14Z

Mhymonet : /* Contexte */

Configuration de Mirador

2023-03-27T12:04:44Z

Mhymonet : /* Pour Mirador 2 */

== Contexte ==
Ici nous allons chercher à configurer Mirador 2 et 3 après l’installation.

== Manifest au chargement et collection de manifest ==
=== Pour Mirador 2 ===
Dans un premier temps on va chercher à afficher un certain manifest soit via la collection de manifest déjà présente dans la visionneuse, soit directement au chargement de Mirador.
Pour ce faire, il va falloir éditer ce fichier, qui se trouve à la racine :
<syntaxhighlight lang="bash">
index.html
</syntaxhighlight>
Ensuite, dans la partie “data” de la fonction, c’est là ou nous allons trouver la collection de manifest mis à disposition de la visionneuse avec les paramètres suivants :
# “manifestUri” : le lien vers le manifest, généralement au format json
# “location” : qui n’est pas obligatoir et ou on y indique la provenance du manifest
Plus bas ensuite, si on souhaite charger un manifest dès le lancement de la visionneuse, on trouvera au même titre que “data”, une partie “windowObjects” qui peut contenir :
# "loadedManifest" : comme pour “data”, le lien vers le manifest
# "viewType" : qui sera le type d’affichage qui est par défault sur “ImageView"
# “canvasID” : le lien de la page du manifest que l’on souhaite afficher qui est par défaut sur la première

Infos : A savoir que le chargement d'un manifest de "https://pandor.u-bourgogne.fr" a été impossible, le retour n'affiche même aucune message alors que pour un manifest de "https://archives.lamayenne.fr" il n'affiche toujours pas le manifest mais au moins retourne un message d'erreur.

=== Pour Mirador 3 ===
Il faut tout d'abord savoir qu'avec Mirador 3, si on souhaite changer les manifest à disposition, il faut forcément l'intégrer à une autre page html ou javascript et ce en lui ajoutant le script :
<syntaxhighlight lang="html4strict">
<script src="https://unpkg.com/mirador@latest/dist/mirador.min.js"></script>
</syntaxhighlight>
et ensuite il est possible de lui fournir une certaine configuration comme ci-dessous :
<syntaxhighlight lang="html4strict">
<script type="text/javascript">
var mirador = Mirador.viewer({
"id": "my-mirador",
"manifests": {
"https://iiif.lib.harvard.edu/manifests/drs:48309543": {
"provider": "Harvard University"
},
"https://pandor.u-bourgogne.fr/archives-en-ligne/iiif/ark:/62246/r22057zlv55psk/manifest.json": {
"provider": "Bourgogne"
}

},
"windows": [
{
"loadedManifest": "https://pandor.u-bourgogne.fr/archives-en-ligne/iiif/ark:/62246/r22057zlv55psk/manifest.json",
"canvasIndex": 1,
"thumbnailNavigationPosition": 'far-bottom'
}
]
});
</script>
</syntaxhighlight>
On retrouve donc après les mêmes choses que pour la version à ceci prêt quelques changement au niveau de la syntaxe :
# “data”, la collection devient "manifests" et on peut directement spécifier l'url après
# “location”, la provenance du manifest devient "provider"
# “windowObjects”, ce qu'il y a à charger au lancement devient "windows"
# “canvasID”, le canva du manifest à afficher en premier devient "canvasIndex"

Infos : Avec cette version, le chargement d'un manifest de "https://pandor.u-bourgogne.fr" ne pose pas de problème.

== Apparence et fonctionnalités ==
Ensuite pour tout ce qui est de la configuration visuel, cela va se faire dans un autre fichier.
* Pour Mirador 2 :
Pour Mirador 2, on va pouvoir modifier les fonctionnalités disponibles dans le même fichier que pour les manifest, en les mettant ensuite soit à "true" si on veut les activer soit à "false" si on ne le veut pas.
Voici voici un exemple avec quelques fonctionnalités :
<syntaxhighlight lang="html4strict">
"tocTabAvailable": true,
"layersTabAvailable": true,
"searchTabAvailable": true,
"annotations" : true
</syntaxhighlight>

* Pour Mirador 3 :
Ensuite pour tout ce qui est de la configuration visuel de Mirador 3, cela va se faire dans un autre fichier :
<syntaxhighlight lang="bash">
src/config/settings.js
</syntaxhighlight>
Il y aura tout ce qui correspond au thème, aux couleurs des texte, au tailles, etc, comme le montre un extrait ci-dessous :
<syntaxhighlight lang="html4strict">
themes: {
dark: {
palette: {
type: 'dark',
primary: {
main: '#4db6ac',
},
secondary: {
main: '#4db6ac',
},
shades: {
dark: '#000000',
main: '#424242',
light: '#616161',
}
}
},
light: {
palette: {
type: 'light',
}
}
},
</syntaxhighlight>
Puis enfin plus bas, on retrouve tout ce qui est en rapport avec l'activation ou non de certaines fonctionnalités liées à la visionneuse, comme montré ci-dessous :
<syntaxhighlight lang="html4strict">
allowClose: true, // Configure if windows can be closed or not
allowFullscreen: false, // Configure to show a "fullscreen" button in the WindowTopBar
allowMaximize: true, // Configure if windows can be maximized or not
allowTopMenuButton: true, // Configure if window view and thumbnail display menu are visible or not
allowWindowSideBar: true, // Configure if side bar menu is visible or not
authNewWindowCenter: 'parent', // Configure how to center a new window created by the authentication flow. Options: parent, screen
sideBarPanel: 'info', // Configure which sidebar is selected by default. Options: info, attribution, canvas, annotations, search
defaultSidebarPanelHeight: 201, // Configure default sidebar height in pixels
defaultSidebarPanelWidth: 235, // Configure default sidebar width in pixels
defaultView: 'single', // Configure which viewing mode (e.g. single, book, gallery) for windows to be opened in
forceDrawAnnotations: true,
</syntaxhighlight>
Note : A savoir qu'il est possible de modifier ces valeurs dans le même fichier que là ou on change les manifest si Mirador 3 est intégré dans un autre fichier.

== Références ==

* cf. https://github.com/ProjectMirador/mirador-2-wiki/wiki/Configuration-Guides (Doc officielle de la configuration de Mirador 2)
* cf. https://github.com/ProjectMirador/mirador/wiki/M3-Configuration-Recipes (Doc officielle de la configuration de Mirador 3)
* cf. https://mirador-2-demo.netlify.app (Démo permanente de Mirador 2)
* cf. https://mirador-dev.netlify.app/__tests__/integration/mirador/ (Démo permanente de Mirador 3)

Configuration de Mirador

2023-03-27T12:04:16Z

Mhymonet : /* Manifest au chargement et collection de manifest */

Configuration de Mirador

2023-03-21T15:12:55Z

Mhymonet : /* Apparence et fonctionnalités */

== Contexte ==
Ici nous allons chercher à configurer Mirador 2 et 3 après l’installation.

== Manifest au chargement et collection de manifest ==
* Pour Mirador 2 :
Dans un premier temps on va chercher à afficher un certain manifest soit via la collection de manifest déjà présente dans la visionneuse, soit directement au chargement de Mirador.
Pour ce faire, il va falloir éditer ce fichier, qui se trouve à la racine :
<syntaxhighlight lang="bash">
index.html
</syntaxhighlight>
Ensuite, dans la partie “data” de la fonction, c’est là ou nous allons trouver la collection de manifest mis à disposition de la visionneuse avec les paramètres suivants :
# “manifestUri” : le lien vers le manifest, généralement au format json
# “location” : qui n’est pas obligatoir et ou on y indique la provenance du manifest
Plus bas ensuite, si on souhaite charger un manifest dès le lancement de la visionneuse, on trouvera au même titre que “data”, une partie “windowObjects” qui peut contenir :
# "loadedManifest" : comme pour “data”, le lien vers le manifest
# "viewType" : qui sera le type d’affichage qui est par défault sur “ImageView"
# “canvasID” : le lien de la page du manifest que l’on souhaite afficher qui est par défaut sur la première

Infos : A savoir que le chargement d'un manifest de "https://pandor.u-bourgogne.fr" a été impossible, le retour n'affiche même aucune message alors que pour un manifest de "https://archives.lamayenne.fr" il n'affiche toujours pas le manifest mais au moins retourne un message d'erreur.

* Pour Mirador 3 :
Il faut tout d'abord savoir qu'avec Mirador 3, si on souhaite changer les manifest à disposition, il faut forcément l'intégrer à une autre page html ou javascript et ce en lui ajoutant le script :
<syntaxhighlight lang="html4strict">
<script src="https://unpkg.com/mirador@latest/dist/mirador.min.js"></script>
</syntaxhighlight>
et ensuite il est possible de lui fournir une certaine configuration comme ci-dessous :
<syntaxhighlight lang="html4strict">
<script type="text/javascript">
var mirador = Mirador.viewer({
"id": "my-mirador",
"manifests": {
"https://iiif.lib.harvard.edu/manifests/drs:48309543": {
"provider": "Harvard University"
},
"https://pandor.u-bourgogne.fr/archives-en-ligne/iiif/ark:/62246/r22057zlv55psk/manifest.json": {
"provider": "Bourgogne"
}

},
"windows": [
{
"loadedManifest": "https://pandor.u-bourgogne.fr/archives-en-ligne/iiif/ark:/62246/r22057zlv55psk/manifest.json",
"canvasIndex": 1,
"thumbnailNavigationPosition": 'far-bottom'
}
]
});
</script>
</syntaxhighlight>
On retrouve donc après les mêmes choses que pour la version à ceci prêt quelques changement au niveau de la syntaxe :
# “data”, la collection devient "manifests" et on peut directement spécifier l'url après
# “location”, la provenance du manifest devient "provider"
# “windowObjects”, ce qu'il y a à charger au lancement devient "windows"
# “canvasID”, le canva du manifest à afficher en premier devient "canvasIndex"

Infos : Avec cette version, le chargement d'un manifest de "https://pandor.u-bourgogne.fr" ne pose pas de problème.

== Apparence et fonctionnalités ==
Ensuite pour tout ce qui est de la configuration visuel, cela va se faire dans un autre fichier.
* Pour Mirador 2 :
Pour Mirador 2, on va pouvoir modifier les fonctionnalités disponibles dans le même fichier que pour les manifest, en les mettant ensuite soit à "true" si on veut les activer soit à "false" si on ne le veut pas.
Voici voici un exemple avec quelques fonctionnalités :
<syntaxhighlight lang="html4strict">
"tocTabAvailable": true,
"layersTabAvailable": true,
"searchTabAvailable": true,
"annotations" : true
</syntaxhighlight>

* Pour Mirador 3 :
Ensuite pour tout ce qui est de la configuration visuel de Mirador 3, cela va se faire dans un autre fichier :
<syntaxhighlight lang="bash">
src/config/settings.js
</syntaxhighlight>
Il y aura tout ce qui correspond au thème, aux couleurs des texte, au tailles, etc, comme le montre un extrait ci-dessous :
<syntaxhighlight lang="html4strict">
themes: {
dark: {
palette: {
type: 'dark',
primary: {
main: '#4db6ac',
},
secondary: {
main: '#4db6ac',
},
shades: {
dark: '#000000',
main: '#424242',
light: '#616161',
}
}
},
light: {
palette: {
type: 'light',
}
}
},
</syntaxhighlight>
Puis enfin plus bas, on retrouve tout ce qui est en rapport avec l'activation ou non de certaines fonctionnalités liées à la visionneuse, comme montré ci-dessous :
<syntaxhighlight lang="html4strict">
allowClose: true, // Configure if windows can be closed or not
allowFullscreen: false, // Configure to show a "fullscreen" button in the WindowTopBar
allowMaximize: true, // Configure if windows can be maximized or not
allowTopMenuButton: true, // Configure if window view and thumbnail display menu are visible or not
allowWindowSideBar: true, // Configure if side bar menu is visible or not
authNewWindowCenter: 'parent', // Configure how to center a new window created by the authentication flow. Options: parent, screen
sideBarPanel: 'info', // Configure which sidebar is selected by default. Options: info, attribution, canvas, annotations, search
defaultSidebarPanelHeight: 201, // Configure default sidebar height in pixels
defaultSidebarPanelWidth: 235, // Configure default sidebar width in pixels
defaultView: 'single', // Configure which viewing mode (e.g. single, book, gallery) for windows to be opened in
forceDrawAnnotations: true,
</syntaxhighlight>
Note : A savoir qu'il est possible de modifier ces valeurs dans le même fichier que là ou on change les manifest si Mirador 3 est intégré dans un autre fichier.

== Références ==

* cf. https://github.com/ProjectMirador/mirador-2-wiki/wiki/Configuration-Guides (Doc officielle de la configuration de Mirador 2)
* cf. https://github.com/ProjectMirador/mirador/wiki/M3-Configuration-Recipes (Doc officielle de la configuration de Mirador 3)
* cf. https://mirador-2-demo.netlify.app (Démo permanente de Mirador 2)
* cf. https://mirador-dev.netlify.app/__tests__/integration/mirador/ (Démo permanente de Mirador 3)

Création de plugin pour Mirador

2023-03-21T15:09:43Z

Mhymonet : /* Références */

Création de plugin pour Mirador

2023-03-21T15:09:23Z

Mhymonet : /* Création d'un plugin */

Installation de Mirador

2023-03-21T14:50:39Z

Mhymonet : /* Pour la version 3 avec plugin */

== Contexte ==
Le but ici est d’installer mirador en local, la méthode est la même pour les version 2 et 3 à quelques exceptions près comme montré dans les étapes ci-dessous.

== Étape de l’installation ==
=== Pour les version 2 et 3 ===
* Installation de node:
<syntaxhighlight lang="bash">
$ sudo apt install nodejs
</syntaxhighlight>
* Installation de npm :
<syntaxhighlight lang="bash">
$ sudo apt install npm
</syntaxhighlight>
* Installation de grunt :
<syntaxhighlight lang="bash">
$ sudo npm install -g grunt-cli
</syntaxhighlight>
* Clone du projet :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/projectmirador/mirador2
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/ProjectMirador/mirador
</syntaxhighlight>
* Se placer de le dossier :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ cd mirador2/
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ cd mirador/
</syntaxhighlight>
* Installation des dépendances :
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

=== Pour la version 3 avec plugin ===
Pour Mirador 3, si on souhaite pouvoir utiliser et créer des plugins, il faut l'installer d'une certaine manière.
Cette installation nécessitera de pouvoir utiliser la commande "npm".
* Installation de "nwb" :
<syntaxhighlight lang="bash">
$ npm i -g nwb
</syntaxhighlight>
* Installation de Mirador nommée "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ nwb new react-component mirador-demo-plugin
Creating a react-component project...
? Do you want to create an ES modules build for use by compatible bundlers? Yes
? Do you want to create a UMD build for global usage via <script> tag? Yes
? Which global variable should the UMD build set? MiradorDemo
create .gitignore
create .travis.yml
create CONTRIBUTING.md
create README.md
create demo/src/index.js
create nwb.config.js
create package.json
create src/index.js
create tests/.eslintrc
create tests/index-test.js
✔ Installing react and react-dom
</syntaxhighlight>
Après cette installation, nous aurons donc les fichiers de base qui se seront crées.
* Déplacement dans le projet nommé "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ cd mirador-demo-plugin/
</syntaxhighlight>
* Ajouter mirador comme dépendance dev :
<syntaxhighlight lang="bash">
$ npm i --save-dev mirador@alpha
</syntaxhighlight>
Cela va servir à utiliser l'import de mirador pour créer des plugins derrière.
* Vérifier les dépendances :
Pour les vérifier, il suffit de regarder dans le fichier "package.json" qui se trouve à la racine du projet.
On va ici vérifier que les dépendances liés à "mirador", "react" et "react-dom" apparaissent dans la partie "peer dependencies".
<syntaxhighlight lang="html4strict">
{
"peerDependencies": {
"mirador": "^3.0.0-rc.7",
"react": "16.x",
"react-dom": "16.x"
},
"devDependencies": {
"mirador": "^3.0.0-rc.7",
"nwb": "0.23.x"
},
}
</syntaxhighlight>
* Installer les dépendances :
Et enfin, après avoir vérifier qu'elles étaient là, il manque plus qu'à installer les dépendances pour finaliser l'installation.
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Changement de port ==
Pour éviter toutes sortes de conflits avec d'autres application déjà en fonctionnement, il est possible de changer le port sur lequel on souhaite lancer Mirador.
=== Pour les version 2 et 3 ===
Pour cela, il suffit de le changer dans le fichier suivant, qui se trouve à la racine du projet :
* Pour mirador 2 :
Gruntfile.js
* Pour mirador 3 :
webpack.config.js

=== Pour la version 3 avec plugin ===
* Via la commande "export" :
Pour cette version, il suffit de modifier la variable d'environnement "PORT", soit en modifiant le fichier ".env" et en lui ajoutant la ligne suivante :
<syntaxhighlight lang="bash">
PORT=3005
</syntaxhighlight>
Soit en utilisant directement une commande :
<syntaxhighlight lang="bash">
$ export PORT=3005
</syntaxhighlight>
Et tout cela en remplaçant bine évidemment "3005" par le port voulu.
* Via la commande de lancement :
Pour lancer cette version, on va lancer l'application à l'aide ce cette commande :
<syntaxhighlight lang="bash">
npm run parcel
</syntaxhighlight>
Mais il possible de lui ajouter un paramètre "port" de la manière suivante :
<syntaxhighlight lang="bash">
npm run parcel -- --port 3005
</syntaxhighlight>
Attention : Les deux "--" sont bien nécessaires sinon le port ne sera pas prit en compte.

== Lancement ==
Pour ensuite lancer Mirador, il suffit d'utiliser la commande suivante :
* Pour mirador 2 :
<syntaxhighlight lang="bash">
$ grunt serve
</syntaxhighlight>
* Pour mirador 3 (avec plugin ou pas) :
<syntaxhighlight lang="bash">
$ npm start
</syntaxhighlight>

Il est ensuite possible d'y accéder via cette url :
<syntaxhighlight lang="bash">
http://localhost:8000
</syntaxhighlight>
En remplaçant "8000" par le port associé au Mirador.

Création de plugin pour Mirador

2023-03-21T14:45:25Z

Mhymonet : /* Intégration d'un plugin */

Intégration de plugin à Mirador

2023-03-21T14:45:05Z

Mhymonet : Page créée avec « == Contexte == Ici nous allons chercher à intégrer un plugin à Mirador et la méthode va changer selon si le plugin à a été crée par nous ou non. == Intégration d... »

== Contexte ==
Ici nous allons chercher à intégrer un plugin à Mirador et la méthode va changer selon si le plugin à a été crée par nous ou non.

== Intégration d'un plugin ==
=== Plugin créé ===
Pour intégrer le plugin à notre configuration de mirador, il faut dans un premier temps l'ajouter dans les exports :
<syntaxhighlight lang="javascript">
import plugin from "./demo-plugin";
</syntaxhighlight>

Et ensuite on l’intègre à notre configuration de cette manière :
<syntaxhighlight lang="javascript">
const config = {
// Ici on place notre config
};

var miradorInstance = mirador.viewer(config, [plugin]);
</syntaxhighlight>
A savoir qu'il est évidemment possible d'intégrer plusieurs plugins en même temps, en les séparant par une virgule entre les crochets.

=== Plugin déjà existant ===
On prends bien en compte ici le faite que l'installation a été faite en suivant la doc et on va prendre l'exemple du plugin "mirador-image-tools".
* Installation de la dépendance
<syntaxhighlight lang="bash">
npm install mirador-image-tools
</syntaxhighlight>
* Vérification
Après avoir installé la dépendance, elle est censée apparaître dans le fichier "package.json" qui regroupe les différentes dépendances de node utilisées :
<syntaxhighlight lang="bash">
"dependencies": {
"css-loader": "^3.6.0",
"mirador": "^3.3.0",
"mirador-image-tools": "^0.11.0",
"parcel-bundler": "^1.12.4",
"react": "^16.13.1",
"react-dom": "^16.13.1",
"style-loader": "^1.2.1",
"webpack": "^4.43.0",
"webpack-cli": "^3.3.12"
}
</syntaxhighlight>
* Intégration
Après avoir vérifié que la dépendance est bien présente, on peut donc l'utiliser en l'intégrant au mirador via le fichier "index.js".
Donc dans un premier temps, on import le plugin :
<syntaxhighlight lang="javascript">
import { miradorImageToolsPlugin } from 'mirador-image-tools';
</syntaxhighlight>
On peut ensuite l'intégrer à la config :
<syntaxhighlight lang="javascript">
Mirador.viewer(config, [
...miradorImageToolsPlugin,
]);
</syntaxhighlight>

Création de plugin pour Mirador

2023-03-20T15:04:24Z

Mhymonet : /* Intégration d'un plugin */

== Contexte ==
Ici nous allons chercher à créer un plugin pour Mirador ainsi que l'intégrer.

== Création d'un plugin ==
=== Conventions ===
Dans un premier temps, il faut savoir que pour créer un plugin il faut respecter une certaine convention.
Il faut tout d'abord que le plugin possède au moins ces 3 propriétés :
<syntaxhighlight lang="javascript">
{
name: 'Demo',
target: 'WindowTopBarPluginMenu',
mode: 'add',
}
</syntaxhighlight>
- name: Tout simplement le nom du plugin

- target: Le composant de Mirador qui est ciblé par le plugin à savoir que seul les composants suivant peuvent être ciblés :
* Window
* BackgroundPluginArea
* WindowTopBarPluginMenu
* WorkspaceControlPanelButtons
* WorkspaceMenu
* WorkspaceOptionsMenu
- mode: Ce que fait le plugin donc ici "add" pour le faite qu'il ajoute une fonction

Ensuite, les propriétés s'accompagnent aussi d'habitude de ceci :
<syntaxhighlight lang="javascript">
{
component: DemoComponent,
}
</syntaxhighlight>
- component: La fonction, constante ou encore classe qui va indiquer ce que fait notre plugin.

=== Exemple ===
Le tout est montré dans l'exemple ci-dessous:
<syntaxhighlight lang="javascript">
const DemoComponent = props => {
console.log(props);
return <div id="add-plugin-component-anything">Hello World!</div>;
};

export default {
name: "Demo",
target: "WindowTopBarPluginMenu",
mode: "add",
component: DemoComponent
};
</syntaxhighlight>
On a donc toutes les propriétés qui se retrouvent dans la partie "export default" et l'action qu'effectue notre plugin dans "const DemoComponent", qui ici affiche donc juste un "Hello World!" dans le composant "WindowTopBarPluginMenu" de Mirador.

== Intégration d'un plugin ==
=== Plugin créé ===
Pour intégrer le plugin à notre configuration de mirador, il faut dans un premier temps l'ajouter dans les exports :
<syntaxhighlight lang="javascript">
import plugin from "./demo-plugin";
</syntaxhighlight>

Et ensuite on l’intègre à notre configuration de cette manière :
<syntaxhighlight lang="javascript">
const config = {
// Ici on place notre config
};

var miradorInstance = mirador.viewer(config, [plugin]);
</syntaxhighlight>
A savoir qu'il est évidemment possible d'intégrer plusieurs plugins en même temps, en les séparant par une virgule entre les crochets.

=== Plugin déjà existant ===
On prends bien en compte ici le faite que l'installation a été faite en suivant la doc et on va prendre l'exemple du plugin "mirador-image-tools".
* Installation de la dépendance
<syntaxhighlight lang="bash">
npm install mirador-image-tools
</syntaxhighlight>
* Vérification
Après avoir installé la dépendance, elle est censée apparaître dans le fichier "package.json" qui regroupe les différentes dépendances de node utilisées :
<syntaxhighlight lang="bash">
"dependencies": {
"css-loader": "^3.6.0",
"mirador": "^3.3.0",
"mirador-image-tools": "^0.11.0",
"parcel-bundler": "^1.12.4",
"react": "^16.13.1",
"react-dom": "^16.13.1",
"style-loader": "^1.2.1",
"webpack": "^4.43.0",
"webpack-cli": "^3.3.12"
}
</syntaxhighlight>
* Intégration
Après avoir vérifié que la dépendance est bien présente, on peut donc l'utiliser en l'intégrant au mirador via le fichier "index.js".
Donc dans un premier temps, on import le plugin :
<syntaxhighlight lang="javascript">
import { miradorImageToolsPlugin } from 'mirador-image-tools';
</syntaxhighlight>
On peut ensuite l'intégrer à la config :
<syntaxhighlight lang="javascript">
Mirador.viewer(config, [
...miradorImageToolsPlugin,
]);
</syntaxhighlight>

Installation de Mirador

2023-03-03T12:49:29Z

Mhymonet : /* Lancement */

== Contexte ==
Le but ici est d’installer mirador en local, la méthode est la même pour les version 2 et 3 à quelques exceptions près comme montré dans les étapes ci-dessous.

== Étape de l’installation ==
=== Pour les version 2 et 3 ===
* Installation de node:
<syntaxhighlight lang="bash">
$ sudo apt install nodejs
</syntaxhighlight>
* Installation de npm :
<syntaxhighlight lang="bash">
$ sudo apt install npm
</syntaxhighlight>
* Installation de grunt :
<syntaxhighlight lang="bash">
$ sudo npm install -g grunt-cli
</syntaxhighlight>
* Clone du projet :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/projectmirador/mirador2
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/ProjectMirador/mirador
</syntaxhighlight>
* Se placer de le dossier :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ cd mirador2/
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ cd mirador/
</syntaxhighlight>
* Installation des dépendances :
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

=== Pour la version 3 avec plugin ===
Pour Mirador 3, si on souhaite pouvoir utiliser et créer des plugins, il faut l'installer d'une certaine manière.
Cette installation nécessitera de pouvoir utiliser la commande "npm".
* Installation de "nwb" :
<syntaxhighlight lang="bash">
$ npm i -g nwb
</syntaxhighlight>
* Installation de Mirador nommée "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ nwb new react-component mirador-demo-plugin
Creating a react-component project...
? Do you want to create an ES modules build for use by compatible bundlers? Yes
? Do you want to create a UMD build for global usage via <script> tag? Yes
? Which global variable should the UMD build set? MiradorDemo
create .gitignore
create .travis.yml
create CONTRIBUTING.md
create README.md
create demo/src/index.js
create nwb.config.js
create package.json
create src/index.js
create tests/.eslintrc
create tests/index-test.js
✔ Installing react and react-dom
</syntaxhighlight>
Après cette installation, nous aurons donc les fichiers de base qui se seront crées.
* Déplacement dans le projet nommé "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ cd mirador-demo-plugin/
</syntaxhighlight>
* Ajouter mirador comme dépendance dev :
<syntaxhighlight lang="bash">
$ npm i --save-dev mirador@alpha
</syntaxhighlight>
Cela va servir à utiliser l'import de mirador pour créer des plugins derrière.
* Vérifier les dépendances :
Pour les vérifier, il suffit de regarder dans le fichier "package.json" qui se trouve à la racine du projet.
On va ici vérifier que les dépendances liés à "mirador", "react" et "react-dom" apparaissent dans la partie "peer dependencies".
<syntaxhighlight lang="html4strict">
{
"peerDependencies": {
"mirador": "^3.0.0-rc.7",
"react": "16.x",
"react-dom": "16.x"
},
"devDependencies": {
"mirador": "^3.0.0-rc.7",
"nwb": "0.23.x"
},
}
</syntaxhighlight>
* Installer les dépendances :
Et enfin, après avoir vérifier qu'elles étaient là, il manque plus qu'à installer les dépendances pour finaliser l'installation.
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Changement de port ==
Pour éviter toutes sortes de conflits avec d'autres application déjà en fonctionnement, il est possible de changer le port sur lequel on souhaite lancer Mirador.
=== Pour les version 2 et 3 ===
Pour cela, il suffit de le changer dans le fichier suivant, qui se trouve à la racine du projet :
* Pour mirador 2 :
Gruntfile.js
* Pour mirador 3 :
webpack.config.js

=== Pour la version 3 avec plugin ===
Pour cette version, il suffit de modifier la variable d'environnement "PORT", soit en modifiant le fichier ".env" et en lui ajoutant la ligne suivante :
<syntaxhighlight lang="bash">
PORT=3005
</syntaxhighlight>
Soit en utilisant directement une commande :
<syntaxhighlight lang="bash">
$ export PORT=3005
</syntaxhighlight>
Et tout cela en remplaçant bine évidemment "3005" par le port voulu.

== Lancement ==
Pour ensuite lancer Mirador, il suffit d'utiliser la commande suivante :
* Pour mirador 2 :
<syntaxhighlight lang="bash">
$ grunt serve
</syntaxhighlight>
* Pour mirador 3 (avec plugin ou pas) :
<syntaxhighlight lang="bash">
$ npm start
</syntaxhighlight>

Il est ensuite possible d'y accéder via cette url :
<syntaxhighlight lang="bash">
http://localhost/8000
</syntaxhighlight>
En remplaçant "8000" par le port associé au Mirador.

Installation de Mirador

2023-03-03T12:49:01Z

Mhymonet : /* Étape de l’installation */

== Contexte ==
Le but ici est d’installer mirador en local, la méthode est la même pour les version 2 et 3 à quelques exceptions près comme montré dans les étapes ci-dessous.

== Étape de l’installation ==
=== Pour les version 2 et 3 ===
* Installation de node:
<syntaxhighlight lang="bash">
$ sudo apt install nodejs
</syntaxhighlight>
* Installation de npm :
<syntaxhighlight lang="bash">
$ sudo apt install npm
</syntaxhighlight>
* Installation de grunt :
<syntaxhighlight lang="bash">
$ sudo npm install -g grunt-cli
</syntaxhighlight>
* Clone du projet :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/projectmirador/mirador2
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/ProjectMirador/mirador
</syntaxhighlight>
* Se placer de le dossier :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ cd mirador2/
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ cd mirador/
</syntaxhighlight>
* Installation des dépendances :
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

=== Pour la version 3 avec plugin ===
Pour Mirador 3, si on souhaite pouvoir utiliser et créer des plugins, il faut l'installer d'une certaine manière.
Cette installation nécessitera de pouvoir utiliser la commande "npm".
* Installation de "nwb" :
<syntaxhighlight lang="bash">
$ npm i -g nwb
</syntaxhighlight>
* Installation de Mirador nommée "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ nwb new react-component mirador-demo-plugin
Creating a react-component project...
? Do you want to create an ES modules build for use by compatible bundlers? Yes
? Do you want to create a UMD build for global usage via <script> tag? Yes
? Which global variable should the UMD build set? MiradorDemo
create .gitignore
create .travis.yml
create CONTRIBUTING.md
create README.md
create demo/src/index.js
create nwb.config.js
create package.json
create src/index.js
create tests/.eslintrc
create tests/index-test.js
✔ Installing react and react-dom
</syntaxhighlight>
Après cette installation, nous aurons donc les fichiers de base qui se seront crées.
* Déplacement dans le projet nommé "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ cd mirador-demo-plugin/
</syntaxhighlight>
* Ajouter mirador comme dépendance dev :
<syntaxhighlight lang="bash">
$ npm i --save-dev mirador@alpha
</syntaxhighlight>
Cela va servir à utiliser l'import de mirador pour créer des plugins derrière.
* Vérifier les dépendances :
Pour les vérifier, il suffit de regarder dans le fichier "package.json" qui se trouve à la racine du projet.
On va ici vérifier que les dépendances liés à "mirador", "react" et "react-dom" apparaissent dans la partie "peer dependencies".
<syntaxhighlight lang="html4strict">
{
"peerDependencies": {
"mirador": "^3.0.0-rc.7",
"react": "16.x",
"react-dom": "16.x"
},
"devDependencies": {
"mirador": "^3.0.0-rc.7",
"nwb": "0.23.x"
},
}
</syntaxhighlight>
* Installer les dépendances :
Et enfin, après avoir vérifier qu'elles étaient là, il manque plus qu'à installer les dépendances pour finaliser l'installation.
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Changement de port ==
Pour éviter toutes sortes de conflits avec d'autres application déjà en fonctionnement, il est possible de changer le port sur lequel on souhaite lancer Mirador.
=== Pour les version 2 et 3 ===
Pour cela, il suffit de le changer dans le fichier suivant, qui se trouve à la racine du projet :
* Pour mirador 2 :
Gruntfile.js
* Pour mirador 3 :
webpack.config.js

=== Pour la version 3 avec plugin ===
Pour cette version, il suffit de modifier la variable d'environnement "PORT", soit en modifiant le fichier ".env" et en lui ajoutant la ligne suivante :
<syntaxhighlight lang="bash">
PORT=3005
</syntaxhighlight>
Soit en utilisant directement une commande :
<syntaxhighlight lang="bash">
$ export PORT=3005
</syntaxhighlight>
Et tout cela en remplaçant bine évidemment "3005" par le port voulu.

== Lancement ==
Pour ensuite lancer Mirador, il suffit d'utiliser la commande suivante :
* Pour mirador 2 :
<syntaxhighlight lang="bash">
$ grunt serve
</syntaxhighlight>
* Pour mirador 3 :
<syntaxhighlight lang="bash">
$ npm start
</syntaxhighlight>

Il est ensuite possible d'y accéder via cette url :
<syntaxhighlight lang="bash">
http://localhost/8000
</syntaxhighlight>
En remplaçant "8000" par le port associé au Mirador.

Installation de Mirador

2023-03-03T12:48:45Z

Mhymonet : /* Étape de l’installation pour Mirador 3 et permettre l'utilisation et la création de plugins */

== Contexte ==
Le but ici est d’installer mirador en local, la méthode est la même pour les version 2 et 3 à quelques exceptions près comme montré dans les étapes ci-dessous.

== Étape de l’installation ==
* Installation de node:
<syntaxhighlight lang="bash">
$ sudo apt install nodejs
</syntaxhighlight>
* Installation de npm :
<syntaxhighlight lang="bash">
$ sudo apt install npm
</syntaxhighlight>
* Installation de grunt :
<syntaxhighlight lang="bash">
$ sudo npm install -g grunt-cli
</syntaxhighlight>
* Clone du projet :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/projectmirador/mirador2
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/ProjectMirador/mirador
</syntaxhighlight>
* Se placer de le dossier :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ cd mirador2/
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ cd mirador/
</syntaxhighlight>
* Installation des dépendances :
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

=== Pour la version 3 avec plugin ===
Pour Mirador 3, si on souhaite pouvoir utiliser et créer des plugins, il faut l'installer d'une certaine manière.
Cette installation nécessitera de pouvoir utiliser la commande "npm".
* Installation de "nwb" :
<syntaxhighlight lang="bash">
$ npm i -g nwb
</syntaxhighlight>
* Installation de Mirador nommée "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ nwb new react-component mirador-demo-plugin
Creating a react-component project...
? Do you want to create an ES modules build for use by compatible bundlers? Yes
? Do you want to create a UMD build for global usage via <script> tag? Yes
? Which global variable should the UMD build set? MiradorDemo
create .gitignore
create .travis.yml
create CONTRIBUTING.md
create README.md
create demo/src/index.js
create nwb.config.js
create package.json
create src/index.js
create tests/.eslintrc
create tests/index-test.js
✔ Installing react and react-dom
</syntaxhighlight>
Après cette installation, nous aurons donc les fichiers de base qui se seront crées.
* Déplacement dans le projet nommé "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ cd mirador-demo-plugin/
</syntaxhighlight>
* Ajouter mirador comme dépendance dev :
<syntaxhighlight lang="bash">
$ npm i --save-dev mirador@alpha
</syntaxhighlight>
Cela va servir à utiliser l'import de mirador pour créer des plugins derrière.
* Vérifier les dépendances :
Pour les vérifier, il suffit de regarder dans le fichier "package.json" qui se trouve à la racine du projet.
On va ici vérifier que les dépendances liés à "mirador", "react" et "react-dom" apparaissent dans la partie "peer dependencies".
<syntaxhighlight lang="html4strict">
{
"peerDependencies": {
"mirador": "^3.0.0-rc.7",
"react": "16.x",
"react-dom": "16.x"
},
"devDependencies": {
"mirador": "^3.0.0-rc.7",
"nwb": "0.23.x"
},
}
</syntaxhighlight>
* Installer les dépendances :
Et enfin, après avoir vérifier qu'elles étaient là, il manque plus qu'à installer les dépendances pour finaliser l'installation.
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Changement de port ==
Pour éviter toutes sortes de conflits avec d'autres application déjà en fonctionnement, il est possible de changer le port sur lequel on souhaite lancer Mirador.
=== Pour les version 2 et 3 ===
Pour cela, il suffit de le changer dans le fichier suivant, qui se trouve à la racine du projet :
* Pour mirador 2 :
Gruntfile.js
* Pour mirador 3 :
webpack.config.js

=== Pour la version 3 avec plugin ===
Pour cette version, il suffit de modifier la variable d'environnement "PORT", soit en modifiant le fichier ".env" et en lui ajoutant la ligne suivante :
<syntaxhighlight lang="bash">
PORT=3005
</syntaxhighlight>
Soit en utilisant directement une commande :
<syntaxhighlight lang="bash">
$ export PORT=3005
</syntaxhighlight>
Et tout cela en remplaçant bine évidemment "3005" par le port voulu.

== Lancement ==
Pour ensuite lancer Mirador, il suffit d'utiliser la commande suivante :
* Pour mirador 2 :
<syntaxhighlight lang="bash">
$ grunt serve
</syntaxhighlight>
* Pour mirador 3 :
<syntaxhighlight lang="bash">
$ npm start
</syntaxhighlight>

Il est ensuite possible d'y accéder via cette url :
<syntaxhighlight lang="bash">
http://localhost/8000
</syntaxhighlight>
En remplaçant "8000" par le port associé au Mirador.

Installation de Mirador

2023-03-03T12:48:28Z

Mhymonet : /* Étape de l’installation pour Mirador 3 et permettre l'utilisation et la création de plugins */

== Contexte ==
Le but ici est d’installer mirador en local, la méthode est la même pour les version 2 et 3 à quelques exceptions près comme montré dans les étapes ci-dessous.

== Étape de l’installation ==
* Installation de node:
<syntaxhighlight lang="bash">
$ sudo apt install nodejs
</syntaxhighlight>
* Installation de npm :
<syntaxhighlight lang="bash">
$ sudo apt install npm
</syntaxhighlight>
* Installation de grunt :
<syntaxhighlight lang="bash">
$ sudo npm install -g grunt-cli
</syntaxhighlight>
* Clone du projet :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/projectmirador/mirador2
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/ProjectMirador/mirador
</syntaxhighlight>
* Se placer de le dossier :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ cd mirador2/
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ cd mirador/
</syntaxhighlight>
* Installation des dépendances :
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

=== Étape de l’installation pour Mirador 3 et permettre l'utilisation et la création de plugins ===
Pour Mirador 3, si on souhaite pouvoir utiliser et créer des plugins, il faut l'installer d'une certaine manière.
Cette installation nécessitera de pouvoir utiliser la commande "npm".
* Installation de "nwb" :
<syntaxhighlight lang="bash">
$ npm i -g nwb
</syntaxhighlight>
* Installation de Mirador nommée "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ nwb new react-component mirador-demo-plugin
Creating a react-component project...
? Do you want to create an ES modules build for use by compatible bundlers? Yes
? Do you want to create a UMD build for global usage via <script> tag? Yes
? Which global variable should the UMD build set? MiradorDemo
create .gitignore
create .travis.yml
create CONTRIBUTING.md
create README.md
create demo/src/index.js
create nwb.config.js
create package.json
create src/index.js
create tests/.eslintrc
create tests/index-test.js
✔ Installing react and react-dom
</syntaxhighlight>
Après cette installation, nous aurons donc les fichiers de base qui se seront crées.
* Déplacement dans le projet nommé "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ cd mirador-demo-plugin/
</syntaxhighlight>
* Ajouter mirador comme dépendance dev :
<syntaxhighlight lang="bash">
$ npm i --save-dev mirador@alpha
</syntaxhighlight>
Cela va servir à utiliser l'import de mirador pour créer des plugins derrière.
* Vérifier les dépendances :
Pour les vérifier, il suffit de regarder dans le fichier "package.json" qui se trouve à la racine du projet.
On va ici vérifier que les dépendances liés à "mirador", "react" et "react-dom" apparaissent dans la partie "peer dependencies".
<syntaxhighlight lang="html4strict">
{
"peerDependencies": {
"mirador": "^3.0.0-rc.7",
"react": "16.x",
"react-dom": "16.x"
},
"devDependencies": {
"mirador": "^3.0.0-rc.7",
"nwb": "0.23.x"
},
}
</syntaxhighlight>
* Installer les dépendances :
Et enfin, après avoir vérifier qu'elles étaient là, il manque plus qu'à installer les dépendances pour finaliser l'installation.
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Changement de port ==
Pour éviter toutes sortes de conflits avec d'autres application déjà en fonctionnement, il est possible de changer le port sur lequel on souhaite lancer Mirador.
=== Pour les version 2 et 3 ===
Pour cela, il suffit de le changer dans le fichier suivant, qui se trouve à la racine du projet :
* Pour mirador 2 :
Gruntfile.js
* Pour mirador 3 :
webpack.config.js

=== Pour la version 3 avec plugin ===
Pour cette version, il suffit de modifier la variable d'environnement "PORT", soit en modifiant le fichier ".env" et en lui ajoutant la ligne suivante :
<syntaxhighlight lang="bash">
PORT=3005
</syntaxhighlight>
Soit en utilisant directement une commande :
<syntaxhighlight lang="bash">
$ export PORT=3005
</syntaxhighlight>
Et tout cela en remplaçant bine évidemment "3005" par le port voulu.

== Lancement ==
Pour ensuite lancer Mirador, il suffit d'utiliser la commande suivante :
* Pour mirador 2 :
<syntaxhighlight lang="bash">
$ grunt serve
</syntaxhighlight>
* Pour mirador 3 :
<syntaxhighlight lang="bash">
$ npm start
</syntaxhighlight>

Il est ensuite possible d'y accéder via cette url :
<syntaxhighlight lang="bash">
http://localhost/8000
</syntaxhighlight>
En remplaçant "8000" par le port associé au Mirador.

Installation de Mirador

2023-03-03T12:47:52Z

Mhymonet : /* Pour les version 2 et 3 : */

== Contexte ==
Le but ici est d’installer mirador en local, la méthode est la même pour les version 2 et 3 à quelques exceptions près comme montré dans les étapes ci-dessous.

== Étape de l’installation ==
* Installation de node:
<syntaxhighlight lang="bash">
$ sudo apt install nodejs
</syntaxhighlight>
* Installation de npm :
<syntaxhighlight lang="bash">
$ sudo apt install npm
</syntaxhighlight>
* Installation de grunt :
<syntaxhighlight lang="bash">
$ sudo npm install -g grunt-cli
</syntaxhighlight>
* Clone du projet :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/projectmirador/mirador2
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/ProjectMirador/mirador
</syntaxhighlight>
* Se placer de le dossier :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ cd mirador2/
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ cd mirador/
</syntaxhighlight>
* Installation des dépendances :
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Étape de l’installation pour Mirador 3 et permettre l'utilisation et la création de plugins ==
Pour Mirador 3, si on souhaite pouvoir utiliser et créer des plugins, il faut l'installer d'une certaine manière.
Cette installation nécessitera de pouvoir utiliser la commande "npm".
* Installation de "nwb" :
<syntaxhighlight lang="bash">
$ npm i -g nwb
</syntaxhighlight>
* Installation de Mirador nommée "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ nwb new react-component mirador-demo-plugin
Creating a react-component project...
? Do you want to create an ES modules build for use by compatible bundlers? Yes
? Do you want to create a UMD build for global usage via <script> tag? Yes
? Which global variable should the UMD build set? MiradorDemo
create .gitignore
create .travis.yml
create CONTRIBUTING.md
create README.md
create demo/src/index.js
create nwb.config.js
create package.json
create src/index.js
create tests/.eslintrc
create tests/index-test.js
✔ Installing react and react-dom
</syntaxhighlight>
Après cette installation, nous aurons donc les fichiers de base qui se seront crées.
* Déplacement dans le projet nommé "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ cd mirador-demo-plugin/
</syntaxhighlight>
* Ajouter mirador comme dépendance dev :
<syntaxhighlight lang="bash">
$ npm i --save-dev mirador@alpha
</syntaxhighlight>
Cela va servir à utiliser l'import de mirador pour créer des plugins derrière.
* Vérifier les dépendances :
Pour les vérifier, il suffit de regarder dans le fichier "package.json" qui se trouve à la racine du projet.
On va ici vérifier que les dépendances liés à "mirador", "react" et "react-dom" apparaissent dans la partie "peer dependencies".
<syntaxhighlight lang="html4strict">
{
"peerDependencies": {
"mirador": "^3.0.0-rc.7",
"react": "16.x",
"react-dom": "16.x"
},
"devDependencies": {
"mirador": "^3.0.0-rc.7",
"nwb": "0.23.x"
},
}
</syntaxhighlight>
* Installer les dépendances :
Et enfin, après avoir vérifier qu'elles étaient là, il manque plus qu'à installer les dépendances pour finaliser l'installation.
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Changement de port ==
Pour éviter toutes sortes de conflits avec d'autres application déjà en fonctionnement, il est possible de changer le port sur lequel on souhaite lancer Mirador.
=== Pour les version 2 et 3 ===
Pour cela, il suffit de le changer dans le fichier suivant, qui se trouve à la racine du projet :
* Pour mirador 2 :
Gruntfile.js
* Pour mirador 3 :
webpack.config.js

=== Pour la version 3 avec plugin ===
Pour cette version, il suffit de modifier la variable d'environnement "PORT", soit en modifiant le fichier ".env" et en lui ajoutant la ligne suivante :
<syntaxhighlight lang="bash">
PORT=3005
</syntaxhighlight>
Soit en utilisant directement une commande :
<syntaxhighlight lang="bash">
$ export PORT=3005
</syntaxhighlight>
Et tout cela en remplaçant bine évidemment "3005" par le port voulu.

== Lancement ==
Pour ensuite lancer Mirador, il suffit d'utiliser la commande suivante :
* Pour mirador 2 :
<syntaxhighlight lang="bash">
$ grunt serve
</syntaxhighlight>
* Pour mirador 3 :
<syntaxhighlight lang="bash">
$ npm start
</syntaxhighlight>

Il est ensuite possible d'y accéder via cette url :
<syntaxhighlight lang="bash">
http://localhost/8000
</syntaxhighlight>
En remplaçant "8000" par le port associé au Mirador.

Installation de Mirador

2023-03-03T12:47:43Z

Mhymonet : /* Pour la version 3 avec plugin : */

== Contexte ==
Le but ici est d’installer mirador en local, la méthode est la même pour les version 2 et 3 à quelques exceptions près comme montré dans les étapes ci-dessous.

== Étape de l’installation ==
* Installation de node:
<syntaxhighlight lang="bash">
$ sudo apt install nodejs
</syntaxhighlight>
* Installation de npm :
<syntaxhighlight lang="bash">
$ sudo apt install npm
</syntaxhighlight>
* Installation de grunt :
<syntaxhighlight lang="bash">
$ sudo npm install -g grunt-cli
</syntaxhighlight>
* Clone du projet :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/projectmirador/mirador2
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/ProjectMirador/mirador
</syntaxhighlight>
* Se placer de le dossier :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ cd mirador2/
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ cd mirador/
</syntaxhighlight>
* Installation des dépendances :
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Étape de l’installation pour Mirador 3 et permettre l'utilisation et la création de plugins ==
Pour Mirador 3, si on souhaite pouvoir utiliser et créer des plugins, il faut l'installer d'une certaine manière.
Cette installation nécessitera de pouvoir utiliser la commande "npm".
* Installation de "nwb" :
<syntaxhighlight lang="bash">
$ npm i -g nwb
</syntaxhighlight>
* Installation de Mirador nommée "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ nwb new react-component mirador-demo-plugin
Creating a react-component project...
? Do you want to create an ES modules build for use by compatible bundlers? Yes
? Do you want to create a UMD build for global usage via <script> tag? Yes
? Which global variable should the UMD build set? MiradorDemo
create .gitignore
create .travis.yml
create CONTRIBUTING.md
create README.md
create demo/src/index.js
create nwb.config.js
create package.json
create src/index.js
create tests/.eslintrc
create tests/index-test.js
✔ Installing react and react-dom
</syntaxhighlight>
Après cette installation, nous aurons donc les fichiers de base qui se seront crées.
* Déplacement dans le projet nommé "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ cd mirador-demo-plugin/
</syntaxhighlight>
* Ajouter mirador comme dépendance dev :
<syntaxhighlight lang="bash">
$ npm i --save-dev mirador@alpha
</syntaxhighlight>
Cela va servir à utiliser l'import de mirador pour créer des plugins derrière.
* Vérifier les dépendances :
Pour les vérifier, il suffit de regarder dans le fichier "package.json" qui se trouve à la racine du projet.
On va ici vérifier que les dépendances liés à "mirador", "react" et "react-dom" apparaissent dans la partie "peer dependencies".
<syntaxhighlight lang="html4strict">
{
"peerDependencies": {
"mirador": "^3.0.0-rc.7",
"react": "16.x",
"react-dom": "16.x"
},
"devDependencies": {
"mirador": "^3.0.0-rc.7",
"nwb": "0.23.x"
},
}
</syntaxhighlight>
* Installer les dépendances :
Et enfin, après avoir vérifier qu'elles étaient là, il manque plus qu'à installer les dépendances pour finaliser l'installation.
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Changement de port ==
Pour éviter toutes sortes de conflits avec d'autres application déjà en fonctionnement, il est possible de changer le port sur lequel on souhaite lancer Mirador.
=== Pour les version 2 et 3 : ===
Pour cela, il suffit de le changer dans le fichier suivant, qui se trouve à la racine du projet :
* Pour mirador 2 :
Gruntfile.js
* Pour mirador 3 :
webpack.config.js

=== Pour la version 3 avec plugin ===
Pour cette version, il suffit de modifier la variable d'environnement "PORT", soit en modifiant le fichier ".env" et en lui ajoutant la ligne suivante :
<syntaxhighlight lang="bash">
PORT=3005
</syntaxhighlight>
Soit en utilisant directement une commande :
<syntaxhighlight lang="bash">
$ export PORT=3005
</syntaxhighlight>
Et tout cela en remplaçant bine évidemment "3005" par le port voulu.

== Lancement ==
Pour ensuite lancer Mirador, il suffit d'utiliser la commande suivante :
* Pour mirador 2 :
<syntaxhighlight lang="bash">
$ grunt serve
</syntaxhighlight>
* Pour mirador 3 :
<syntaxhighlight lang="bash">
$ npm start
</syntaxhighlight>

Il est ensuite possible d'y accéder via cette url :
<syntaxhighlight lang="bash">
http://localhost/8000
</syntaxhighlight>
En remplaçant "8000" par le port associé au Mirador.

Installation de Mirador

2023-03-03T12:46:59Z

Mhymonet : /* Changement de port */

== Contexte ==
Le but ici est d’installer mirador en local, la méthode est la même pour les version 2 et 3 à quelques exceptions près comme montré dans les étapes ci-dessous.

== Étape de l’installation ==
* Installation de node:
<syntaxhighlight lang="bash">
$ sudo apt install nodejs
</syntaxhighlight>
* Installation de npm :
<syntaxhighlight lang="bash">
$ sudo apt install npm
</syntaxhighlight>
* Installation de grunt :
<syntaxhighlight lang="bash">
$ sudo npm install -g grunt-cli
</syntaxhighlight>
* Clone du projet :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/projectmirador/mirador2
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/ProjectMirador/mirador
</syntaxhighlight>
* Se placer de le dossier :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ cd mirador2/
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ cd mirador/
</syntaxhighlight>
* Installation des dépendances :
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Étape de l’installation pour Mirador 3 et permettre l'utilisation et la création de plugins ==
Pour Mirador 3, si on souhaite pouvoir utiliser et créer des plugins, il faut l'installer d'une certaine manière.
Cette installation nécessitera de pouvoir utiliser la commande "npm".
* Installation de "nwb" :
<syntaxhighlight lang="bash">
$ npm i -g nwb
</syntaxhighlight>
* Installation de Mirador nommée "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ nwb new react-component mirador-demo-plugin
Creating a react-component project...
? Do you want to create an ES modules build for use by compatible bundlers? Yes
? Do you want to create a UMD build for global usage via <script> tag? Yes
? Which global variable should the UMD build set? MiradorDemo
create .gitignore
create .travis.yml
create CONTRIBUTING.md
create README.md
create demo/src/index.js
create nwb.config.js
create package.json
create src/index.js
create tests/.eslintrc
create tests/index-test.js
✔ Installing react and react-dom
</syntaxhighlight>
Après cette installation, nous aurons donc les fichiers de base qui se seront crées.
* Déplacement dans le projet nommé "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ cd mirador-demo-plugin/
</syntaxhighlight>
* Ajouter mirador comme dépendance dev :
<syntaxhighlight lang="bash">
$ npm i --save-dev mirador@alpha
</syntaxhighlight>
Cela va servir à utiliser l'import de mirador pour créer des plugins derrière.
* Vérifier les dépendances :
Pour les vérifier, il suffit de regarder dans le fichier "package.json" qui se trouve à la racine du projet.
On va ici vérifier que les dépendances liés à "mirador", "react" et "react-dom" apparaissent dans la partie "peer dependencies".
<syntaxhighlight lang="html4strict">
{
"peerDependencies": {
"mirador": "^3.0.0-rc.7",
"react": "16.x",
"react-dom": "16.x"
},
"devDependencies": {
"mirador": "^3.0.0-rc.7",
"nwb": "0.23.x"
},
}
</syntaxhighlight>
* Installer les dépendances :
Et enfin, après avoir vérifier qu'elles étaient là, il manque plus qu'à installer les dépendances pour finaliser l'installation.
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Changement de port ==
Pour éviter toutes sortes de conflits avec d'autres application déjà en fonctionnement, il est possible de changer le port sur lequel on souhaite lancer Mirador.
=== Pour les version 2 et 3 : ===
Pour cela, il suffit de le changer dans le fichier suivant, qui se trouve à la racine du projet :
* Pour mirador 2 :
Gruntfile.js
* Pour mirador 3 :
webpack.config.js

=== Pour la version 3 avec plugin : ===
Pour cette version, il suffit de modifier la variable d'environnement "PORT", soit en modifiant le fichier ".env" et en lui ajoutant la ligne suivante :
<syntaxhighlight lang="bash">
PORT=3005
</syntaxhighlight>
Soit en utilisant directement une commande :
<syntaxhighlight lang="bash">
$ export PORT=3005
</syntaxhighlight>
Et tout cela en remplaçant bine évidemment "3005" par le port voulu.

== Lancement ==
Pour ensuite lancer Mirador, il suffit d'utiliser la commande suivante :
* Pour mirador 2 :
<syntaxhighlight lang="bash">
$ grunt serve
</syntaxhighlight>
* Pour mirador 3 :
<syntaxhighlight lang="bash">
$ npm start
</syntaxhighlight>

Il est ensuite possible d'y accéder via cette url :
<syntaxhighlight lang="bash">
http://localhost/8000
</syntaxhighlight>
En remplaçant "8000" par le port associé au Mirador.

Installation de Mirador

2023-03-03T12:40:08Z

Mhymonet : /* Étape de l’installation pour Mirador 3 et permettre l'utilisation et la création de plugins */

== Contexte ==
Le but ici est d’installer mirador en local, la méthode est la même pour les version 2 et 3 à quelques exceptions près comme montré dans les étapes ci-dessous.

== Étape de l’installation ==
* Installation de node:
<syntaxhighlight lang="bash">
$ sudo apt install nodejs
</syntaxhighlight>
* Installation de npm :
<syntaxhighlight lang="bash">
$ sudo apt install npm
</syntaxhighlight>
* Installation de grunt :
<syntaxhighlight lang="bash">
$ sudo npm install -g grunt-cli
</syntaxhighlight>
* Clone du projet :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/projectmirador/mirador2
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/ProjectMirador/mirador
</syntaxhighlight>
* Se placer de le dossier :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ cd mirador2/
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ cd mirador/
</syntaxhighlight>
* Installation des dépendances :
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Étape de l’installation pour Mirador 3 et permettre l'utilisation et la création de plugins ==
Pour Mirador 3, si on souhaite pouvoir utiliser et créer des plugins, il faut l'installer d'une certaine manière.
Cette installation nécessitera de pouvoir utiliser la commande "npm".
* Installation de "nwb" :
<syntaxhighlight lang="bash">
$ npm i -g nwb
</syntaxhighlight>
* Installation de Mirador nommée "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ nwb new react-component mirador-demo-plugin
Creating a react-component project...
? Do you want to create an ES modules build for use by compatible bundlers? Yes
? Do you want to create a UMD build for global usage via <script> tag? Yes
? Which global variable should the UMD build set? MiradorDemo
create .gitignore
create .travis.yml
create CONTRIBUTING.md
create README.md
create demo/src/index.js
create nwb.config.js
create package.json
create src/index.js
create tests/.eslintrc
create tests/index-test.js
✔ Installing react and react-dom
</syntaxhighlight>
Après cette installation, nous aurons donc les fichiers de base qui se seront crées.
* Déplacement dans le projet nommé "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ cd mirador-demo-plugin/
</syntaxhighlight>
* Ajouter mirador comme dépendance dev :
<syntaxhighlight lang="bash">
$ npm i --save-dev mirador@alpha
</syntaxhighlight>
Cela va servir à utiliser l'import de mirador pour créer des plugins derrière.
* Vérifier les dépendances :
Pour les vérifier, il suffit de regarder dans le fichier "package.json" qui se trouve à la racine du projet.
On va ici vérifier que les dépendances liés à "mirador", "react" et "react-dom" apparaissent dans la partie "peer dependencies".
<syntaxhighlight lang="html4strict">
{
"peerDependencies": {
"mirador": "^3.0.0-rc.7",
"react": "16.x",
"react-dom": "16.x"
},
"devDependencies": {
"mirador": "^3.0.0-rc.7",
"nwb": "0.23.x"
},
}
</syntaxhighlight>
* Installer les dépendances :
Et enfin, après avoir vérifier qu'elles étaient là, il manque plus qu'à installer les dépendances pour finaliser l'installation.
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Changement de port ==
Pour éviter toutes sortes de conflits avec d'autres application déjà en fonctionnement, il est possible de changer le port sur lequel on souhaite lancer Mirador.
Pour cela, il suffit de le changer dans le fichier suivant, qui se trouve à la racine du projet :
* Pour mirador 2 :
Gruntfile.js
* Pour mirador 3 :
webpack.config.js

== Lancement ==
Pour ensuite lancer Mirador, il suffit d'utiliser la commande suivante :
* Pour mirador 2 :
<syntaxhighlight lang="bash">
$ grunt serve
</syntaxhighlight>
* Pour mirador 3 :
<syntaxhighlight lang="bash">
$ npm start
</syntaxhighlight>

Il est ensuite possible d'y accéder via cette url :
<syntaxhighlight lang="bash">
http://localhost/8000
</syntaxhighlight>
En remplaçant "8000" par le port associé au Mirador.

Installation de Mirador

2023-03-03T12:39:53Z

Mhymonet : /* Étape de l’installation pour Mirador 3 et permettre l'utilisation et la création de plugins */

== Contexte ==
Le but ici est d’installer mirador en local, la méthode est la même pour les version 2 et 3 à quelques exceptions près comme montré dans les étapes ci-dessous.

== Étape de l’installation ==
* Installation de node:
<syntaxhighlight lang="bash">
$ sudo apt install nodejs
</syntaxhighlight>
* Installation de npm :
<syntaxhighlight lang="bash">
$ sudo apt install npm
</syntaxhighlight>
* Installation de grunt :
<syntaxhighlight lang="bash">
$ sudo npm install -g grunt-cli
</syntaxhighlight>
* Clone du projet :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/projectmirador/mirador2
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/ProjectMirador/mirador
</syntaxhighlight>
* Se placer de le dossier :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ cd mirador2/
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ cd mirador/
</syntaxhighlight>
* Installation des dépendances :
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Étape de l’installation pour Mirador 3 et permettre l'utilisation et la création de plugins ==
Pour Mirador 3, si on souhaite pouvoir utiliser et créer des plugins, il faut l'installer d'une certaine manière.
Cette installation nécessitera de pouvoir utiliser la commande "npm".
* Installation de "nwb" :
<syntaxhighlight lang="bash">
$ npm i -g nwb
</syntaxhighlight>
* Installation de Mirador nommée "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ nwb new react-component mirador-demo-plugin
Creating a react-component project...
? Do you want to create an ES modules build for use by compatible bundlers? Yes
? Do you want to create a UMD build for global usage via <script> tag? Yes
? Which global variable should the UMD build set? MiradorDemo
create .gitignore
create .travis.yml
create CONTRIBUTING.md
create README.md
create demo/src/index.js
create nwb.config.js
create package.json
create src/index.js
create tests/.eslintrc
create tests/index-test.js
✔ Installing react and react-dom
</syntaxhighlight>
Après cette installation, nous aurons donc les fichiers de base qui se seront crées.
* Déplacement dans le projet nommé "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ cd mirador-demo-plugin/
</syntaxhighlight>
* Ajouter mirador comme dépendance dev :
<syntaxhighlight lang="bash">
$ npm i --save-dev mirador@alpha
</syntaxhighlight>
Cela va servir à utiliser l'import de mirador pour créer des plugins derrière.
* Vérifier les dépendances :
Pour les vérifier, il suffit de regarder dans le fichier "package.json" qui se trouve à la racine du projet.
On va ici vérifier que les dépendances liés à "mirador", "react" et "react-dom" apparaissent dans la partie "peer dependencies".
<syntaxhighlight lang="html4strict">
{
"peerDependencies": {
"mirador": "^3.0.0-rc.7",
"react": "16.x",
"react-dom": "16.x"
},
"devDependencies": {
+ "mirador": "^3.0.0-rc.7",
"nwb": "0.23.x"
},
}
</syntaxhighlight>
* Installer les dépendances :
Et enfin, après avoir vérifier qu'elles étaient là, il manque plus qu'à installer les dépendances pour finaliser l'installation.
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Changement de port ==
Pour éviter toutes sortes de conflits avec d'autres application déjà en fonctionnement, il est possible de changer le port sur lequel on souhaite lancer Mirador.
Pour cela, il suffit de le changer dans le fichier suivant, qui se trouve à la racine du projet :
* Pour mirador 2 :
Gruntfile.js
* Pour mirador 3 :
webpack.config.js

== Lancement ==
Pour ensuite lancer Mirador, il suffit d'utiliser la commande suivante :
* Pour mirador 2 :
<syntaxhighlight lang="bash">
$ grunt serve
</syntaxhighlight>
* Pour mirador 3 :
<syntaxhighlight lang="bash">
$ npm start
</syntaxhighlight>

Il est ensuite possible d'y accéder via cette url :
<syntaxhighlight lang="bash">
http://localhost/8000
</syntaxhighlight>
En remplaçant "8000" par le port associé au Mirador.

Installation de Mirador

2023-03-03T12:39:30Z

Mhymonet : /* Étape de l’installation */

== Contexte ==
Le but ici est d’installer mirador en local, la méthode est la même pour les version 2 et 3 à quelques exceptions près comme montré dans les étapes ci-dessous.

== Étape de l’installation ==
* Installation de node:
<syntaxhighlight lang="bash">
$ sudo apt install nodejs
</syntaxhighlight>
* Installation de npm :
<syntaxhighlight lang="bash">
$ sudo apt install npm
</syntaxhighlight>
* Installation de grunt :
<syntaxhighlight lang="bash">
$ sudo npm install -g grunt-cli
</syntaxhighlight>
* Clone du projet :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/projectmirador/mirador2
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ git clone https://github.com/ProjectMirador/mirador
</syntaxhighlight>
* Se placer de le dossier :
Pour Mirador 2 :
<syntaxhighlight lang="bash">
$ cd mirador2/
</syntaxhighlight>
Pour Mirador 3 :
<syntaxhighlight lang="bash">
$ cd mirador/
</syntaxhighlight>
* Installation des dépendances :
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Étape de l’installation pour Mirador 3 et permettre l'utilisation et la création de plugins ==
Pour Mirador 3, si on souhaite pouvoir utiliser et créer des plugins, il faut l'installer d'une certaine manière.
Cette installation nécessitera de pouvoir utiliser la commande "npm".
* Installation de "nwb" :
<syntaxhighlight lang="bash">
$ npm i -g nwb
</syntaxhighlight>
* Installation de Mirador nommée "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ nwb new react-component mirador-demo-plugin
Creating a react-component project...
? Do you want to create an ES modules build for use by compatible bundlers? Yes
? Do you want to create a UMD build for global usage via <script> tag? Yes
? Which global variable should the UMD build set? MiradorDemo
create .gitignore
create .travis.yml
create CONTRIBUTING.md
create README.md
create demo/src/index.js
create nwb.config.js
create package.json
create src/index.js
create tests/.eslintrc
create tests/index-test.js
✔ Installing react and react-dom
</syntaxhighlight>
Après cette installation, nous aurons donc les fichiers de base qui se seront crées.
* Déplacement dans le projet nommé "mirador-demo-plugin":
<syntaxhighlight lang="bash">
$ cd mirador-demo-plugin/
</syntaxhighlight>
* Ajouter mirador comme dépendance dev :
<syntaxhighlight lang="bash">
$ npm i --save-dev mirador@alpha
</syntaxhighlight>
Cela va servir à utiliser l'import de mirador pour créer des plugins derrière.
* Vérifier les dépendances :
Pour les vérifier, il suffit de regarder dans le fichier "package.json" qui se trouve à la racine du projet.
On va ici vérifier que les dépendances liés à "mirador", "react" et "react-dom" apparaissent dans la partie "peer dependencies".
<syntaxhighlight lang="json">
{
"peerDependencies": {
"mirador": "^3.0.0-rc.7",
"react": "16.x",
"react-dom": "16.x"
},
"devDependencies": {
+ "mirador": "^3.0.0-rc.7",
"nwb": "0.23.x"
},
}
</syntaxhighlight>
* Installer les dépendances :
Et enfin, après avoir vérifier qu'elles étaient là, il manque plus qu'à installer les dépendances pour finaliser l'installation.
<syntaxhighlight lang="bash">
$ npm install
</syntaxhighlight>

== Changement de port ==
Pour éviter toutes sortes de conflits avec d'autres application déjà en fonctionnement, il est possible de changer le port sur lequel on souhaite lancer Mirador.
Pour cela, il suffit de le changer dans le fichier suivant, qui se trouve à la racine du projet :
* Pour mirador 2 :
Gruntfile.js
* Pour mirador 3 :
webpack.config.js

== Lancement ==
Pour ensuite lancer Mirador, il suffit d'utiliser la commande suivante :
* Pour mirador 2 :
<syntaxhighlight lang="bash">
$ grunt serve
</syntaxhighlight>
* Pour mirador 3 :
<syntaxhighlight lang="bash">
$ npm start
</syntaxhighlight>

Il est ensuite possible d'y accéder via cette url :
<syntaxhighlight lang="bash">
http://localhost/8000
</syntaxhighlight>
En remplaçant "8000" par le port associé au Mirador.

Création de plugin pour Mirador

2023-02-28T15:17:13Z

Mhymonet : /* Conventions */

Création de plugin pour Mirador

2023-02-28T15:12:36Z

Mhymonet : Page créée avec « == Contexte == Ici nous allons chercher à créer un plugin pour Mirador ainsi que l'intégrer. == Création d'un plugin == === Conventions === Dans un premier temps, il ... »

Configuration de Mirador

2023-02-24T12:36:06Z

Mhymonet : /* Apparence et fonctionnalités */

Configuration de Mirador

2023-02-24T12:35:21Z

Mhymonet : /* Apparence */

== Contexte ==
Ici nous allons chercher à configurer Mirador 2 et 3 après l’installation.

== Manifest au chargement et collection de manifest ==
* Pour Mirador 2 :
Dans un premier temps on va chercher à afficher un certain manifest soit via la collection de manifest déjà présente dans la visionneuse, soit directement au chargement de Mirador.
Pour ce faire, il va falloir éditer ce fichier, qui se trouve à la racine :
<syntaxhighlight lang="bash">
index.html
</syntaxhighlight>
Ensuite, dans la partie “data” de la fonction, c’est là ou nous allons trouver la collection de manifest mis à disposition de la visionneuse avec les paramètres suivants :
# “manifestUri” : le lien vers le manifest, généralement au format json
# “location” : qui n’est pas obligatoir et ou on y indique la provenance du manifest
Plus bas ensuite, si on souhaite charger un manifest dès le lancement de la visionneuse, on trouvera au même titre que “data”, une partie “windowObjects” qui peut contenir :
# "loadedManifest" : comme pour “data”, le lien vers le manifest
# "viewType" : qui sera le type d’affichage qui est par défault sur “ImageView"
# “canvasID” : le lien de la page du manifest que l’on souhaite afficher qui est par défaut sur la première

Infos : A savoir que le chargement d'un manifest de "https://pandor.u-bourgogne.fr" a été impossible, le retour n'affiche même aucune message alors que pour un manifest de "https://archives.lamayenne.fr" il n'affiche toujours pas le manifest mais au moins retourne un message d'erreur.

* Pour Mirador 3 :
Il faut tout d'abord savoir qu'avec Mirador 3, si on souhaite changer les manifest à disposition, il faut forcément l'intégrer à une autre page html ou javascript et ce en lui ajoutant le script :
<syntaxhighlight lang="html4strict">
<script src="https://unpkg.com/mirador@latest/dist/mirador.min.js"></script>
</syntaxhighlight>
et ensuite il est possible de lui fournir une certaine configuration comme ci-dessous :
<syntaxhighlight lang="html4strict">
<script type="text/javascript">
var mirador = Mirador.viewer({
"id": "my-mirador",
"manifests": {
"https://iiif.lib.harvard.edu/manifests/drs:48309543": {
"provider": "Harvard University"
},
"https://pandor.u-bourgogne.fr/archives-en-ligne/iiif/ark:/62246/r22057zlv55psk/manifest.json": {
"provider": "Bourgogne"
}

},
"windows": [
{
"loadedManifest": "https://pandor.u-bourgogne.fr/archives-en-ligne/iiif/ark:/62246/r22057zlv55psk/manifest.json",
"canvasIndex": 1,
"thumbnailNavigationPosition": 'far-bottom'
}
]
});
</script>
</syntaxhighlight>
On retrouve donc après les mêmes choses que pour la version à ceci prêt quelques changement au niveau de la syntaxe :
# “data”, la collection devient "manifests" et on peut directement spécifier l'url après
# “location”, la provenance du manifest devient "provider"
# “windowObjects”, ce qu'il y a à charger au lancement devient "windows"
# “canvasID”, le canva du manifest à afficher en premier devient "canvasIndex"

Infos : Avec cette version, le chargement d'un manifest de "https://pandor.u-bourgogne.fr" ne pose pas de problème.

== Apparence et fonctionnalités ==
Ensuite pour tout ce qui est de la configuration visuel, cela va se faire dans un autre fichier.
* Pour Mirador 2 :
Pour Mirador 2, on va pouvoir modifier les fonctionnalités disponibles dans le même fichier que pour les manifest, en les mettant ensuite soit à "true" si on veut les activer soit à "false" si on ne le veut pas :
<syntaxhighlight lang="html4strict">
"tocTabAvailable": true,
"layersTabAvailable": true,
"searchTabAvailable": true,
"annotations" : true
</syntaxhighlight>

* Pour Mirador 3 :
Ensuite pour tout ce qui est de la configuration visuel de Mirador 3, cela va se faire dans un autre fichier :
<syntaxhighlight lang="bash">
src/config/settings.js
</syntaxhighlight>
Il y aura tout ce qui correspond au thème, aux couleurs des texte, au tailles, etc, comme le montre un extrait ci-dessous :
<syntaxhighlight lang="html4strict">
themes: {
dark: {
palette: {
type: 'dark',
primary: {
main: '#4db6ac',
},
secondary: {
main: '#4db6ac',
},
shades: {
dark: '#000000',
main: '#424242',
light: '#616161',
}
}
},
light: {
palette: {
type: 'light',
}
}
},
</syntaxhighlight>
Puis enfin plus bas, on retrouve tout ce qui est en rapport avec l'activation ou non de certaines fonctionnalités liées à la visionneuse, comme montré ci-dessous :
<syntaxhighlight lang="html4strict">
allowClose: true, // Configure if windows can be closed or not
allowFullscreen: false, // Configure to show a "fullscreen" button in the WindowTopBar
allowMaximize: true, // Configure if windows can be maximized or not
allowTopMenuButton: true, // Configure if window view and thumbnail display menu are visible or not
allowWindowSideBar: true, // Configure if side bar menu is visible or not
authNewWindowCenter: 'parent', // Configure how to center a new window created by the authentication flow. Options: parent, screen
sideBarPanel: 'info', // Configure which sidebar is selected by default. Options: info, attribution, canvas, annotations, search
defaultSidebarPanelHeight: 201, // Configure default sidebar height in pixels
defaultSidebarPanelWidth: 235, // Configure default sidebar width in pixels
defaultView: 'single', // Configure which viewing mode (e.g. single, book, gallery) for windows to be opened in
forceDrawAnnotations: true,
</syntaxhighlight>
Note : A savoir qu'il est possible de modifier ces valeurs dans le même fichier que là ou on change les manifest si Mirador 3 est intégré dans un autre fichier.

Configuration de Mirador

2023-02-24T12:30:12Z

Mhymonet : /* Manifest au chargement et collection de manifest */

== Contexte ==
Ici nous allons chercher à configurer Mirador 2 et 3 après l’installation.

== Manifest au chargement et collection de manifest ==
* Pour Mirador 2 :
Dans un premier temps on va chercher à afficher un certain manifest soit via la collection de manifest déjà présente dans la visionneuse, soit directement au chargement de Mirador.
Pour ce faire, il va falloir éditer ce fichier, qui se trouve à la racine :
<syntaxhighlight lang="bash">
index.html
</syntaxhighlight>
Ensuite, dans la partie “data” de la fonction, c’est là ou nous allons trouver la collection de manifest mis à disposition de la visionneuse avec les paramètres suivants :
# “manifestUri” : le lien vers le manifest, généralement au format json
# “location” : qui n’est pas obligatoir et ou on y indique la provenance du manifest
Plus bas ensuite, si on souhaite charger un manifest dès le lancement de la visionneuse, on trouvera au même titre que “data”, une partie “windowObjects” qui peut contenir :
# "loadedManifest" : comme pour “data”, le lien vers le manifest
# "viewType" : qui sera le type d’affichage qui est par défault sur “ImageView"
# “canvasID” : le lien de la page du manifest que l’on souhaite afficher qui est par défaut sur la première

Infos : A savoir que le chargement d'un manifest de "https://pandor.u-bourgogne.fr" a été impossible, le retour n'affiche même aucune message alors que pour un manifest de "https://archives.lamayenne.fr" il n'affiche toujours pas le manifest mais au moins retourne un message d'erreur.

* Pour Mirador 3 :
Il faut tout d'abord savoir qu'avec Mirador 3, si on souhaite changer les manifest à disposition, il faut forcément l'intégrer à une autre page html ou javascript et ce en lui ajoutant le script :
<syntaxhighlight lang="html4strict">
<script src="https://unpkg.com/mirador@latest/dist/mirador.min.js"></script>
</syntaxhighlight>
et ensuite il est possible de lui fournir une certaine configuration comme ci-dessous :
<syntaxhighlight lang="html4strict">
<script type="text/javascript">
var mirador = Mirador.viewer({
"id": "my-mirador",
"manifests": {
"https://iiif.lib.harvard.edu/manifests/drs:48309543": {
"provider": "Harvard University"
},
"https://pandor.u-bourgogne.fr/archives-en-ligne/iiif/ark:/62246/r22057zlv55psk/manifest.json": {
"provider": "Bourgogne"
}

},
"windows": [
{
"loadedManifest": "https://pandor.u-bourgogne.fr/archives-en-ligne/iiif/ark:/62246/r22057zlv55psk/manifest.json",
"canvasIndex": 1,
"thumbnailNavigationPosition": 'far-bottom'
}
]
});
</script>
</syntaxhighlight>
On retrouve donc après les mêmes choses que pour la version à ceci prêt quelques changement au niveau de la syntaxe :
# “data”, la collection devient "manifests" et on peut directement spécifier l'url après
# “location”, la provenance du manifest devient "provider"
# “windowObjects”, ce qu'il y a à charger au lancement devient "windows"
# “canvasID”, le canva du manifest à afficher en premier devient "canvasIndex"

Infos : Avec cette version, le chargement d'un manifest de "https://pandor.u-bourgogne.fr" ne pose pas de problème.

== Apparence ==
Ensuite pour tout ce qui est de la configuration visuel, cela va se faire dans un autre fichier.
* Pour Mirador 3 :
On va pouvoir modifier plusieurs valeurs dans ce fichier :
<syntaxhighlight lang="bash">
src/config/settings.js
</syntaxhighlight>
Il y aura tout ce qui correspond au thème, aux couleurs des texte, au tailles, etc, comme le montre un extrait ci-dessous :
<syntaxhighlight lang="html4strict">
themes: {
dark: {
palette: {
type: 'dark',
primary: {
main: '#4db6ac',
},
secondary: {
main: '#4db6ac',
},
shades: {
dark: '#000000',
main: '#424242',
light: '#616161',
}
}
},
light: {
palette: {
type: 'light',
}
}
},
</syntaxhighlight>
Puis enfin plus bas, on retrouve tout ce qui est en rapport avec l'activation ou non de certaines fonctionnalités liées à la visionneuse, comme montré ci-dessous :
<syntaxhighlight lang="html4strict">
allowClose: true, // Configure if windows can be closed or not
allowFullscreen: false, // Configure to show a "fullscreen" button in the WindowTopBar
allowMaximize: true, // Configure if windows can be maximized or not
allowTopMenuButton: true, // Configure if window view and thumbnail display menu are visible or not
allowWindowSideBar: true, // Configure if side bar menu is visible or not
authNewWindowCenter: 'parent', // Configure how to center a new window created by the authentication flow. Options: parent, screen
sideBarPanel: 'info', // Configure which sidebar is selected by default. Options: info, attribution, canvas, annotations, search
defaultSidebarPanelHeight: 201, // Configure default sidebar height in pixels
defaultSidebarPanelWidth: 235, // Configure default sidebar width in pixels
defaultView: 'single', // Configure which viewing mode (e.g. single, book, gallery) for windows to be opened in
forceDrawAnnotations: true,
</syntaxhighlight>

Configuration de Mirador

2023-02-23T14:54:31Z

Mhymonet : /* Manifest au chargement et collection de manifest */

Configuration de Mirador

2023-02-23T14:51:19Z

Mhymonet : /* Manifest au chargement et collection de manifest */

Configuration de Mirador

2023-02-22T15:30:01Z

Mhymonet : Page créée avec « == Contexte == Ici nous allons chercher à configurer Mirador 2 et 3 après l’installation. == Manifest au chargement et collection de manifest == * Pour Mirador 2 : ... »

Installation de Mirador

2023-02-21T15:20:15Z

Mhymonet : /* Étape de l’installation */

Installation de Mirador

2023-02-21T15:19:52Z

Mhymonet : /* Étape de l’installation */

Installation de Mirador

2023-02-21T15:19:15Z

Mhymonet : /* Lancement */

Installation de Mirador

2023-02-21T15:19:02Z

Mhymonet : /* Lancement */

Installation de Mirador

2023-02-21T15:15:46Z

Mhymonet : /* Étape de l’installation */

Installation de Mirador

2023-02-21T15:15:03Z

Mhymonet : Page créée avec « == Contexte == Le but ici est d’installer mirador en local, la méthode est la même pour les version 2 et 3 à quelques exceptions près comme montré dans les étapes ... »

Script flv to mp4

2022-09-16T11:02:23Z

Mhymonet : /* Script de conversion */

== Utilisation du script ==

Pour utiliser le script, il faut d'abords faire une sauvegarde des différents flv grâce qu script de copie et ensuite utiliser le script de conversion pour les convertir en mp4.

== Script de copie ==

A utilisé de cette manière : ./sopy.sh <Dossier avec les flv à copier> <Dossier ou les flv doivent être copiés>

Contenu :
<syntaxhighlight lang="bash">
rsync -a --prune-empty-dirs --include '*/' --include '*.flv' --exclude '*' "$1" "$2"
</syntaxhighlight>

== Script de conversion ==

A utilisé de cette manière : ./script.sh <Dossier avec les flv à convertir>

Contenu :
<syntaxhighlight lang="bash">
#!/bin/bash
readlink -f /proc/$$/exe | grep -q bash || {
exit 2
}

find "$1" -type f -name '*.flv' -exec sh -c '
# On boucle sur le find
for flvsfile; do
file=${flvsfile#flvs/}
# Conversion + écriture des log
< /dev/null ffmpeg -i "$flvsfile" "${file%flv}"mp4 2>&1 | tee log.txt
printf %s\\n "$flvsfile MP4 done."
rm "$flvsfile"
done
' _ {} +
</syntaxhighlight>

Remarques :
* La conversion de flv à mp4 divise la taille par 4 un peur près.
* Pour connaitre le nombre de fichier flv dans un dossier :
<syntaxhighlight lang="bash">
$ ls -lR /var/data/flv/ | grep ".flv$" | wc -l
</syntaxhighlight>
* Pour savoir combien de fichiers avec l’extension .mp4 de manière récursive depuis hier (-mtime -1 et avant hier -2,..) :
<syntaxhighlight lang="bash">
$ find /var/data/files/ -name "*.mp4" -type f -mtime -1 -print | wc -l
</syntaxhighlight>

Script flv to mp4

2022-09-16T11:01:44Z

Mhymonet : /* Script de conversion */

== Utilisation du script ==

Pour utiliser le script, il faut d'abords faire une sauvegarde des différents flv grâce qu script de copie et ensuite utiliser le script de conversion pour les convertir en mp4.

== Script de copie ==

A utilisé de cette manière : ./sopy.sh <Dossier avec les flv à copier> <Dossier ou les flv doivent être copiés>

Contenu :
<syntaxhighlight lang="bash">
rsync -a --prune-empty-dirs --include '*/' --include '*.flv' --exclude '*' "$1" "$2"
</syntaxhighlight>

== Script de conversion ==

A utilisé de cette manière : ./script.sh <Dossier avec les flv à convertir>

Contenu :
<syntaxhighlight lang="bash">
#!/bin/bash
readlink -f /proc/$$/exe | grep -q bash || {
exit 2
}

find "$1" -type f -name '*.flv' -exec sh -c '
# On boucle sur le find
for flvsfile; do
file=${flvsfile#flvs/}
# Conversion + écriture des log
< /dev/null ffmpeg -i "$flvsfile" "${file%flv}"mp4 2>&1 | tee log.txt
printf %s\\n "$flvsfile MP4 done."
rm "$flvsfile"
done
' _ {} +
</syntaxhighlight>

Remarques :
* La conversion de flv à mp4 divise la taille par 4 un peur près.
* Pour connaitre le nombre de fichier flv dans un dossier :
<syntaxhighlight lang="bash">
$ ls -lR /var/data/flv/ | grep ".flv$" | wc -l
</syntaxhighlight>
* Pour savoir combien de fichiers avec l’extension .mp4 de manière récursive depuis hier (-mtime -1 et avant hier -2,..) :
$ find /var/data/files/ -name "*.mp4" -type f -mtime -1 -print | wc -l

Script flv to mp4

2022-09-16T10:54:18Z

Mhymonet : Page créée avec « == Utilisation du script == Pour utiliser le script, il faut d'abords faire une sauvegarde des différents flv grâce qu script de copie et ensuite utiliser le script de ... »

Script de maintenance Tomcat

2022-06-09T13:36:51Z

Mhymonet : /* Paramètres du code java */

== Utilité du script ==
Une des pannes les plus fréquentes des applications Pleade est l'arrêt de Tomcat. Dans ce cas, l'application Pleade n'est plus fonctionnelle et elle renvoie une erreur de type 403.

Ces arrêts sont souvent dus à un manque de ressources en mémoire attribuée à JAVA.

Ce manque de ressource déclenche une OutOfMemory, l'arrêt de Tomcat et de l'application Pleade.

La cause de l'OutOfMemory est liée soit : à une publication dans Pleade qui consomme toutes les ressources ; à la fréquentation importante de l'application ; à la combinaison de tous ces facteurs.

Le script de maintenance de Tomcat permet de suivre automatiquement le fonctionnement de Tomcat, de repérer les pannes et de relancer Tomcat en cas d'arrêt.

Il s’exécute toutes les 30 minutes et vérifie le bon fonctionnement d'une application Tomcat donnée.

Si Tomcat ne fonctionne pas correctement, le script effectue certaines actions comme :
* supprimer des fichiers bloquants (donc le write.lock et le restart.lck présents dans le datatdirs),
* supprimer le cache et redémarrer,
* envoyer un mail s'il y a eu un problème.

== Installation du script ==
Version de java nécessaire : ≥7

Les sources java du script se trouvent sur le svn, sous le nom de "maintenance_tomcat".

Après avoir récupéré les sources et les avoir placé dans un répertoire de l'utilisateur qui les exécutera, on défini les instructions du script dans le Crontab de l'utilisateur (comme par exemple ajlsm).
On appelle le crontab avec la commande :
<syntaxhighlight lang="bash">$ crontab -e</syntaxhighlight>

Il faut adapter les instructions en fonction des projets et en suivant les explications du script.
# Voir "Explication du script" pour plus de détails.[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Explication_du_script[1]]

== Explication du script ==
Voici un exemple de script :
<syntaxhighlight lang="bash">
*/30 * * * * java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"
</syntaxhighlight>

* La première instruction définie la fréquence de rotation du script. Par exemple, toutes les 30 minutes :
<syntaxhighlight lang="bash">*/30 * * * *</syntaxhighlight>

* Ensuite, tous les paramètres nécessaires pour exécuter la commande.
#Voir "Paramètres du code java" pour plus d'explication sur les paramètres.[[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Param.C3.A8tres_du_code_java]]

== Paramètres du code java ==
Afin de s’exécuter, le script à besoin de renseigner au code java certains paramètres, dans le crontab, comme ici :
<syntaxhighlight lang="bash">java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"</syntaxhighlight>
On a donc :
{| class="wikitable"
|-
! Paramètre !! Description
|-
| {{var|-cp}} || Le chemin vers chaque librairie dont le script a besoin séparés à chaque de ":" avec toute suite après, le chemin vers le script à exécuter,
|-
| {{var|-tomcat-path}} || Le chemin vers le dossier Tomcat qu'utilise l'application.
|-
| {{var|-nb-try-http}} || Nombre d'essais retournant une erreur avant effectuer les actions du script.
|-
| {{var|-mail}} || L'adresse courriel de destination de l'alerte.
|-
| {{var|-app-url}} || L'URL d'une page de l'application Pleade à tester (liée au Tomcat). Si la page répond : OK, si la page ne répond pas, NOK : déclenchement des actions.
|-
| {{var|-datadirs-path}} || Le PATH du répertoire où sont écrits les données lors des processus d'indexation de Pleade et où sont écrits des verrous (selon l'état de fonctionnement de Pleade).
|-
| {{var|-restart-path}} || Le PATH du script de redémarrage de Tomcat.
|}

Script de maintenance Tomcat

2022-06-09T13:35:40Z

Mhymonet : /* Utilité du script */

== Utilité du script ==
Une des pannes les plus fréquentes des applications Pleade est l'arrêt de Tomcat. Dans ce cas, l'application Pleade n'est plus fonctionnelle et elle renvoie une erreur de type 403.

Ces arrêts sont souvent dus à un manque de ressources en mémoire attribuée à JAVA.

Ce manque de ressource déclenche une OutOfMemory, l'arrêt de Tomcat et de l'application Pleade.

La cause de l'OutOfMemory est liée soit : à une publication dans Pleade qui consomme toutes les ressources ; à la fréquentation importante de l'application ; à la combinaison de tous ces facteurs.

Le script de maintenance de Tomcat permet de suivre automatiquement le fonctionnement de Tomcat, de repérer les pannes et de relancer Tomcat en cas d'arrêt.

Il s’exécute toutes les 30 minutes et vérifie le bon fonctionnement d'une application Tomcat donnée.

Si Tomcat ne fonctionne pas correctement, le script effectue certaines actions comme :
* supprimer des fichiers bloquants (donc le write.lock et le restart.lck présents dans le datatdirs),
* supprimer le cache et redémarrer,
* envoyer un mail s'il y a eu un problème.

== Installation du script ==
Version de java nécessaire : ≥7

Les sources java du script se trouvent sur le svn, sous le nom de "maintenance_tomcat".

Après avoir récupéré les sources et les avoir placé dans un répertoire de l'utilisateur qui les exécutera, on défini les instructions du script dans le Crontab de l'utilisateur (comme par exemple ajlsm).
On appelle le crontab avec la commande :
<syntaxhighlight lang="bash">$ crontab -e</syntaxhighlight>

Il faut adapter les instructions en fonction des projets et en suivant les explications du script.
# Voir "Explication du script" pour plus de détails.[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Explication_du_script[1]]

== Explication du script ==
Voici un exemple de script :
<syntaxhighlight lang="bash">
*/30 * * * * java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"
</syntaxhighlight>

* La première instruction définie la fréquence de rotation du script. Par exemple, toutes les 30 minutes :
<syntaxhighlight lang="bash">*/30 * * * *</syntaxhighlight>

* Ensuite, tous les paramètres nécessaires pour exécuter la commande.
#Voir "Paramètres du code java" pour plus d'explication sur les paramètres.[[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Param.C3.A8tres_du_code_java]]

== Paramètres du code java ==
Afin de s’exécuter, le script à besoin de renseigner au code java certains paramètres, dans le crontab, comme ici :
<syntaxhighlight lang="bash">java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"</syntaxhighlight>
On a donc :
{| class="wikitable"
|-
! Paramètre !! Description
|-
| {{var|-cp}} || Le chemin vers chaque librairie dont le script a besoin séparés à chaque de ":" avec toute suite après, le chemin vers le script à exécuter,
|-
| {{var|-tomcat-path}} || Le chemin vers le dossier Tomcat qu'utilise l'application.
|-
| {{var|-nb-try-http}} || Nombre d'essais avant...
|-
| {{var|-mail}} || L'adresse courriel de destination de l'alerte.
|-
| {{var|-app-url}} || L'URL d'une page de l'application Pleade à tester (liée au Tomcat). Si la page répond : OK, si la page ne répond pas, NOK : déclenchement des actions.
|-
| {{var|-datadirs-path}} || Le PATH du répertoire où sont écrits les données lors des processus d'indexation de Pleade et où sont écrits des verrous (selon l'état de fonctionnement de Pleade).
|-
| {{var|-restart-path}} || Le PATH du script de redémarrage de Tomcat.
|}

Script de maintenance Tomcat

2022-06-09T13:34:17Z

Mhymonet : /* Utilité du script */

== Utilité du script ==
Une des pannes les plus fréquentes des applications Pleade est l'arrêt de Tomcat. Dans ce cas, l'application Pleade n'est plus fonctionnelle et elle renvoie une erreur de type 403.

Ces arrêts sont souvent dus à un manque de ressources en mémoire attribuée à JAVA.

Ce manque de ressource déclenche une OutOfMemory, l'arrêt de Tomcat et de l'application Pleade.

La cause de l'OutOfMemory est liée soit : à une publication dans Pleade qui consomme toutes les ressources ; à la fréquentation importante de l'application ; à la combinaison de tous ces facteurs.

Le script de maintenance de Tomcat permet de suivre automatiquement le fonctionnement de Tomcat, de repérer les pannes et de relancer Tomcat en cas d'arrêt.

Il s’exécute toutes les 30 minutes et vérifie le bon fonctionnement d'une application Tomcat donnée.

Si Tomcat ne fonctionne pas correctement, le script effectue certaines actions comme :
* supprimer des fichiers bloquants,
* supprimer le cache et redémarrer,
* envoyer un mail s'il y a eu un problème.
[[Fichier:Diagrammes_Script.png|1000px]]

== Installation du script ==
Version de java nécessaire : ≥7

Les sources java du script se trouvent sur le svn, sous le nom de "maintenance_tomcat".

Après avoir récupéré les sources et les avoir placé dans un répertoire de l'utilisateur qui les exécutera, on défini les instructions du script dans le Crontab de l'utilisateur (comme par exemple ajlsm).
On appelle le crontab avec la commande :
<syntaxhighlight lang="bash">$ crontab -e</syntaxhighlight>

Il faut adapter les instructions en fonction des projets et en suivant les explications du script.
# Voir "Explication du script" pour plus de détails.[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Explication_du_script[1]]

== Explication du script ==
Voici un exemple de script :
<syntaxhighlight lang="bash">
*/30 * * * * java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"
</syntaxhighlight>

* La première instruction définie la fréquence de rotation du script. Par exemple, toutes les 30 minutes :
<syntaxhighlight lang="bash">*/30 * * * *</syntaxhighlight>

* Ensuite, tous les paramètres nécessaires pour exécuter la commande.
#Voir "Paramètres du code java" pour plus d'explication sur les paramètres.[[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Param.C3.A8tres_du_code_java]]

== Paramètres du code java ==
Afin de s’exécuter, le script à besoin de renseigner au code java certains paramètres, dans le crontab, comme ici :
<syntaxhighlight lang="bash">java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"</syntaxhighlight>
On a donc :
{| class="wikitable"
|-
! Paramètre !! Description
|-
| {{var|-cp}} || Le chemin vers chaque librairie dont le script a besoin séparés à chaque de ":" avec toute suite après, le chemin vers le script à exécuter,
|-
| {{var|-tomcat-path}} || Le chemin vers le dossier Tomcat qu'utilise l'application.
|-
| {{var|-nb-try-http}} || Nombre d'essais avant...
|-
| {{var|-mail}} || L'adresse courriel de destination de l'alerte.
|-
| {{var|-app-url}} || L'URL d'une page de l'application Pleade à tester (liée au Tomcat). Si la page répond : OK, si la page ne répond pas, NOK : déclenchement des actions.
|-
| {{var|-datadirs-path}} || Le PATH du répertoire où sont écrits les données lors des processus d'indexation de Pleade et où sont écrits des verrous (selon l'état de fonctionnement de Pleade).
|-
| {{var|-restart-path}} || Le PATH du script de redémarrage de Tomcat.
|}

Fichier:Diagrammes Script.png

2022-06-09T13:32:21Z

Mhymonet :

Script de maintenance Tomcat

2022-06-09T13:31:49Z

Mhymonet : /* Utilité du script */

== Utilité du script ==
Une des pannes les plus fréquentes des applications Pleade est l'arrêt de Tomcat. Dans ce cas, l'application Pleade n'est plus fonctionnelle et elle renvoie une erreur de type 403.

Ces arrêts sont souvent dus à un manque de ressources en mémoire attribuée à JAVA.

Ce manque de ressource déclenche une OutOfMemory, l'arrêt de Tomcat et de l'application Pleade.

La cause de l'OutOfMemory est liée soit : à une publication dans Pleade qui consomme toutes les ressources ; à la fréquentation importante de l'application ; à la combinaison de tous ces facteurs.

Le script de maintenance de Tomcat permet de suivre automatiquement le fonctionnement de Tomcat, de repérer les pannes et de relancer Tomcat en cas d'arrêt.

Il s’exécute toutes les 30 minutes et vérifie le bon fonctionnement d'une application Tomcat donnée.

Si Tomcat ne fonctionne pas correctement, le script effectue certaines actions comme :
* supprimer des fichiers bloquants,
* supprimer le cache et redémarrer,
* envoyer un mail s'il y a eu un problème.
[[Fichier:Diagrammes_Script.png]]

== Installation du script ==
Version de java nécessaire : ≥7

Les sources java du script se trouvent sur le svn, sous le nom de "maintenance_tomcat".

Après avoir récupéré les sources et les avoir placé dans un répertoire de l'utilisateur qui les exécutera, on défini les instructions du script dans le Crontab de l'utilisateur (comme par exemple ajlsm).
On appelle le crontab avec la commande :
<syntaxhighlight lang="bash">$ crontab -e</syntaxhighlight>

Il faut adapter les instructions en fonction des projets et en suivant les explications du script.
# Voir "Explication du script" pour plus de détails.[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Explication_du_script[1]]

== Explication du script ==
Voici un exemple de script :
<syntaxhighlight lang="bash">
*/30 * * * * java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"
</syntaxhighlight>

* La première instruction définie la fréquence de rotation du script. Par exemple, toutes les 30 minutes :
<syntaxhighlight lang="bash">*/30 * * * *</syntaxhighlight>

* Ensuite, tous les paramètres nécessaires pour exécuter la commande.
#Voir "Paramètres du code java" pour plus d'explication sur les paramètres.[[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Param.C3.A8tres_du_code_java]]

== Paramètres du code java ==
Afin de s’exécuter, le script à besoin de renseigner au code java certains paramètres, dans le crontab, comme ici :
<syntaxhighlight lang="bash">java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"</syntaxhighlight>
On a donc :
{| class="wikitable"
|-
! Paramètre !! Description
|-
| {{var|-cp}} || Le chemin vers chaque librairie dont le script a besoin séparés à chaque de ":" avec toute suite après, le chemin vers le script à exécuter,
|-
| {{var|-tomcat-path}} || Le chemin vers le dossier Tomcat qu'utilise l'application.
|-
| {{var|-nb-try-http}} || Nombre d'essais avant...
|-
| {{var|-mail}} || L'adresse courriel de destination de l'alerte.
|-
| {{var|-app-url}} || L'URL d'une page de l'application Pleade à tester (liée au Tomcat). Si la page répond : OK, si la page ne répond pas, NOK : déclenchement des actions.
|-
| {{var|-datadirs-path}} || Le PATH du répertoire où sont écrits les données lors des processus d'indexation de Pleade et où sont écrits des verrous (selon l'état de fonctionnement de Pleade).
|-
| {{var|-restart-path}} || Le PATH du script de redémarrage de Tomcat.
|}

Script de maintenance Tomcat

2022-06-09T12:48:34Z

Mhymonet : /* Utilité du script */

== Utilité du script ==
Une des pannes les plus fréquentes des applications Pleade est l'arrêt de Tomcat. Dans ce cas, l'application Pleade n'est plus fonctionnelle et elle renvoie une erreur de type 403.

Ces arrêts sont souvent dus à un manque de ressources en mémoire attribuée à JAVA.

Ce manque de ressource déclenche une OutOfMemory, l'arrêt de Tomcat et de l'application Pleade.

La cause de l'OutOfMemory est liée soit : à une publication dans Pleade qui consomme toutes les ressources ; à la fréquentation importante de l'application ; à la combinaison de tous ces facteurs.

Le script de maintenance de Tomcat permet de suivre automatiquement le fonctionnement de Tomcat, de repérer les pannes et de relancer Tomcat en cas d'arrêt.

Il s’exécute toutes les 30 minutes et vérifie le bon fonctionnement d'une application Tomcat donnée.

Si Tomcat ne fonctionne pas correctement, le script effectue certaines actions comme :
* supprimer des fichiers bloquants,
* supprimer le cache et redémarrer,
* envoyer un mail s'il y a eu un problème.
[[Fichier:Diagrammes_Script maintenance_Tomcat-Activité_Script.drawio.png|500px]]

== Installation du script ==
Version de java nécessaire : ≥7

Les sources java du script se trouvent sur le svn, sous le nom de "maintenance_tomcat".

Après avoir récupéré les sources et les avoir placé dans un répertoire de l'utilisateur qui les exécutera, on défini les instructions du script dans le Crontab de l'utilisateur (comme par exemple ajlsm).
On appelle le crontab avec la commande :
<syntaxhighlight lang="bash">$ crontab -e</syntaxhighlight>

Il faut adapter les instructions en fonction des projets et en suivant les explications du script.
# Voir "Explication du script" pour plus de détails.[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Explication_du_script[1]]

== Explication du script ==
Voici un exemple de script :
<syntaxhighlight lang="bash">
*/30 * * * * java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"
</syntaxhighlight>

* La première instruction définie la fréquence de rotation du script. Par exemple, toutes les 30 minutes :
<syntaxhighlight lang="bash">*/30 * * * *</syntaxhighlight>

* Ensuite, tous les paramètres nécessaires pour exécuter la commande.
#Voir "Paramètres du code java" pour plus d'explication sur les paramètres.[[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Param.C3.A8tres_du_code_java]]

== Paramètres du code java ==
Afin de s’exécuter, le script à besoin de renseigner au code java certains paramètres, dans le crontab, comme ici :
<syntaxhighlight lang="bash">java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"</syntaxhighlight>
On a donc :
{| class="wikitable"
|-
! Paramètre !! Description
|-
| {{var|-cp}} || Le chemin vers chaque librairie dont le script a besoin séparés à chaque de ":" avec toute suite après, le chemin vers le script à exécuter,
|-
| {{var|-tomcat-path}} || Le chemin vers le dossier Tomcat qu'utilise l'application.
|-
| {{var|-nb-try-http}} || Nombre d'essais avant...
|-
| {{var|-mail}} || L'adresse courriel de destination de l'alerte.
|-
| {{var|-app-url}} || L'URL d'une page de l'application Pleade à tester (liée au Tomcat). Si la page répond : OK, si la page ne répond pas, NOK : déclenchement des actions.
|-
| {{var|-datadirs-path}} || Le PATH du répertoire où sont écrits les données lors des processus d'indexation de Pleade et où sont écrits des verrous (selon l'état de fonctionnement de Pleade).
|-
| {{var|-restart-path}} || Le PATH du script de redémarrage de Tomcat.
|}

Script de maintenance Tomcat

2022-06-09T12:47:55Z

Mhymonet : /* Utilité du script */

== Utilité du script ==
Une des pannes les plus fréquentes des applications Pleade est l'arrêt de Tomcat. Dans ce cas, l'application Pleade n'est plus fonctionnelle et elle renvoie une erreur de type 403.

Ces arrêts sont souvent dus à un manque de ressources en mémoire attribuée à JAVA.

Ce manque de ressource déclenche une OutOfMemory, l'arrêt de Tomcat et de l'application Pleade.

La cause de l'OutOfMemory est liée soit : à une publication dans Pleade qui consomme toutes les ressources ; à la fréquentation importante de l'application ; à la combinaison de tous ces facteurs.

Le script de maintenance de Tomcat permet de suivre automatiquement le fonctionnement de Tomcat, de repérer les pannes et de relancer Tomcat en cas d'arrêt.

Il s’exécute toutes les 30 minutes et vérifie le bon fonctionnement d'une application Tomcat donnée.

Si Tomcat ne fonctionne pas correctement, le script effectue certaines actions comme :
* supprimer des fichiers bloquants,
* supprimer le cache et redémarrer,
* envoyer un mail s'il y a eu un problème.
[[Fichier:Diagrammes Script maintenance Tomcat-Activité Script.drawio.png|200px]]

== Installation du script ==
Version de java nécessaire : ≥7

Les sources java du script se trouvent sur le svn, sous le nom de "maintenance_tomcat".

Après avoir récupéré les sources et les avoir placé dans un répertoire de l'utilisateur qui les exécutera, on défini les instructions du script dans le Crontab de l'utilisateur (comme par exemple ajlsm).
On appelle le crontab avec la commande :
<syntaxhighlight lang="bash">$ crontab -e</syntaxhighlight>

Il faut adapter les instructions en fonction des projets et en suivant les explications du script.
# Voir "Explication du script" pour plus de détails.[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Explication_du_script[1]]

== Explication du script ==
Voici un exemple de script :
<syntaxhighlight lang="bash">
*/30 * * * * java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"
</syntaxhighlight>

* La première instruction définie la fréquence de rotation du script. Par exemple, toutes les 30 minutes :
<syntaxhighlight lang="bash">*/30 * * * *</syntaxhighlight>

* Ensuite, tous les paramètres nécessaires pour exécuter la commande.
#Voir "Paramètres du code java" pour plus d'explication sur les paramètres.[[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Param.C3.A8tres_du_code_java]]

== Paramètres du code java ==
Afin de s’exécuter, le script à besoin de renseigner au code java certains paramètres, dans le crontab, comme ici :
<syntaxhighlight lang="bash">java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"</syntaxhighlight>
On a donc :
{| class="wikitable"
|-
! Paramètre !! Description
|-
| {{var|-cp}} || Le chemin vers chaque librairie dont le script a besoin séparés à chaque de ":" avec toute suite après, le chemin vers le script à exécuter,
|-
| {{var|-tomcat-path}} || Le chemin vers le dossier Tomcat qu'utilise l'application.
|-
| {{var|-nb-try-http}} || Nombre d'essais avant...
|-
| {{var|-mail}} || L'adresse courriel de destination de l'alerte.
|-
| {{var|-app-url}} || L'URL d'une page de l'application Pleade à tester (liée au Tomcat). Si la page répond : OK, si la page ne répond pas, NOK : déclenchement des actions.
|-
| {{var|-datadirs-path}} || Le PATH du répertoire où sont écrits les données lors des processus d'indexation de Pleade et où sont écrits des verrous (selon l'état de fonctionnement de Pleade).
|-
| {{var|-restart-path}} || Le PATH du script de redémarrage de Tomcat.
|}

Fichier:Diagrammes Script maintenance Tomcat-Activité Script.drawio.png

2022-06-09T12:45:52Z

Mhymonet :

Script de maintenance Tomcat

2022-06-09T12:45:38Z

Mhymonet : /* Utilité du script */

== Utilité du script ==
Une des pannes les plus fréquentes des applications Pleade est l'arrêt de Tomcat. Dans ce cas, l'application Pleade n'est plus fonctionnelle et elle renvoie une erreur de type 403.

Ces arrêts sont souvent dus à un manque de ressources en mémoire attribuée à JAVA.

Ce manque de ressource déclenche une OutOfMemory, l'arrêt de Tomcat et de l'application Pleade.

La cause de l'OutOfMemory est liée soit : à une publication dans Pleade qui consomme toutes les ressources ; à la fréquentation importante de l'application ; à la combinaison de tous ces facteurs.

Le script de maintenance de Tomcat permet de suivre automatiquement le fonctionnement de Tomcat, de repérer les pannes et de relancer Tomcat en cas d'arrêt.

Il s’exécute toutes les 30 minutes et vérifie le bon fonctionnement d'une application Tomcat donnée.

Si Tomcat ne fonctionne pas correctement, le script effectue certaines actions comme :
* supprimer des fichiers bloquants,
* supprimer le cache et redémarrer,
* envoyer un mail s'il y a eu un problème.
[[Fichier:Diagrammes Script maintenance Tomcat-Activité Script.drawio.png]]

== Installation du script ==
Version de java nécessaire : ≥7

Les sources java du script se trouvent sur le svn, sous le nom de "maintenance_tomcat".

Après avoir récupéré les sources et les avoir placé dans un répertoire de l'utilisateur qui les exécutera, on défini les instructions du script dans le Crontab de l'utilisateur (comme par exemple ajlsm).
On appelle le crontab avec la commande :
<syntaxhighlight lang="bash">$ crontab -e</syntaxhighlight>

Il faut adapter les instructions en fonction des projets et en suivant les explications du script.
# Voir "Explication du script" pour plus de détails.[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Explication_du_script[1]]

== Explication du script ==
Voici un exemple de script :
<syntaxhighlight lang="bash">
*/30 * * * * java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"
</syntaxhighlight>

* La première instruction définie la fréquence de rotation du script. Par exemple, toutes les 30 minutes :
<syntaxhighlight lang="bash">*/30 * * * *</syntaxhighlight>

* Ensuite, tous les paramètres nécessaires pour exécuter la commande.
#Voir "Paramètres du code java" pour plus d'explication sur les paramètres.[[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Param.C3.A8tres_du_code_java]]

== Paramètres du code java ==
Afin de s’exécuter, le script à besoin de renseigner au code java certains paramètres, dans le crontab, comme ici :
<syntaxhighlight lang="bash">java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"</syntaxhighlight>
On a donc :
{| class="wikitable"
|-
! Paramètre !! Description
|-
| {{var|-cp}} || Le chemin vers chaque librairie dont le script a besoin séparés à chaque de ":" avec toute suite après, le chemin vers le script à exécuter,
|-
| {{var|-tomcat-path}} || Le chemin vers le dossier Tomcat qu'utilise l'application.
|-
| {{var|-nb-try-http}} || Nombre d'essais avant...
|-
| {{var|-mail}} || L'adresse courriel de destination de l'alerte.
|-
| {{var|-app-url}} || L'URL d'une page de l'application Pleade à tester (liée au Tomcat). Si la page répond : OK, si la page ne répond pas, NOK : déclenchement des actions.
|-
| {{var|-datadirs-path}} || Le PATH du répertoire où sont écrits les données lors des processus d'indexation de Pleade et où sont écrits des verrous (selon l'état de fonctionnement de Pleade).
|-
| {{var|-restart-path}} || Le PATH du script de redémarrage de Tomcat.
|}

Script de maintenance Tomcat

2022-06-09T12:45:08Z

Mhymonet : /* Utilité du script */

== Utilité du script ==
Une des pannes les plus fréquentes des applications Pleade est l'arrêt de Tomcat. Dans ce cas, l'application Pleade n'est plus fonctionnelle et elle renvoie une erreur de type 403.

Ces arrêts sont souvent dus à un manque de ressources en mémoire attribuée à JAVA.

Ce manque de ressource déclenche une OutOfMemory, l'arrêt de Tomcat et de l'application Pleade.

La cause de l'OutOfMemory est liée soit : à une publication dans Pleade qui consomme toutes les ressources ; à la fréquentation importante de l'application ; à la combinaison de tous ces facteurs.

Le script de maintenance de Tomcat permet de suivre automatiquement le fonctionnement de Tomcat, de repérer les pannes et de relancer Tomcat en cas d'arrêt.

Il s’exécute toutes les 30 minutes et vérifie le bon fonctionnement d'une application Tomcat donnée.

Si Tomcat ne fonctionne pas correctement, le script effectue certaines actions comme :
* supprimer des fichiers bloquants,
* supprimer le cache et redémarrer,
* envoyer un mail s'il y a eu un problème.
[[Fichier:/home/mateohymonet/Téléchargements/Diagrammes Script maintenance Tomcat-Activité Script.drawio.png]]

== Installation du script ==
Version de java nécessaire : ≥7

Les sources java du script se trouvent sur le svn, sous le nom de "maintenance_tomcat".

Après avoir récupéré les sources et les avoir placé dans un répertoire de l'utilisateur qui les exécutera, on défini les instructions du script dans le Crontab de l'utilisateur (comme par exemple ajlsm).
On appelle le crontab avec la commande :
<syntaxhighlight lang="bash">$ crontab -e</syntaxhighlight>

Il faut adapter les instructions en fonction des projets et en suivant les explications du script.
# Voir "Explication du script" pour plus de détails.[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Explication_du_script[1]]

== Explication du script ==
Voici un exemple de script :
<syntaxhighlight lang="bash">
*/30 * * * * java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"
</syntaxhighlight>

* La première instruction définie la fréquence de rotation du script. Par exemple, toutes les 30 minutes :
<syntaxhighlight lang="bash">*/30 * * * *</syntaxhighlight>

* Ensuite, tous les paramètres nécessaires pour exécuter la commande.
#Voir "Paramètres du code java" pour plus d'explication sur les paramètres.[[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Param.C3.A8tres_du_code_java]]

== Paramètres du code java ==
Afin de s’exécuter, le script à besoin de renseigner au code java certains paramètres, dans le crontab, comme ici :
<syntaxhighlight lang="bash">java -cp /home/ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/ajlsm/datadirs/" -restart-path "/home/ajlsm/restart-tomcat.sh"</syntaxhighlight>
On a donc :
{| class="wikitable"
|-
! Paramètre !! Description
|-
| {{var|-cp}} || Le chemin vers chaque librairie dont le script a besoin séparés à chaque de ":" avec toute suite après, le chemin vers le script à exécuter,
|-
| {{var|-tomcat-path}} || Le chemin vers le dossier Tomcat qu'utilise l'application.
|-
| {{var|-nb-try-http}} || Nombre d'essais avant...
|-
| {{var|-mail}} || L'adresse courriel de destination de l'alerte.
|-
| {{var|-app-url}} || L'URL d'une page de l'application Pleade à tester (liée au Tomcat). Si la page répond : OK, si la page ne répond pas, NOK : déclenchement des actions.
|-
| {{var|-datadirs-path}} || Le PATH du répertoire où sont écrits les données lors des processus d'indexation de Pleade et où sont écrits des verrous (selon l'état de fonctionnement de Pleade).
|-
| {{var|-restart-path}} || Le PATH du script de redémarrage de Tomcat.
|}

Script de maintenance Tomcat

2022-06-08T14:12:44Z

Mhymonet : /* Paramètres du code java */

== Utilité du script ==
Le script va venir s’exécuter toutes les 30 minutes, pour vérifier le bon fonctionnement d'une application Tomcat donnée. Il va ensuite effectuer des action en conséquence comme supprimer des fichiers bloquants puis supprimer le cache et redémarrer et va ensuite envoyé un mail s'il y a eu un problème.

== Installation du script ==
Version de java nécessaire : 7+

Les sources java du script sur le svn et son sous le nom de "maintenance_tomcat".

Après avoir récupéré les sources et les avoir placés quelque part, il va falloir donner les indication au Crontab, qui est associé à un utilisateur (comme par exemple intra-ajlsm) et ces indications peuvent être changées avec la commande :
<syntaxhighlight lang="bash">$ crontab -e</syntaxhighlight>

Il faut ensuite les adapter comment on le souhaite en suivant les explications du script.
# Voir "Explication du script" pour plus de détails.[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Explication_du_script[1]]

== Explication du script ==
Voici un exemple de script que l'on peut trouver :
<syntaxhighlight lang="bash">
*/30 * * * * java -cp /home/intra-ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/intra-ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/intra-ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/intra-ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/intra-ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/intra-ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/intra-ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/intra-ajlsm/datadirs/" -restart-path "/home/intra-ajlsm/restart-tomcat.sh"
</syntaxhighlight>

* Tout d'abord, on a au début :
<syntaxhighlight lang="bash">*/30 * * * *</syntaxhighlight>
Qui est là pour dire de lancer ce qu'il y a après toutes les 30 minutes.

* Ensuite, on aura touts les paramètres qui représentent toute la longueur de la commande.
#Voir "Paramètres du code java" pour plus d'explication sur les paramètres.[[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Param.C3.A8tres_du_code_java]]

== Paramètres du code java ==
Afin de s’exécuter, le script à besoin de renseigner au code java certains paramètres, dans le crontab, comme ici :
<syntaxhighlight lang="bash">
java -cp /home/intra-ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/intra-ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/intra-ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/intra-ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/intra-ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/intra-ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/intra-ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/intra-ajlsm/datadirs/" -restart-path "/home/intra-ajlsm/restart-tomcat.sh"
</syntaxhighlight>
On a donc :
* -cp : Le chemin vers chaque librairie dont le script a besoin séparés à chaque de ":" avec toute suite après, le chemin vers le script à exécuter
* -tomcat-path : Le chemin vers le dossier Tomcat qu'utilise l'application
* -nb-try-http :
* -mail :
* -app-url :
* -datadirs-path :
* -restart-path :

Script de maintenance Tomcat

2022-06-08T14:11:17Z

Mhymonet : Page créée avec « == Utilité du script == Le script va venir s’exécuter toutes les 30 minutes, pour vérifier le bon fonctionnement d'une application Tomcat donnée. Il va ensuite effec... »

== Utilité du script ==
Le script va venir s’exécuter toutes les 30 minutes, pour vérifier le bon fonctionnement d'une application Tomcat donnée. Il va ensuite effectuer des action en conséquence comme supprimer des fichiers bloquants puis supprimer le cache et redémarrer et va ensuite envoyé un mail s'il y a eu un problème.

== Installation du script ==
Version de java nécessaire : 7+

Les sources java du script sur le svn et son sous le nom de "maintenance_tomcat".

Après avoir récupéré les sources et les avoir placés quelque part, il va falloir donner les indication au Crontab, qui est associé à un utilisateur (comme par exemple intra-ajlsm) et ces indications peuvent être changées avec la commande :
<syntaxhighlight lang="bash">$ crontab -e</syntaxhighlight>

Il faut ensuite les adapter comment on le souhaite en suivant les explications du script.
# Voir "Explication du script" pour plus de détails.[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Explication_du_script[1]]

== Explication du script ==
Voici un exemple de script que l'on peut trouver :
<syntaxhighlight lang="bash">
*/30 * * * * java -cp /home/intra-ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/intra-ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/intra-ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/intra-ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/intra-ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/intra-ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/intra-ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/intra-ajlsm/datadirs/" -restart-path "/home/intra-ajlsm/restart-tomcat.sh"
</syntaxhighlight>

* Tout d'abord, on a au début :
<syntaxhighlight lang="bash">*/30 * * * *</syntaxhighlight>
Qui est là pour dire de lancer ce qu'il y a après toutes les 30 minutes.

* Ensuite, on aura touts les paramètres qui représentent toute la longueur de la commande.
#Voir "Paramètres du code java" pour plus d'explication sur les paramètres.[[http://mw.ajlsm.com/wiki/Script_de_maintenance_Tomcat#Param.C3.A8tres_du_code_java]]

== Paramètres du code java ==
Afin de s’exécuter, le script à besoin de renseigner au code java certains paramètres, dans le crontab, comme ici :
<syntaxhighlight lang="bash">
java -cp /home/intra-ajlsm/maintenance_tomcat/lib/commons-cli-1.5.0.jar:/home/intra-ajlsm/maintenance_tomcat/lib/htmlunit-driver-3.61.0.jar:/home/intra-ajlsm/maintenance_tomcat/lib/selenium-api-4.1.4.jar:/home/intra-ajlsm/maintenance_tomcat/lib/commons-io-2.11.0.jar:/home/intra-ajlsm/maintenance_tomcat/lib/javax.mail.jar:/home/intra-ajlsm/maintenance_tomcat/lib/javax.activation-1.2.0.jar /home/intra-ajlsm/maintenance_tomcat/src/Maintenance_tomcat.java -tomcat-path "/opt/tomcat7/" -nb-try-http 3 -mail "mateohymonet@hotmail.fr" -app-url "http://mirador.pleade.com/cdc.html" -datadirs-path "/home/intra-ajlsm/datadirs/" -restart-path "/home/intra-ajlsm/restart-tomcat.sh"
</syntaxhighlight>
On a donc :
* -cp : Le chemin vers chaque librairie dont le script a besoin séparés à chaque de ":" avec toute suite après, le chemin vers le script à exécuter
* -tomcat-path :
* -nb-try-http :
* -mail :
* -app-url :
* -datadirs-path :
* -restart-path :