Installing Squore

Windows

This section describes the possible scenarios for installing Squore on windows.

If you use all the default settings, the installer will deploy the following components in the specified locations:

  • <SQUORE_HOME> is %SYSTEMDRIVE%\Vector\Squore\squore-server and contains Squore Server and its dependencies, including dedicated distributions of:

    • Strawberry Perl 5.32.1.1 Portable (with updated library zlib 1.2.13)

    • PostgreSQL 16.0 Portable

    • Tcl 8.6 for Windows 8.6.11

    • PhantomJS 2.1.1

    • WildFly 27.0.1.Final

  • <SQUORE_DATA> is %SYSTEMDRIVE%\Vector\Squore\squore-data and consists of the following subfolders:

    • The Squore database in <SQUORE_DATA>\cluster

    • The Squore database backup directory in <SQUORE_DATA>\backup

    • The Squore project data directory in <SQUORE_DATA>\projects

    • The Squore temporary data directory in <SQUORE_DATA>\temp

    • The Squore temporary source code directory in <SQUORE_DATA>\temp\sources

    • The Squore workspace directory in <SQUORE_DATA>\workspace

The installer provides options to:

  • use a different installation folder

  • use a specific path for temporary data and project data

  • use a specific path for the local PostgreSQL cluster and backup folder

  • use an existing local PostgreSQL instance

  • use a remote Oracle database

  • use your own perl distribution

The data and temporary folders must be excluded from the scope of virus scanners, malware protectors and search indexers to avoid any errors during an analysis.

In order to start installing Squore, log on with an account that has administrator privileges and launch the Squore installer (squore-24.0.0-windows-x86_64.msi). Each of the wizard screens is documented below in the order that you will see them.

