Installation and Administration Guide

Table of Contents

Typographical Conventions

Acronyms and Abbreviations

1. Introduction

Foreword
About This Document
Contacting Squoring Technologies Product Support
Responsabilities
Getting the Latest Version of this Manual

2. The Squore Architecture

The Squore Ecosystem
The Squore Database and Data Folder
The Squore Application Server
The Squore Client
Squore CLI
The Squore Licence Server

3. Installing Squore

Installation Prerequisites

Supported Operating Systems
Browser Compatibility
For All Systems
Obtaining a Licence File
Packages for Windows
Packages for Linux

Common Deployment Scenarios

Creating Projects using the Web Interface Only
Creating Projects From a Client Machine
Using Squore in Continuous Integration
Access from Mobile Devices

Installing Squore on Windows

Installing Squore on Linux

Third-Party Plugins and Applications

Upgrading from a Previous Version

On Windows
On Linux

4. Starting Squore

Starting Squore on Windows
Starting Squore on Linux

5. Squore Administration

Getting to Know the Installation Folder

Understanding config.xml

Default Configuration
Adding a Configuration Folder
Giving Each User Their Own Temporary Folder

Backup Tools

Configuring Squore's Data Storage

Backing-Up the Squore Installation

On Windows
On Linux

Restoring Squore Data

On Windows
On Linux

Resetting the Squore Installation

On Windows
On Linux

Changing Squore Server Port Number

Configuring Timeouts

Number of Concurrent Analyses

Theme Control

Updating the Squore Licence File

Connecting to a Remote Licence Server

Running Squore as a Service

Managing Squore User Accounts

Deactivating and Deleting Users
Importing and Exporting Users

Setting Perl Environment

Windows
Linux

6. Integrating Squore on Your Network

Accessing Squore via HTTPS

Redirecting from HTTP to HTTPS

Using the LDAP Authentication Module

Key and Certificate Management

Import a private key and a certificate
Import a certificate

Configuring E-Mail Notifications

Notifying Users by E-Mail

Embedding Dashboard Elements

Integration with Atlassian Confluence

Squore Server Configuration
Confluence Admin Configuration
Adding Dashboard Elements

Integration with CollabNet TeamForge

Squore Configuration
TeamForge Configuration
Integration Characteristics

Squore Server Monitoring

7. Sizing Squore Server and Database

Project Size and Growth

Saving Space by Deleting Old Data Files

Performance Implications

Available RAM
Project Volume

A. Reference pages

install — Squore install script
sqexport.pl — Squore export utility
sqimport.pl — Squore import utility