This documentation relates to an as-yet UNRELEASED CollectionSpace version.

Skip to end of metadata
Go to start of metadata

Installing CollectionSpace

CollectionSpace is installed on a server and accessed by users via a web browser like Chrome, Firefox, or Safari. No additional software needs to be installed on your users' computers.

Tip: The left sidebar makes finding documentation easier

Icon

To view the Table of Contents links in the left sidebar, click this icon in the upper-right area of this page:

 

 

Installing the CollectionSpace server

Automated installer for CollectionSpace 4.3

Icon

You are invited to try out an automated installer for performing an unattended installation of a CollectionSpace 4.3 server on selected Linux systems.


FIRST - Your first step should be to ensure that all System Requirements for a CollectionSpace Server have been met.

 

Document Title

Description

System Requirements for a CollectionSpace Server

Lists the operating system and server requirements for running CollectionSpace.

Installing 4.3 on Yum Compatible Linux Distributions

How to install CollectionSpace on Red Hat, Fedora, CentOS, and similar Linux systems

Installing 4.3 on Ubuntu 14.04

How to install CollectionSpace on Ubuntu 14.04 LTS
(with potential applicability to other versions of Ubuntu, and to Debian and similar Linux systems)

Installing 4.3 on Generic Unix-like or Windows Systems

How to install CollectionSpace on a generic Unix-like or Windows system.

Elasticsearch (Optional)

Beginning with version v4.3, you can configure CollectionSpace to work with an Elasticsearch cluster. To learn more about Elasticsearch follow this link: https://www.elastic.co/guide/en/elasticsearch/reference/1.7/getting-started.html

To use CollectionSpace with Elasticsearch, you'll first need to download and install Elasticsearch 1.7.x.  As of v4.3, CollectionSpace works with Elasticsearch v1.7.x (does not work yet with v2.x of Elasticsearch).  You can download it here: https://www.elastic.co/downloads/past-releases/elasticsearch-1-7-4 You can learn how to setup an Elasticsearch cluster by following this link: https://www.elastic.co/guide/en/elasticsearch/reference/1.7/setup.html.  The default configuration will create a cluster named "elasticsearch" which is the cluster CollectionSpace will attempt to work with by default.

By default, CollectionSpace will attempt to connect to an Elasticsearch cluster named "elasticsearch" running on the same server.  You can point CollectionSpace to a different cluster by changing the configuration file at '$CSPACE_JEESERVER_HOME/cspace/config/services/proto-elasticsearch-config.xml' and restarting the CollectionSpace server.

Be sure your Elasticsearch cluster is running before you start the CollectionSpace server.  This will ensure that all your CollectionSpace collection data will be indexed by Elasticsearch.

Related Documentation

  • No labels