Running the Windows installer generates a log file in "<SQUORE_HOME>\install.log", which you can consult if you think there is an issue with your installation. When an installation or upgrade fails, the operation is rolled back in an attempt to remove all files in the selected installation folder. When this happens, the log file can be found in "%LOCALAPPDATA%\Temp\install_squore.log" instead.

  1. The Squore installer Welcome screen

    SIM inst01 Welcome
    Figure 1. The Squore installer Welcome screen

    On the Welcome screen, click the Next button to start the installation.

  2. The Squore License Agreement screen

    SIM inst02 Licence
    Figure 2. The Squore License Agreement screen

    Review and accept the License Agreement, then click the Next button to continue with the installation.

  3. Squore Server Destination Folder screen

    SIM inst04 InstallDir
    Figure 3. Squore Server Destination Folder screen

    The Destination Folder screen allows you to select the Squore installation folder, where the application server will be installed. If you choose the path of an existing Squore installation, the installer will offer to upgrade this existing installation. Note that you should back up your data before you attempt to upgrade a Squore installation.

    The steps to follow in order to upgrade an existing installation are described in Upgrading Squore. The rest of the current chapter describes the procedure for a new installation.

    Check that the location suggested by the Squore installer is appropriate. If not, use the Browse…​ button to select another location.

    After specifying the Destination Folder, click on the Next button.

  4. The Feature Selection screen

    SIM inst03 Components
    Figure 4. The Feature Selection screen

    The Components screen allows you to choose the components of Squore that will be installed.

    If you are unsure which components are needed on your system, you can safely leave all of them selected and then, click the Next button.

  5. The General Options screen

    SIM inst05 Params1
    Figure 5. The Data Folder and License screen

    The Squore Data Folder and License screen allows specifying where Squore stores its data and which license file is used for the installation.

    • Data Folder: The data folder is the main folder where the data generated by Squore will be stored. Define a path on your system to hold the data. By default, the database cluster, the temporary folder, the project data, the configuration workspace and the default backup folder will live in this location. Note that you can refine each individual location later by going through the advanced option screens of the installation wizard.

    • License File: The location of the Squore license file you wish to use for your installation. Note that you can leave this field empty at this time and provide the license information only after the installation procedure has finished. This is explained in further details in Updating the License File.

      After specifying the data location and optionally pointing to a license file, click the Next button.

  6. The Server Configuration screen

    SIM inst05 Params2
    Figure 6. The Server Configuration screen

    The Server Configuration screen allows specifying the rest of the necessary, basic options for your installation.

    • HTTP port number: Define the port used to access Squore from your browser.

    • Allow access from remote computers: Check this box to allow other computers on your network to connect to the Squore installation from a web browser. This setting is off by default to provide a safe installation that is only accessible from the server machine itself.

    • Install as Windows service: Check this box if you want to be able to start and stop Squore Server using a Windows service. You can optionally customise the service name when clicking the Next button.

    • Java directory: the directory where the Oracle JRE is installed. The wizard should have found the appropriate Java installation on your server, but you can modify the value if the JRE you want to use is in a different location using the ... button. Note that Java 17 (64-bit) (Java 11 is still supported, any other versions are not.) is required (see Prerequisites).

    • Advanced configuration: Check this box to see more installation options for advanced users. Advanced options include finer control over data folder locations, memory settings, and advanced database configuration (like using a remote Oracle database).

      After setting your preferences, click the Next button to view a summary of your installation settings (step 14) or proceed with the advanced configuration options (step 7).

  7. The Advanced Squore configuration screen

    SIM inst06 AdvConfigSQuORE
    Figure 7. The Advanced Squore configuration screen

    This screen is only displayed if you checked the Advanced configuration box in step 6.

    On the Advanced configuration screen, you can modify the default work directory and memory and performance settings for the server.

    • Temporary directory: The location of the temporary data generated by Squore.

    • Projects directory: The location of the data generated by Squore when running analyses on the server.

    • Workspace directory: The location where changes to your analysis models and dashboards made in the web interface are stored on disk.

    • Backup directory: The location used to store backups when the backup script is launched. For more details about backing up your Squore data, see Backing-Up Squore Data

    • Java Xmx size (in Mb): The maximum amount of RAM available to Squore Server, set to 25% of the physical RAM available on your server by default. It is recommended to keep the memory allocated to Squore under 25% of the total physical RAM so that other Squore modules (especially the database) or external processes (the OS and some Data Providers like Checkstyle or FindBugs) still have enough resources available. This setting can be changed after installation by following the procedure described in Changing the Java Heap size.

  8. The Perl selection screen

    SIM inst07 OwnPerl
    Figure 8. The Perl selection screen

    This screen is only displayed if you disabled the installation of Strawberry Perl 5.32.1.1 Portable (with updated library zlib 1.2.13) box in step 4.

    On the Perl selection screen, you can modify the path to the Perl distribution that will be used by Squore Server.Use the ... button to specify the Perl installation folder and click the Next button to continue.

  9. The Database Type screen

    SIM inst08 DatabaseType
    Figure 9. The Database Type screen options for local and remote databases

    On the Database Type screen, you can specify if your Squore Server installation should use a local PostgreSQL cluster or a database on a remote DBMS.

    In order to use a local PostgreSQL cluster, modify the path to the PostgreSQL installation that will be used by the installer to create the Squore database. Use the ... button to specify the installation folder and click the Next button to continue.

    In order to use a remote database backend, specify its URL and provide the username and password of a dedicated user for the Squore installation.

    The syntax for the database URL is:

    • jdbc:oracle:thin:@//host:port/sid for Oracle

    Click the Next button to continue, after making sure that the database URL and credentials are correct.

  10. The PostgreSQL server configuration screen

    SIM inst10 AdvConfigPostgreSQL
    Figure 10. The PostgreSQL server configuration screen

    This screen is only displayed if you checked the Advanced configuration box in step 6 and are using a local PostgreSQL database.

    On the PostgreSQL server configuration screen, you can provide details about the PostgreSQL server to be used with Squore Server

    • Server’s host: the hostname of the machine running the PostgreSQL server

    • Server’s port number: the running port of the PostgreSQL server

    • Administrator username: the username of the PostgreSQL server admin user

      Note that the Administrator password cannot be set. After adjusting your settings, click the Next button to continue.

  11. The Squore database configuration screen

    SIM inst11 AdvConfigDB
    Figure 11. The Squore database configuration screen

    This screen is only displayed if you checked the Advanced configuration box in step 6 and are using a local PostgreSQL database.

    On the Squore database configuration screen, you can specify the desired name and user for the Squore database:

    • Database name: the name of the database that will be created for this installation of Squore

    • username: the name of the user that will be created as the owner of the database

    • user password: the password for the specified database user

      After adjusting your settings, click the Next button to continue.

  12. The WildFly and PhantomJS Configuration screen

    SIM inst12 AdvConfigJBOSS
    Figure 12. The WildFly and PhantomJS Configuration screen

    This screen is only displayed if you checked the Advanced configuration box in step 6.

    On the WildFly and PhantomJS Configuration screen, you can specify the desired bind address and ports for Squore Server, as well as the port to use for the PhantomJS server:

    • Bind address: the bind-address configuration for the WildFly Server

      If you want to restrict access to Squore Server from the server itself, leave localhost. If you want your server to be accessible from anywhere on your network, set the bind address to 0.0.0.0.

    • Service binding offset: the offset added to the value of the default WildFly ports (as described on https://docs.jboss.org/author/display/WFLY10/Interfaces+and+ports#Interfacesandports-SocketBindingGroups) for this installation of Squore, resulting in the following ports being assigned for the following offset values:

      • 100 (default): http: 8180, https: 8543, management: 10090

      • 200: http: 8280, https: 8643, management: 10190

      • 300: http: 8380, https: 8743, management: 10290

      The offset is mainly used to install several instances of Squore using different ports on the same machine, or to configure the installation to use a different pour when 8180 is already by another application used on the machine.

    • PhantomJS port number: Choose the port used for the PhantomJS server. Note that all communication between Squore Server and PhantomJS happens on the same machine. This port therefore does not need to be open on your firewall.

    After adjusting your settings, click the Next button to continue.

  13. The Windows Service screen

    SIM inst12s Service
    Figure 13. The Windows Service screen

    This screen is only displayed if you checked the box, Install as Windows service, in step 6.

    On the Windows Service screen, you can specify the desired name and display name for service that controls Squore Server.

    For a Windows Service, the name is the alias used in the command line (for example: net start squore), and the display name (Squore) is the name displayed in the graphical Windows Services Console.

    Set the name and display name for the service according to you needs and click the Next button to continue.

  14. The Confirmation screen

    SIM inst13 Summary
    Figure 14. The Confirmation screen

    The Confirmation screen is the last screen displayed before the installation starts. Go back and verify your selections if needed, otherwise click Install to start installing Squore. The installation process lasts a few minutes.

  15. The Installation progress screen

    SIM inst14 Installing
    Figure 15. The Installation progress screen

    During the installation, a progress bar is displayed while files are copied to your hard drive.

    The installation cannot be cancelled after it has started.

  16. The Squore installation completed screen

    SIM inst15 Complete
    Figure 16. The Squore installation completed screen

    When the installation completes, the installation completed screen is displayed. Click the Finish button to close the Squore Installation Wizard.

    By checking the "Launch Squore" check box on this screen, Squore will open automatically in your browser. You can also use the Squore desktop shortcut in order to access Squore Login page in your web browser.

Squore is now ready for use and can be accessed via http://localhost:8180. Refer to Starting/Stopping Squore if you need more information about how to start and stop Squore and, if applicable, change the default configuration.

Linux

Before installing Squore on a Linux platform, verify that all prerequisites are met, as described in Prerequisites.

If you use all the default settings, the installer will deploy the following components in the specified locations:

  • <SQUORE_HOME>

  • <SQUORE_DATA>/projects

  • <SQUORE_DATA>/workspace

  • <SQUORE_DATA>/cluster

  • <SQUORE_DATA>/backup

  • /tmp/squore

  • /tmp/squore/sources

Ensure that the user that installs and runs Squore has read and write access to these locations.

The installation script will try to guess the amount of memory to allocate for the database on your system. If it cannot do it, you will get an error message about setting kernel.shmall. In this case, you need to set the value of kernel.shmall to a value that suits your need, based on which other applications are running on your system. The script will only suggest a minimum value.

Follow these instructions to install Squore Server:

Do not run the installation script as root, as this causes the installation of PostgreSQL to fail. Ensure that the user performing the installation has write-access to the folder used for installation.

  1. Copy the installation package (squore-24.0.0-linux-x86_64.tar.xz) into the location where you want to install Squore Server (For example: /opt/squore/).

  2. Extract the contents of the archive into the selected installation directory.

    The folder now contains a new folder called squore-server, which we will refer to as <SQUORE_HOME>.

  3. Run the Squore installation script in a command shell. The full list of options accepted by the install script can be found in install(1), but the command below is usually enough for most installations:

    <SQUORE_HOME>/bin/install -b 0.0.0.0 -k /path/to/squore-license.p7s /path/to/project/data

    You can perform the installation even if you do not have a license file yet. For more information, consult Obtaining a License File.

  4. Read and accept the license agreement

    If you want Squore Server to use a remote database backend, consult install(1) to find out more about the parameters available to set the remote database type, name and location.

Third-Party Plugins and Applications

If you have deployed some third-party tools on Squore Server, they will automatically be downloaded to your client when you launch the client synchronization script.

Cppcheck on Linux also require special attention: Cppcheck must be installed and available in the path.

For more information, refer to the Command Line Guide, which contains the full details about special installation procedures for Data Providers and Repository Connectors.