Installation Prerequisites

Supported Operating Systems

The following is a list of the officially supported and tested operating systems:

CentOS 6
CentOS 7
Fedora 19
Ubuntu Server 14.04
Windows 7
Windows 8
Windows 10

Note

On Linux, a 64-bit version of the OS is required

On Windows, a 64-bit version of the OS is required if you want Squore to run as a Windows service, but the installation is also supported on a 32-bit system (and is started and stopped using .bat files instead of a Windows Service)

The following is a list of the operating systems that are not regularly tested but are known to be working:

RedHat EL 6
RedHat EL 7
SuSe Linux 11.1
Ubuntu Server 10.04
Ubuntu Server 16.04
Windows Server 2008 R2
Windows Server 2012 R2

Supported Database Management Systems

Squore Server can use the following database management systems to store its data:

PostgreSQL 8.4 and up
Oracle Database 12c Release 1

In both cases, it is possible to have database on the same machine as Squore Server or on a remote machine.

Note

When using a database backend on a remote machine, the database administrator is responsible for backing up the database. The backup scripts included in the Squore Server installation will only handle the backup of the data stored on the Squore Server file system in that case. You can find more information about backup strategies for Squore Server in the section called Backup Tools in the Installation and Administration Guide.

Browser Compatibility

Squore is compatible with many browsers. The following is the list of officially supported browsers:

Google Chrome stable branch
Mozilla Firefox latest esr version
Microsoft Internet Explorer 11.0.15063.0 and up
Microsoft Edge 40.15063.0.0 and up

For All Systems

For a successful installation of Squore, you will need:

The latest version of the Squore Server installer, which can be downloaded from http://support.squoring.com/download_area.php
A supported Operating System, as stated in the section called “Supported Operating Systems”
A user account with system administrator privileges
The Oracle Java Runtime Environment version 8 (other versions are not supported)
Warning
- It is technically possible to run Squore on a server using a 32-bit JRE, however this will limit the memory available to 1GB of RAM to run the application, which will result in poor performance. If you still want to attempt such an installation, consult the troubleshooting page at http://openwiki.squoring.com/index.php/Running_Squore_On_A_32-bit_Java_Installation
At least 2 GB of space available on the disk for a full installation
At least 8 GB of RAM on the server machine
A valid Squore Server licence file (optional, since the licence file can be added after installation)

Tip

Keep in mind that the requirements above are the strict minimum. In production, Squore Server generally runs on a dedicated machine with a multi-core processor and 8 to 12GB of RAM. Squore reserves 25% of the available RAM of the machine to the database and another 25% to the server. External processes (like Checkstyle or FindBugs) running on the same machine as Squore may add to the amount of RAM required for analysing source code. Linux is known to offer better performances than Windows when running Squore.

Prerequisites for Oracle

When using Oracle as a database backend, a database administrator must create an Oracle user before you can install Squore.

The user requires the following privileges:

CREATE PROCEDURE
CREATE SEQUENCE
CREATE SESSION
CREATE TABLE
CREATE TYPE
CREATE VIEW
A valid quota for the tablespace used by the user (for example UNLIMITED)

Obtaining a Licence File

Because a licence is linked to the hardware on which Squore Server is installed, Squoring usually delivers a temporary licence to try out Squore first. This give you time to send out your host-id to our team, who will then issue a permanent licence file. In order to find out what your host-id is, follow these steps:

Download the host-id checker from http://support.squoring.com/download_area.php
Open a terminal on the machine where you installed or plan to install Squore.
Run the command java -jar hostid.jar.
Send the output to support@squoring.com.

Packages for Windows

A JRE is required for Squore Server. The Windows installer contains the tcl and perl runtimes as well as a portable PostgreSQL installation and a distribution of PhantomJS.

Packages for Linux

On Linux platforms, the following must be installed before installing Squore:

Perl version 5.10.1 or greater including the following extra-modules:
- Mandatory packages:
  - Algorithm::Diff [module details]
  - Archive::Zip [module details]
  - Date::Calc [module details]
  - DBD::Pg (unless you use a Oracle as your database backend) [module details]
  - DBI (unless you use a Oracle as your database backend) [module details]
  - Digest::SHA [module details]
  - HTTP::Request [module details]
  - JSON [module details]
  - LWP [module details]
  - LWP::UserAgent [module details]
  - Time::HiRes [module details]
  - XML::Parser [module details]
- Optional packages for working with Microsoft Excel:
  - HTML::Entities [module details]
  - Spreadsheet::BasicRead [module details]
- Optional packages for working with OSLC systems:
  - Date::Parse [module details]
  - WWW::Mechanize [module details]
  - XML::LibXML [module details]
- Optional packages for working with GitHub systems:
  - Date::Parse [module details]
  - Mail::Box::Manager [module details]
  - Mail::Message::Body::Lines [module details]
  - Mail::Message::Construct [module details]
  - Mail::Mbox::MessageParser [module details]
  - Net::GitHub [module details]
- Optional packages for working with Semios/Prometil systems:
  - File::Slurp [module details]
- Optional packages for Advanced CSV Export Management:
  - Text::CSV [module details]
Tip
If some of these modules are not available as packages on your operating system, use your perl installation's cpan to install the modules. Using the OS packages is recommended, as it avoids having to reinstall via cpan after upgrading your version of perl.
Tcl version 8.5 or greater,
PostgreSQL version 8.4 (unless you use a RDBMS running on another system) including at least the server component, and optionally, the pgAdmin utility. Note that your system must use a UTF-8 locale for the database creation to be carried out successfully. You can force this by running export LANG=en_US.UTF-8 or export LANG=fr_FR.UTF-8 according to what is available on your system before installing Squore.
The rsync utility

If you are running on a headless Squore Server, java-1.6.0-openjdk may not be sufficient, as it lacks some fonts to render graphics. This is why using Oracle's JRE is recommended.

Packages for CentOS and Red Hat Enterprise Linux

On Red Hat Enterprise Linux and CentOS (6.5 and 7.1), the dependencies are satisfied by the following packages:

Mandatory packages:

java-1.8.0-openjdk
perl
perl-Algorithm-Diff
perl-Archive-Zip
perl-Date-Calc
perl-Digest-SHA
perl-JSON
perl-libwww-perl
perl-Time-HiRes
perl-XML-Parser
postgresql-server (unless you use a RDBMS running on another system)
rsync
tcl

Optional packages for working with Microsoft Excel:

perl-HTML-Parser
perl-CPAN (CPAN utility requirement)
perl-Spreadsheet-ParseExcel (available in the EPEL repository)
perl-Spreadsheet-XLSX (available in the EPEL repository)

Warning

The module Spreadsheet::BasicRead is not available as a package and must therefore be installed using cpan (make sure cpan is properly configured, by running cpan without arguments first):

sudo cpan -i Spreadsheet::BasicRead

Optional packages for working with OSLC systems:

perl-TimeDate
perl-WWW-Mechanize (available in the EPEL repository)
perl-XML-LibXML

Optional packages for working with GitHub systems:

perl-TimeDate
perl-Mail-Box (available in the EPEL repository)
perl-Mail-Mbox-MessageParser (available in the EPEL repository)
perl-Net-GitHub (available in the EPEL repository)

Optional packages for working with Semios/Prometil systems:

perl-File-Slurp

Optional packages for Advanced CSV Export Management:

perl-Text-CSV (available in the EPEL repository)

For more information about how to install the Extra Packages for Enterprise Linux (EPEL) repository, consult https://fedoraproject.org/wiki/EPEL.

Packages for Ubuntu

On Ubuntu 14.04.3 LTS, the dependencies are satisfied by the following packages: