Install SquashTM

Warning

The prerequisites listed on the page System Requirements and Prerequisites must be respected.

You can find the SquashTM app in various packages:

a Windows installer that allows for a quick install for demonstration purposes only;
a universal package compatible with Windows, and Linux (.zip or tar.gz);
a Docker image.

Definition of the secret-related properties

Before using SquashTM in production, the following properties must be configured (see here):

squash.crypto.secret: this defines the secret used to encrypt stored passwords.
SquashTM is currently delivered with a default value, this one must be changed.
(Changing the property later will result in the stored passwords becoming unusable.)
squash.rest-api.jwt.secret: this defines the secret used to generate API tokens and is therefore necessary to use them.
The use of API tokens is optional for now (it will be mandatory in the future).
SquashTM Orchestrator uses API tokens to communicate with SquashTM, so this property must be set if you plan to run automated tests.
(Changing this property later will make previously issued tokens unusable.)

Installation on Linux

Install with Linux Tarball

To install SquashTM using the Linux tarball:

Extract SquashTM's .tar.gz archive in /opt:
```
tar -zxvf archivexsquashtm.tar.gz
```

Create a user and a group dedicated to SquashTM:

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

Define that user as the owner of their folder and files:
```
chown -R squash-tm:squash-tm /opt/squash-tm
```
Make startup.sh executable:
```
chmod +x /opt/squash-tm/bin/startup.sh
```

In the file conf/squash.tm.cfg.properties, enter the login information for the database:

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

Database installation:

Refer to the steps on the Install database page.

Start SquashTM:

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

Access SquashTM on the browser at http://localhost:8080/squash.
The login and password for a new installation are admin/admin.
Press Ctrl + C to regain control over the terminal.

Install as `systemd` on Debian

To install SquashTM as systemd using Debian:

Copy the systemd service file that is located in /opt/squash-tm:
```
cp /opt/squash-tm/squash-tm.service /etc/systemd/system/
```
Reload the services:
```
systemctl daemon-reload
```
Make sure that SquashTM starts with the system:
```
systemctl enable squash-tm
```

Start the service:

systemctl start squash-tm

There is no service file in squash-tm-9.X.X.RELEASE.tar.gz. Therefore, you must create the service file squash-tm.service with the following content:

[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
StandardOutput=null
StandardError=null
StartLimitInterval=120
StartLimitBurst=3

[Install]
WantedBy=multi-user.target

Access SquashTM on the browser at http://localhost:8080/squash.
The login and password for a new installation are admin/admin.

Installation on Windows

Standard Install with a Zip File

To install SquashTM on Windows:

Install SquashTM: extract the .zip file and move its content to the desired location (named <rep> below).
Warning: the Windows process linked to SquashTM must have reading and writing permissions on the install location.

In the file conf/squash.tm.cfg.properties, enter the login information for the database:

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

Database installation:
Refer to the steps on the Install database page.
Run by double-clicking the startup.bat or install SquashTM as a Windows service.
Access SquashTM on the browser at http://localhost:8080/squash.
The login and password for a new installation are admin/admin.

Installation as a Windows service (`.exe`)

Perform the three first steps of the standard installation.
Install the SquashTM service via the prompt command as administrator (cmd):
```
<rep>squash-tm\bin\squash-tm.exe install
```
Go to Services (search for "Services" or in the Services tab in the task manager).
Start the squash-tm service.
Access SquashTM on the browser at http://localhost:8080/squash.
The login and password for a new installation are admin/admin.