Install SquashTM License and Plugins

Install SquashTM Plugins

There are two ways to install plugins in SquashTM:

By using the plugin files embedded in SquashTM distribution

1. Retrieve the plugin in the squash-tm/plugin-files folder;
2. Move or copy the folder corresponding to the plugin to be installed to the following folder:
   • for Linux tarball: /opt/squash-tm/plugins;
   • for Windows: C:\<rep>\squash-tm\plugins;
3. In Linux, give read permission to the squash-tm user for the .jar files;
4. If it is a commercial plugin, make sure that:
   • the license file squash-tm.lic is in the folder license;
   • the SquashTM Premium plugin is present in the folder mentioned above in step 2;
5. Restart SquashTM for the plugins installation to be taken into account.

By downloading the plugins

1. Download the plugin from the Downloads page;
2. Extract the plugin;
3. Select all the .jar files it contains and put them in the following folder:
   • for Linux tarball: /opt/squash-tm/plugins;
   • for Windows: C:\<rep>\squash-tm\plugins;
4. In Linux, give read permission to the squash-tm user for the .jar files;
5. If it is a commercial plugin, make sure that:
   • the license file squash-tm.lic is in the folder license;
   • the SquashTM Premium plugin is present in the folder mentioned above in step 3;
6. Restart SquashTM for the plugins installation to be taken into account.

Once installed, some plugins can operate right away, such as API or reporting plugins. Other plugins need to be configured in the server or in SquashTM Administration workspace.

Install the Commercial License

The use of SquashTM commercial plugins is determined by the presence of a license file: squash-tm.lic. This file is mandatory to start SquashTM with commercial plugins.

This file is given to the client by the SquashTM Support Team following the formalization of a new license or a renewal.

The license file is unique to each client. It contains the following information:

• expiration date;
• number of users;
• list of the authorized commercial plugins according to the license(s) you have.

You can use this license file for production instances as well as preproduction instances.

To install the license file in SquashTM:

1. In SquashTM's plugins directory, create a subdirectory entitled license
2. Put the file squash-tm.lic given to you by the SquashTM Support Team in that subdirectory;
3. Restart SquashTM.

The license file controls the number of active users in SquashTM. When the maximum number of users is exceeded, a message appears to alert the administrators. If this number is exceeded by more than 20%, the creation of new users is blocked.

Two months before the license's expiration date, a message alerts the administrators. Beyond this date, the message will alert all the users. If the license is still not renewed two months after the expiration date, SquashTM shuts off. You will then have to uninstall the commercial plugins to be able to restart SquashTM.

Install Xsquash for Jira Data Center

Xsquash is an additional component available on the Atlassian Marketplace for Jira Data Center that reinforces the integration between SquashTM and Jira. It displays SquashTM test cases and executions directly in Jira issues that were synchronized in SquashTM via Xsquash4Jira.

This plugin requires at least Jira Data Center 8.4+.

To install the Xsquash plugin on Jira Data Center, please follow these steps:

1. Log into Jira as an administrator;
2. Go to Jira Administration and click on Manage Apps. The Atlassian Marketplace for Jira appears;
3. Search for Xsquash in the Marketplace. The search results include the app versions that are compatible with Jira;
4. Click on [Install] to download and install the app;
5. Click on Close in the dialog window.

Xsquash must be configured for it to work.

Install the Xsquash Cloud app in Jira Cloud

Xsquash Cloud (Forge) is an application available on the Atlassian Marketplace

This app is only available if you have a commercial license.

Install Xsquash Cloud

You can access the application directly by clicking here, then install it by clicking [Get it now].

You can also follow this procedure:

1. Log in to your Jira Cloud instance with an administrator account;
2. In the left-hand menu, expand [Apps], then click [Explore more apps];
3. Enter "Xsquash" in the search bar, then click [Search];
4. Click on the Xsquash application;
5. Make sure the Cloud version is selected;
6. Click [Get it now];
7. Then follow the installation steps to add the application to your Jira Cloud instance.

You must then configure the app in order to use it.

Network flows to open for an On-Premise installation

If your SquashTM instance is hosted On-Premise (on your own network), certain network flows must be opened to allow communication between Xsquash Cloud and your SquashTM instance.

• Xsquash Cloud (Forge application), hosted on the Atlassian Cloud infrastructure (AWS), sends requests to your SquashTM instance (REST API) over HTTPS (port 443). This flow must be opened inbound on your network, from the outgoing IP ranges used by Atlassian Forge.
• SquashTM (REST API) in turn sends requests to Jira Cloud (REST API) over HTTPS (port 443) in order to retrieve Jira issues. This is a standard outbound flow, as Jira Cloud is freely accessible.

API access requirements for Xsquash Cloud

Xsquash Cloud retrieves test case and execution data via SquashTM's REST API. The endpoints specified in this OpenAPI specification must be accessible from the server hosting your Jira instance.

Additionally, Xsquash Cloud checks this endpoint at installation time to verify connectivity: /api/rest/latest/docs/api-documentation.html. This page must also be accessible from the Jira server.