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%\Squoring\squore-server
and contains Squore Server (including its dedicated
JBOSS and PostgreSQL instances as well as a portable Perl distribution in <SQUORE_HOME>\tools\perl
)
<SQUORE_DATA> is %SYSTEMDRIVE%\Squoring\squore-data
and consists of the following subfolders:
<SQUORE_DATA>\cluster
<SQUORE_DATA>\backup
<SQUORE_DATA>\projects
<SQUORE_DATA>\temp
<SQUORE_DATA>\temp\sources
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 PostgreSQL or Oracle database (new in 16.1)
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.
When an error occurs during the installation, the installer wizard remains open and display the log file of the installation, as shown on the screenshot below. When this happens, review the contents of the installer window, and if necessary, copy and send the contents to support@squoring.com.
In order to start installing Squore, log on with an account that has administrator privileges and launch the Squore installer. Each of the wizard screens is documented below in the order that you will see them.
The Squore installer Welcome screen
On the Welcome screen, click the Next button to start the installation.
The Squore Licence Agreement screen
Review the Licence Agreement and click I Agree to accept the terms of the agreement and continue with the installation.
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 the section called “Upgrading from a Previous Version”. 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.
The Squore Components screen
The Components screen allows you to choose between the three available types of installations:
Full: all components will be installed
Minimal: only Squore Server will be installed. Use this mode if a PostgreSQL server and a distribution of the Perl scripting environment are already available on the server
Custom: you define which components will be installed using the checkboxes on the Choose Components screen
If you are unsure which option is the best for you, you can safely use the Full installation, so that all Squore components are installed locally.
Select the appropriate installation mode. Then, click the Next button.
The General Options screen
The Squore General Options screen allows specifying where Squore stores its data and which licence 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 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.
Licence File: the location of the Squore licence file you wish to use for your installation. Note that you can leave this field empty at this time and provide the licence information only after the installation procedure has finished. This is explained in further details in the section called “Updating the Squore Licence File”).
After specifying the data location and optionally pointing to a licence file, click the Next button.
The Squore Additional Options screen
The Squore Additional Options 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. The value can be changed after the installation process finishes by following the steps detailed on http://openwiki.squoring.com/openwiki/index.php/Connect_remotely_to_the_server.
Install as Windows services: Check this box if you want the Windows services
to be installed, and optionally customise their names when clicking the Next button. After the installation completes, you will be able to manage
the PostgreSQL 8.4 Server and JBoss Application Server 7.1.1 services from the Windows Services Console or from
the command line using net start|stop PG84SVC
and
net start|stop JBAS71SVC
.
The services can also be installed after running the wizard, refer to the section called “Running Squore as a Windows Service” for more details.
The PostgreSQL 8.4 Server service is only installed if you are using a local PostgreSQL cluster as your database backend.
Java directory: the directory where the Oracle JDK or JRE is installed. The wizard should have found the appropriate Java installation on your server, but you can modify the value if the JDK you want to use is in a different location using the ... button. Note that Java 1.7.0_51 or higher is required and that Java 1.8 is not supported (see the section called “Installation 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 postgreSQL installation or an 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).
The Advanced Squore settings screen
This screen is only displayed if you checked the Advanced configuration box in step 6.
On the Advanced Squore settings screen, you can modify the default work directory and memory and performance settings for the server.
Temporary data: The location of the temporary data generated by Squore.
Projects data: The location of the data generated by Squore when running analyses on the server.
Backup directory: The location used to store backups when the backup script is launched. For more details about backing up your Squore data, see the section called “Backing-Up the 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 the section called “Changing the Java Heap Size”.
The Local Perl installation screen
This screen is only displayed if you disabled the installation of Portable Strawberry perl box in step 3.
On the Local Perl installation 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.
The Database configuration screen
On the Databse configuration screen, you can specify if your Squore Server installation should use a local PostgreSQL cluster or a database in 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
jdbc:postgresql:[//host[:port]/]dbname for PostgreSQL
When you click the Next button to continue, a connection to the databse is attempted. If the database cannot be reached with the details supplied, you will be asked to review them before you can continue with the installation.
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 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 user name: the user name of the PostgreSQL server admin user
Note that the Administrator password cannot be set. After adjusting your settings, click the Next button to continue.
The Squore database 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 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
Squore user name: the name of the user that will be created as the owner of the database
Note that the database password cannot be set manually. After adjusting your settings, click the Next button to continue.
The JBoss AS networking screen
This screen is only displayed if you checked the Advanced configuration box in step 6.
On the JBoss AS networking screen, you can specify the desired bind address and ports for Squore Server:
Bind address: the bind-address configuration for the JBoss 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 JBoss ports (as described on https://docs.jboss.org/author/display/AS71/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, remoting: 4547
200: http: 8280, remoting: 4647
300: http: 8380, remoting: 4747
The offset is mainly used to install several instances of Squore using different ports on the same machine.
The remoting port is used to share a licence server between multiple installations, as described in the section called “Connecting to a Remote Licence Server”.
After adjusting your settings, click the Next button to continue.
The Windows Services screen
This screen is only displayed if you checked the Install as Windows services box in step 6.
On the Windows Services screen, you can specify the desired name and display name for the two services that control Squore Server:
The PostgreSQL service allows starting and stopping the Squore database
The JBoss AS 7.1 service allows starting and stopping the Squore web server
For a Windows Service, the Name is the alias used in the command line (for example: net start PG84SVC
),
and the Display Name is the name displayed in the graphical Windows Services Console.
The services are set to run under the local system account by default. Depending on your security requirements you may need to manually set the account to a real Windows user to run the services. This can be done after the installation process is finished from the Windows Services console. For more information, consult the Microsoft Windows documentation at https://technet.microsoft.com/en-us/library/cc755249.aspx.
Note that no PostgreSQL service is created if you are using Oracle as your database backend, or a remote PostgreSQL database.
Set the name and display name for each service according to you needs and click the Next button to continue.
The Installation details screen
The Installation details screen shows a summary of the parameters you specified in previous steps of the wizard. Verify that the information matches your selections and click Install to start installing Squore. The installation process lasts a few minutes.
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.
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.
Squore is now ready for use. Refer to the next section to learn how to launch Squore and, if applicable, change the default configuration.