Squarebox

Prerequisites

System Requirements

This section describes how to install the necessary prerequisites for CatDV Server on Mac OS X, Windows and generic Unix-like systems. These prerequisites must be in place on your system before attempting to install CatDV Server for the first time. Please refer to the separate instructions later in this manual if you are upgrading an existing installation.

CatDV Server has the following system hardware and software requirements:

Operating system:

· Windows Windows 2008 R2 / Windows 7 or later

· Mac OS X (10.10 or later), including Mac OS X Server

· Linux – most modern distributions

Hardware

· At least 16GB RAM

· Solid-state storage preferred – ideally NVMe

To install CatDV Server you will require system administrator privileges and a working knowledge of administration procedures (including exposure to use of command line tools) for your chosen operating system. If necessary please consult your local system support group.

Optional Third Party Software Dependencies

CatDV Server will run “out of the box” on Windows and Mac OS systems without the need to install any third party components. However, to get the most from CatDV Server you are advised to install a third party database server, and you may also choose to install a third party web application server.

On Linux you will need to install a Java Runtime Environment (JRE) – though typically an OpenJDK-based JRE is included by default in most Linux Server distributions.

Third Party Database Servers

CatDV Server stores all data in a relational database. It includes a built-in database server (based on the Java H2 database) but it is recommended that you install a third part database server.

Currently CatDV Server supports the following Database Servers:

· MySQL (5.7 or newer) – widely used open-source database server and by far the most common choice.

· Microsoft SQL Server (2008 R2 or newer) – commercial Windows-only database server.

· Oracle – commercial database server.

One of third party database should be downloaded and installed prior to installing and configuring CatDV Server.

Web Application Server

The CatDV Web Interface is built using Java technology and runs in an Apache Tomcat Java Web Application Server.

An embedded version of Apache Tomcat is included as part of CatDV Server but it is also possible to run the CatDV Web Interface in separate instance of Tomcat running on a separate server machine. This helps distribute the computational load across multiple servers.

Java Runtime Environment

Java is the underlying technology used to create most CatDV components. On Windows and Mac the Java runtime is bundled with the CatDV applications so there is not requirement to install a Java runtime on these platforms. On Linux the CatDV components do require a Java Runtime (OpenJDK) to be installed, but this is commonly included with most Linux distributions

MySQL Installation

Please note that MySQL is an open source database available for download and installation at no cost. However, if you are using it for commercial purposes you should purchase a basic MySQL network license and support. The cost of the MySQL license is very reasonable and doing so will both support the MySQL development efforts and provide assistance if you should need it for the database itself.

Mac OS X

If you don’t already have MySQL on your machine download the MySQL Community Edition from dev.mysql.com. You need Adminstrator privileges to perform these once only steps:

Visit http://dev.mysql.com/downloads/mysql/ and download the 5.7 (or later) Installer Package installation appropriate for your Mac OS X version (there are separate downloads depending on your process and Mac OS X version). Select a ‘Standard’ release. Click “Pick a mirror” to download the software.

Double click the .dmg file to open the disk image. (Safari will normally open the disk image automatically once it has downloaded) and then double click on the installer to install the software.

MySQL also comes with a convenient System Preferences item to start and stop the server.

Make sure MySQL is installed correctly and you can type “/usr/local/mysql/bin/mysql” to start the text-based client program to access the database. If you successfully see the “mysql>” prompt type “quit” (or press Ctrl-C) to exit mysql and return to the command shell and then proceed to “CatDV Server Installation” (section 3.4 below).

Optionally, you can set a password for the MySQL root user (which is different from the ‘root’ user under Mac OS X or Unix) by typing the following in Terminal:

/usr/local/mysql/bin/mysqladmin –u root –password secret

where secret is the password you want to set.

Creating a my.cnf config file (Mac OS X and Mac OS X Server)

A MySQL installation has a large number of tuning and other configuration parameters that can be set by means of a my.cnf configuration file. Unlike Windows, where the installer automatically creates a my.ini config file, by default a MySQL configuration under Mac OS X won’t automatically have a config file, which means that MySQL will run with default values for its configuration.

If you don’t already have a my.cnf config file then it’s a good idea to create one so you can set up various MySQL parameters as required. The easiest way to do this is copy an existing template file to /etc/my.cnf .

