Aller au contenu

Installation de SquashTM

Attention

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

L'application SquashTM 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 SquashTM 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.
    SquashTM 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).
    SquashTM Orchestrator utilise des jetons d'API pour communiquer avec SquashTM, 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 SquashTM avec le tarball Linux :

  1. Décompresser l'archive .tar.gz de SquashTM dans /opt : 

    tar -zxvf archivexsquashtm.tar.gz

  2. Créer un utilisateur et un groupe dédiés à SquashTM : 

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

  3. Définir cet utilisateur comme propriétaire de son dossier et ses fichiers : 

    chown -R squash-tm:squash-tm /opt/squash-tm

  4. Rendre startup.sh exécutable : 

    chmod +x /opt/squash-tm/bin/startup.sh

  5. Renseigner, dans le fichier conf/squash.tm.cfg.properties, les informations de connexion à la base de données : 

    spring.datasource.url = jdbc:mariadb://localhost:3306/squashtm ou jdbc:postgresql://localhost:5432/squashtm
spring.profiles.active = mariadb ou postgresql
spring.datasource.username = squash-tm
spring.datasource.password = password

  6. Installation de la base de données :

    Retrouver les étapes à la page Installation de la base de données.

  7. Démarrer SquashTM : 

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

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

  9. Faire Ctrl+C pour reprendre le contrôle sur le terminal.

Installation du service systemd sous Debian

Pour installer SquashTM comme service systemd sous Debian :

  1. Copier le fichier de service systemd qui est dans /opt/squash-tm : 

    cp /opt/squash-tm/squash-tm.service /etc/systemd/system/

  2. Recharger les services : 

    systemctl daemon-reload

  3. Faire en sorte que SquashTM démarre avec le système : 

    systemctl enable squash-tm

  4. Démarrer le service : 

    systemctl start squash-tm

    Il n'y a pas de fichier de service dans squash-tm-9.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

  5. Accéder à SquashTM 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 SquashTM sous Windows :

  1. Décompresser l'archive .zip de SquashTM dans votre répertoire de travail (appelé <rep> par la suite).
    Attention : le processus Windows lié à SquashTM doit disposer des autorisations de lecture et d'écriture sur l'emplacement d'installation.

  2. Renseigner, dans le fichier conf/squash.tm.cfg.properties, les informations de connexion à la base de données : 

    spring.datasource.url = jdbc:mariadb://localhost:3306/squashtm ou jdbc:postgresql://localhost:5432/squashtm
spring.profiles.active = mariadb ou postgresql
spring.datasource.username = squash-tm
spring.datasource.password = password

  3. Installation de la base de données :

    Retrouver les étapes à la page Installation de la base de données.

  4. Exécuter en double-cliquant directement le fichier startup.bat ou installer SquashTM en tant que service.

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

Installation en tant que service Windows (.exe)

  1. Effectuer les trois premières étapes de l'installation standard.

  2. Installer le service SquashTM via l'invite de commandes en administrateur (cmd) : 

    <rep>\squash-tm\bin\squash-tm.exe install

  3. Aller dans Services (rechercher "Services" ou dans l'onglet Services au niveau du gestionnaire des tâches).

  4. Démarrer le service squash-tm.

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