|
|
The following is a list of the officially supported and tested operating systems:
CentOS 6
CentOS 7
Fedora 19
Ubuntu Server 16.04
Windows 8
Windows 10
Windows Server 2012 R2
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
Windows 7
Ubuntu Server 10.04
Ubuntu Server 14.04
Windows Server 2008 R2
Squore Server can use the following database management systems to store its data:
PostgreSQL 8.4 and up
Oracle Database 12c Enterprise Edition Release 12.1.0.2.0 - 64bit Production
In both cases, it is possible to have database on the same machine as Squore Server or on a remote machine.
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.
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 a successful installation of Squore, you will need:
The latest version of the Squore Server installer, which can be downloaded from https://support.squoring.com/download_area.php
A supported Operating System, as stated in the section called “Supported Operating Systems”
The latest version of the Squore CLI installer, which can be downloaded from https://support.squoring.com/download_area.php for installations where only a command-line client is needed
The latest version of the Squore Eclipse Plugin, which can be downloaded from http://localhost:8180/SQuORE_Server/eclipse for developer environments where Squore Eclipse Plugin will be used
A user account with system administrator privileges
The Oracle Java Runtime Environment version 8 (other versions are not supported)
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
A supported Eclipse version (Luna SR2 and up)
Valid credentials to log into a Squore Server
At least 4 GB of space available on the disk for a full installation with demo projects
A valid Squore Server licence file (optional, since the licence file can be added after installation)
The java
executable should be in the machine's PATH
environment variable for Squore CLI to run successfully.
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. For a production database, you should plan a minimum of 20 GB of disk space.
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)
A Squore licence file is linked to the hardware that Squore Server is installed on. When you complete your installation of Squore Server, and access http://localhost:8180/SQuORE_Server in your browser, you are presented with a screen that allows you to request an activation key and download an evaluation licence.
Request an activation key or enter an existing one to download a temporary licence for your machine. Requesting an activation key ensures that Squoring gets all the information necessary to generate your final licence file when the evaluation period ends.
The licence request dialog only displays when accessing http://localhost:8180/SQuORE_Server (it redirects to http://localhost:8180/SQuORE_Server/License/License.xhtml) from the machine where Squore Server is installed. If you cannot open a browser window on the server, you will have to request your evaluation licence by manually generating and e-mailing your host-id to Squoring:
Open a terminal on the machine where you installed or plan to install Squore.
Change to the <SQUORE_HOME> folder
Run the command java -jar ./lib/hostid.jar
.
Send the output to support@squoring.com.
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.
A JRE is required for Squore CLI. The Windows installer contains the tcl and perl runtimes needed. It will allow you to obtain the configuration needed to create projects from the server.
A compatible version of Eclipse must be downloaded from http://www.eclipse.org/downloads/ if you are planning on using Squore Eclipse Plugin.
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]
(Squore Server only) DBD::Pg (unless you use a Oracle as your database backend) [module details]
(Squore Server only) 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]
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,
(Squore Server only) 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.
(Squore Server only) The rsync utility
A supported Eclipse version (Luna SR2 and up) if you are planning on using the Squore Eclipse Plugin
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.
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
(Squore Server only) postgresql-server (unless you use a RDBMS running on another system)
(Squore Server only) rsync
tcl
A compatible installation of Eclipse downloaded from http://eclipse.org/downloads if you plan on using Squore Eclipse Plugin.
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)
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.
On Ubuntu 16.04.3 LTS, the dependencies are satisfied by the following packages:
Mandatory packages:
libalgorithm-diff-perl
libarchive-zip-perl
libdate-calc-perl
(Squore Server only) libdbd-pg-perl (unless you use a Oracle as your database backend)
(Squore Server only) libdbi-perl (unless you use a Oracle as your database backend)
libhttp-message-perl
libjson-perl
libwww-perl
libxml-parser-perl
openjdk-8-jre
perl
(Squore Server only) postgresql (unless you use a RDBMS running on another system)
(Squore Server only) rsync
tcl
A compatible installation of Eclipse downloaded from http://eclipse.org/downloads if you plan on using Squore Eclipse Plugin.
Optional packages for working with Microsoft Excel:
make (CPAN utility requirement)
libhtml-parser-perl
libspreadsheet-parseexcel-perl
libspreadsheet-xlsx-perl
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:
libtimedate-perl
libwww-mechanize-perl
libxml-libxml-perl
Optional packages for working with GitHub systems:
libtimedate-perl
libmail-box-perl
libmail-mbox-messageparser-perl
libnet-github-perl
Optional packages for working with Semios/Prometil systems:
libfile-slurp-perl
Optional packages for Advanced CSV Export Management:
libtext-csv-perl