When you launch the CatDV Control Panel it will offer to install a default config file for you.

You can also install a config file manually, either coping my-sample.cnf from the CatDV installation directory or using one of the templates provided by MySQL itself (/usr/share/mysql/my-large.cnf under Mac OS X Server, /usr/local/mysql/support-files/my-large.cnf under Mac OS X). Use Terminal.app to run the following command and enter your password when prompted to do so by the sudo command:

sudo cp templateFile /etc/my.cnf

Note that MySQL looks for its config file in a number of places and while /etc/my.cnf is the standard location your site may already have a config file elsewhere. Consult your administrator if you’re not sure.

Windows

If you don’t already have MySQL on your machine download the MySQL Community Edition from www.mysql.com.

1. Ensure that you have .Net 4 installed on your machine. Generally, if you are running Windows Update then you should already have this, but if not it can be downloaded from Microsoft’s download site if required.

2. Go to http://dev.mysql.com/downloads/mysql/ and download the MySQL Installer for Windows.

3. Double click the downloaded MSI installer to install MySQL.

4. It is recommended that you choose Full Install and then accept the defaults recommended by the MySQL installation wizard.

5. At the Configuration step:

1. Choose – Server Machine on first page

2. Select – Enable TCP/IP Networking with default port number 3306

3. Select – Create Windows Service with default name “MySQL57”

4. Choose a root password

6. At the Complete stage untick Start MySQL Workbench after Setup Windows – Older MySQL Versions

Linux/Generic Unix

Many Linux installations come with MySQL pre-installed. If not:

1. Visit http://dev.mysql.com/downloads/mysql and download and install the appropriate version for your platform (including Linux, Solaris, FreeBSD, AIX etc.)

2. Follow the instructions provided with MySQL to install a binary distribution, set appropriate permissions, and start the server.

3. Make sure MySQL is installed correctly and you can type “mysql” to start the text-based client program to access the database. If you successfully see the “mysql>” prompt type “quit” (or press Ctrl-C) to exit mysql and return to the command shell and then proceed to “CatDV Server Installation” as described below.

Copyright © Square Box Systems Ltd. 2002-2019. All rights reserved.

MS SQL Server Installation

This section describes the steps necessary to install and configure Microsoft SQL Server.

Installing SQL Server 2008 Express Edition

SQL Server Express Edition is a free version of Microsoft SQL Server that places a 4Gb limit on total database size. However, installation and configuration are similar to the Standard or Enterprise editions, so you should be able to follow a similar process.

1. Download the SQL Server 2008 Express with Management Tools installer. You should make sure that you select the correct 32 bit or 64 bit edition based on on your server and operation system.

2. Run the installer

3. If there are any prerequisties missing on your machine the installer may ask you to install those.

4. At the Installation screen click on New Installation. This will launch the setup wizard.

5. Accept the license terms and continue.

6. On the Feature Selection screen ensure all features are selected and accept the default install location. Click next.

7. In the Instance Configuration select Default Instance and ensure that Instance ID is MSSQLSERVER. Click next.

8. On the Server Configuration screen access the defaults and continue.

9. Under Database Confuguration you must choose Mixed Mode authentication. You will then need to choose a password for the admin (sa) user. Other settings should be left at their default.

10. Accept defaults and continue until the installation starts.

11. The installation should complete after a few minutes.

Once installation is complete you need to run SQL Server Management Studio to perform the post-install configuration steps.

CatDV Database Creation

In SQL Server Management Studio right click the Databases node of the tree and choose New Database. Enter ‘catdv’ as the database name and click OK. The database will be created.

CatDV User Account Creation

At run time CatDV Server will require a user account to use to connect to the SQL Server instance. Traditionally this use is called ‘catdv’ – but this is not fixed. The CatDV Server Control Panel will request the user name and password of this account during post-installation configuration.

In SQL Server Management Studio expand the Security node of the tree and right click the Logins node and choose New Login..

Enter ‘catdv’ into the name field and choose SQL Server Authentication. Choose a password – traditionally this is also ‘catdv’ but you may want to choose something more secure. You will need to untick Enforce password policy.

Choose ‘catdv’ as the default database.

In the left panel click on User Mapping. Tick ‘catdv’ in the top pane, and then ‘dbowner’ in the bottom pane. Click OK to create the user.