Installation de l'applicatif

Attention

Les prérequis indiqués sur la page Configuration minimale et prérequis doivent être respectés.

L'application Squash TM est livrée sous différents packages :

un installeur Windows qui permet une installation rapide à des fins de démonstration ;
un package universel compatible Windows, Linux (.zip ou .tar.gz) ;
une image Docker.

Définition des propriétés liées aux secrets

Avant d'utiliser Squash TM en production, les propriétés suivantes doivent être configurées (voir ici) :

squash.crypto.secret : définit le secret utilisé pour chiffrer les mots de passe stockés.
Squash TM est actuellement livré avec une valeur par défaut, celle-ci doit être modifiée.
(Changer cette propriété ultérieurement rendra les mots de passe stockés inutilisables.)
squash.rest-api.jwt.secret : définit le secret pour générer les jetons d'API et est donc nécessaire pour pouvoir utiliser ces derniers.
L'utilisation des jetons d'API est facultative pour le moment (elle sera obligatoire à l'avenir).
Squash Orchestrator utilise des jetons d'API pour communiquer avec Squash TM, donc cette propriété doit être définie si vous prévoyez d'exécuter des tests automatisés.
(Changer cette propriété ultérieurement rendra les jetons émis inutilisables.)

Installation sur Linux

Installation avec le tarball Linux

Pour installer Squash TM avec le tarball Linux :

Décompresser l'archive .tar.gz de Squash TM dans /opt :
```
tar -zxvf archivexsquashtm.tar.gz
```

Créer un utilisateur et un groupe dédiés à Squash TM :

adduser --system --group --home /opt/squash-tm squash-tm

Définir cet utilisateur comme propriétaire de son dossier et ses fichiers :
```
chown -R squash-tm:squash-tm /opt/squash-tm
```
Peupler la base de données grâce aux scripts présents dans /opt/squash-tm/database-scripts.

S'il s'agit d'une première installation passer le script <database>-full-install-version-8.X.X.RELEASE.sql correspondant au SGBD portant le numéro de version de Squash TM.
S'il s'agit d'une montée de version, passer les scripts d'upgrade <database>-upgrade-to-X.X.X.sql correspondants au SGBD dans l'ordre des versions jusqu'à atteindre la version cible.
Rendre startup.sh exécutable :
```
chmod +x /opt/squash-tm/bin/startup.sh
```

Renseigner, dans le fichier bin/startup.sh, les informations de connexion à la base de données :

DB_URL="jdbc:mariadb://localhost:3306/squashtm" ou "jdbc:postgresql://localhost:5432/squashtm"
DB_TYPE="mariadb" ou "postgresql"
DB_USERNAME="squash-tm"
DB_PASSWORD="password"

Démarrer Squash TM :

cd /opt/squash-tm/bin
nohup ./startup.sh &

Accéder à Squash TM avec le navigateur à http://localhost:8080/squash.
Les identifiants pour une installation nouvelle sont admin/admin.
Faire Ctrl+C pour reprendre le contrôle sur le terminal.

Installation du service `systemd` sous Debian

Pour installer Squash TM comme service systemd sous Debian :

Copier le fichier de service systemd qui est dans /opt/squash-tm :
```
cp /opt/squash-tm/squash-tm.service /etc/systemd/system/
```
Recharger les services :
```
systemctl daemon-reload
```
Faire en sorte que Squash TM démarre avec le système :
```
systemctl enable squash-tm
```

Démarrer le service :

systemctl start squash-tm

Il n'y a pas de fichier de service dans squash-tm-8.X.X.RELEASE.tar.gz. Il faut donc créer le fichier de service squash-tm.service avec le contenu qui suit :

[Unit]
Description=Squash-tm daemon
After=systemd-user-sessions.service time-sync.target

[Service]
WorkingDirectory=/opt/squash-tm/bin
ExecStart=/opt/squash-tm/bin/startup.sh
ExecStop=/bin/kill $MAINPID
KillMode=process
Type=simple
User=squash-tm
Group=squash-tm
Restart=on-failure
RestartSec=10
StartLimitInterval=120
StartLimitBurst=3
StandardOutput=null
StandardError=null

[Install]
WantedBy=multi-user.target

Accéder à Squash TM avec le navigateur à http://localhost:8080/squash.
Les identifiants pour une installation nouvelle sont admin/admin.

Installation sur Windows

Installation standard avec un fichier Zip

Pour installer Squash TM sous Windows :

Décompresser l'archive .zip de Squash TM dans votre répertoire de travail (appelé <rep> par la suite).
Attention : le processus Windows lié à Squash TM doit disposer des autorisations de lecture et d'écriture sur l'emplacement d'installation.
Peupler la base de données grâce aux scripts présents dans <rep>\squash-tm\database-scripts.
- S'il s'agit d'une première installation, passer le script <database>-full-install-version-8.X.X.RELEASE.sql correspondant au SGBD portant le numéro de version de Squash TM ;
- S'il s'agit d'une montée de version, passer les scripts d'upgrade <database>-upgrade-to-X.X.X.sql correspondants au SGBD dans l'ordre des versions jusqu'à atteindre la version cible ;
- Ou s'il s'agit d'une restauration d'une base existante, passer la commande associée au SGBD pour restaurer le dump.

Renseigner, dans le fichier startup.bat, les informations de connexion à la base de données :

DB_URL="jdbc:mariadb://localhost:3306/squashtm" ou "jdbc:postgresql://localhost:5432/squashtm"
DB_TYPE="mariadb" ou "postgresql"
DB_USERNAME="squash-tm"
DB_PASSWORD="password"

Exécuter en double-cliquant directement le fichier startup.bat ou installer Squash TM en tant que service.
Accéder à Squash TM avec le navigateur à http://localhost:8080/squash.
Les identifiants pour une installation nouvelle sont admin/admin.

Installation en tant que service Windows (`.exe`)

Effectuer les trois premières étapes de l'installation standard.
Installer le service Squash TM via l'invite de commandes en administrateur (cmd) :
```
<rep>\squash-tm\bin\squash-tm.exe install
```
Aller dans Services (rechercher "Services" ou dans l'onglet Services au niveau du gestionnaire des tâches).
Démarrer le service squash-tm.
Accéder à Squash TM avec le navigateur à http://localhost:8080/squash.
Les identifiants pour une installation nouvelle sont admin/admin.