Installing Prerequisites

Make sure you are a logged in as a user with Administrative rights and sudo privileges.

Installing Xcode

To install Xcode and its command line tools:

• Open the App Store application. (You can find it in your /Applications folder.)
• Search for Xcode.
• Click the appropriate link(s) to download and install Xcode. (Note: this is a large download, fully 1.65 GB for Xcode 4.6, for example.)
• Install the Xcode command line tools:
  • Open the Xcode application. (You can find it, once it has been installed, in your /Applications folder.)
  • If this is a first-time installation of Xcode:
    • Accept the License Agreement.
    • Download any suggested components at the System Component Installation screen.
  • Select Preferences ... from the Xcode menu.
  • Click the Downloads icon.
  • Install the Command Line Tools from the Downloads->Components tab.

Updating Mac OS X

Select Software Update... from the Apple menu. Among other things, this will guide you through:

• Updating Mac OS X to version 10.8.2, or to whatever may be the latest version of Mac OS X 10.8 ("Mountain Lion") as of this writing.
• Applying the latest Apple security updates to your operating system.

Performing a Software Update will also help ensure that you will have updated copies of certain other CollectionSpace installation prerequisites, such as the Ant and Maven build tools.

Installing Java

To install Java 7:

• Visit Oracle's Java SE download page
• Click any of the Java Platform (JDK) 7u... Download buttons on that page.
• Click the Accept License Agreement button.
• Follow the next steps described in Oracle's guide, How do I install Java for my Mac?:
  • One minor but important change from that guide: you'll be downloading a file whose name begins with jdk, rather than jre as described in the guide. 
    (As of this writing, the file you will want to download is named jdk-7u13-macosx-x64.dmg: the Java Development Kit (JDK) for Java 7 Update 13.)

Installing ImageMagick

ImageMagick is a graphics package required by the CollectionSpace system for displaying and manipulating images.

Linux users have the benefit of using built-in package managers - tools that install software packages - to install many of the necessary prerequisites for installing CollectionSpace.

Mac OS X does not come with a built-in package manager. Instead, the following steps will first install Homebrew, an easy and lightweight package manager, as a means to install ImageMagick.

Run the Homebrew install script:

ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Next, install Git, a fast version control system used by Homebrew, to initiate the installation of ImageMagick:

brew install git

Next, install a package that includes a shared library required by ImageMagick:

brew install libtool --universal

Finally, install ImageMagick:

brew install imagemagick

brew install libtiff
brew install imagemagick --with-libtiff

Installing the PostgreSQL database server

REQUIRED: Although the next steps are in a separate page, they are mandatory for the install to work.

Follow the instructions for installing and setting up the PostgreSQL server on this page. After installing and setting up the PostgreSQL server, return to this page and complete the remaining CollectionSpace-related installation steps below.

Installing CollectionSpace

Getting CollectionSpace

Go to the directory where you want to install CollectionSpace:

cd /usr/local/share

Download the tarball:

wget https://s3-us-west-2.amazonaws.com/cs-public-shared-files/releases/5.1/cspace-server-5.1.tar.gz

tar zxvof {multi-excerpt-include:pageTitle=VERSION INCLUSIONS|name=TARBALL-NAME|nopanel=true}

rm cspace-server-5.1.tar.gz

chmod u+x apache-tomcat-7.0.57/bin/*.sh

export CSPACE_JEESERVER_HOME="/usr/local/share/apache-tomcat-7.0.57" export CATALINA_HOME=$CSPACE_JEESERVER_HOME export CATALINA_PID="$CSPACE_JEESERVER_HOME/bin/tomcat.pid" export CATALINA_OPTS="-Xmx1024m -XX:MaxPermSize=384m" \# Note that the JAVA_HOME declaration below uses backticks (`), rather than double quote marks: export JAVA_HOME=`/usr/libexec/java_home` export DB_CSADMIN_PASSWORD="your_csadmin_database_user_password_here" export DB_NUXEO_PASSWORD="your_nuxeo_database_user_password_here" export DB_CSPACE_PASSWORD="your_cspace_database_user_password_here" export DB_READER_PASSWORD="your_reader_database_user_password_here" export ANT_OPTS="-Xmx768m -XX:MaxPermSize=512m" export MAVEN_OPTS="-Xmx768m -XX:MaxPermSize=512m"

. ~/.bashrc

sudo vi /etc/paths

/Library/PostgreSQL/9.1/bin

Initializing default authorities and term lists

In order to make a newly-created tenant fully functional, you must initialize data for that tenant. The process of initializing data involves reading configuration files in CollectionSpace's Application layer and, from that configuration, creating:

• A set of authorities, which will hold authority terms for persons, organizations, storage locations, and the like. Initializing this data is necessary to be able to save authority term records (Person, Storage Location, Concept, etc.), as well as to enable "autocomplete" fields, in which you can type into a field and be presented with suggestions for matching terms.
• A set of vocabularies, along with lists of terms in each of these vocabularies. Initializing this data is necessary to populate the options that appear in certain drop down menus.

The process of initializing authorities and vocabularies/term lists involves two steps:
1. Logging into the tenant in which you wish to initialize data.
2. Visiting a specific URL to begin the initialization process. (You'll then see on-screen messages describing its progress.)

For instance, when you install a brand-new CollectionSpace system, you'll need to initialize data for the demonstration core tenant. To do so:

• Make sure you are logged into the core tenant, then enter this URL in a browser:
  http://<ip-address>:8180/collectionspace/tenant/core/authorities/initialise

Populating with sample records

You can optionally choose to populate a CollectionSpace tenant with a set of sample records. These include over 2,000 authority term records for persons and organizations.

Typically you would only populate a demonstration or "play" tenant with sample records, to avoid intermingling sample records with "real" records. To populate the demonstration core tenant with sample records:

• Make sure you are logged into the core tenant, then enter this URL in a browser:
  http://<ip-address>:8180/collectionspace/tenant/core/reset

Enabling access logging - which is turned off by default - is a recommended best practice. Logging accesses to your CollectionSpace system can often help you troubleshoot configuration, operational, security, and performance issues.

Procedure

To enable access logging:

1. If the CollectionSpace server is running, stop the server
2. Edit the file $CSPACE_JEESERVER_HOME/conf/server.xml (or %CSPACE_JEESERVER_HOME%\conf\server.xml on a Windows system).

3. Uncomment the AccessLogValve directive in this file, by removing any XML comment markers (<!-- and –>) that may be present around that section:

   <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" prefix="localhost_access_log." suffix=".txt" pattern="common" resolveHosts="false"/>

4.  (Optional) To add round-trip timings to access log entries, identifying how long each request to your CollectionSpace system took to process and send a response, change the value of the pattern= attribute from "common" to the pattern value below, exactly as shown:

   <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" prefix="localhost_access_log." suffix=".txt"  pattern="%h %l %u %t &quot;%r&quot; %s %b %T" resolveHosts="false"/>

5.  Restart the CollectionSpace server