Server Requirements and Preparations

This document provides hardware and software requirements for a CollectionSpace server. We strongly recommend installing CollectionSpace on a dedicated Ubuntu 20.04.x LTS server. Most of our development and testing of CollectionSpace has taken place on Ubuntu 20.04.x LTS servers. That said, as far as we know, the CollectionSpace server runs fine on Mac OS X, Windows 7, and several other flavors of Linux.

To install CollectionSpace onto an Ubuntu 20.04 LTS server, you'll need to be very comfortable with the Linux bash shell and with using common Linux command-line tools. You will also need to have an account on the Ubuntu server that has elevated (i.e., sudo) privileges/permissions.

Supported Operating Systems

Although we regularly build and use CollectionSpace servers in multiple Linux environments and don't anticipate problems running CollectionSpace servers in other environments (other Unix-like OSes, Mac OS X, Microsoft Windows), CollectionSpace has been extensively tested ONLY on Ubuntu 20.04.x LTS servers.

Successful Installations to Date

Operating systems on which the CollectionSpace server has been successfully installed and run to date include:

Linux distributions:
- Ubuntu 20.04 LTS (Recommended)
Apple Mac OS X:
- Mac OS X 10.12 (Sierra)
Microsoft Windows:
- Windows 7

Table 1-1 Hardware Requirements Summary

The hardware capabilities of your server will often have a greater impact on your system's overall performance than the capabilities of your client computers. Generally, the more memory and CPU you have available on your server, the better your CollectionSpace system will perform.

Requirement	Value
Physical memory (RAM)	2 GB RAM (4 GB or higher strongly recommended), 1 GB cache
Virtual memory / swap space	At least 1/2 amount of physical RAM
Disk space	40 GB (depends on the size of your collections data)
Processor	1 GHz minimum
System Architecture	Processor: Intel (x86), AMD64, and Intel EM64T

Table 1-2 Software Requirements for Installation

Requirement	Value Description
Database system: PostgreSQL server	PostgreSQL 9.6 or later is required and the most current stable production version is recommended. (See CollectionSpace-specific PostgreSQL installation instructions)
Java Development Kit (JDK)	JDK 8 (Java SE 1.8) or OpenJDK 8
Build tools: Ant	Ant 1.8.2 or higher
Build tools: Maven	Maven 3.0 or higher
ImageMagick	ImageMagick 6.0 or higher (See Installing ImageMagick)
FTP Client	Any FTP client tool (e.g. FileZilla)
Gzip	Any tool that handles gzip files (eg. tar (Linux, Mac OS X), winzip (Windows), 7-zip (Windows))

CollectionSpace is offered under the terms of an open source ECL 2.0 License (https://source.collectionspace.org/collection-space/LICENSE.txt).

Server Machine Preparations

Prepare your server machine (UNIX or Windows) to run CollectionSpace by following the next steps:

Install the required software described in Table 1-2 on the server machine. In particular, ensure that a PostgreSQL database server is installed and running. (For some instructions on installing PostgreSQL under various operating systems, see the relevant guide in Installing CollectionSpace.)
Create a folder in which to download the CollectionSpace software.

After doing so, follow the instructions for installing the CollectionSpace server in the relevant installation guide in Installing CollectionSpace.

Client Recommendations

Since the client side of CollectionSpace is a standard web interface, the requirements for the client are relatively light. Clients need only a reasonably up-to-date web browser (Internet Explorer is not supported) running under an operating system like Windows 7 or Mac OS X.

Because the CollectionSpace front-end runs in JavaScript within the browser, a faster client computer with more memory will yield better performance. The speed of the JavaScript interpreter in the client browser will also impact some aspects of performance.

Table 1-3 Client Software Recommendations

The CollectionSpace system is routinely tested with specific combinations of web browsers and operating systems, whose use is both recommended and supported:

Requirement	Description
Operating System - Client	Windows 7 or newer, Mac OS X 10.6 or newer
Browser	See the supported browsers reference document.

Browser not supported