Installing on Ubuntu LTS

Login to your Ubuntu server using an account with sudo privileges. Go to the directory where you want to install CollectionSpace. We recommend:

cd /usr/local/share

CollectionSpace runs as a Tomcat 7 server application. A pre-configured version of Tomcat 7 is provided with the CollectionSpace distribution package.

Start by downloading the CollectionSpace distribution package "tarball":

sudo wget ftp://nightly.collectionspace.org/pub/collectionspace/releases/5.0/cspace-server-5.0.tar.gz

Unpack the tarball:

sudo tar -xzvof cspace-server-5.0.tar.gz

This will create an apache-tomcat-7.0.64 directory in /usr/local/share.

Next, make necessary files owned by the cspace user and executable:

sudo chown -R cspace:cspace apache-tomcat-7.0.64/
sudo chmod u+x apache-tomcat-7.0.64/bin/*.sh

You can remove the tarball if you want/need:

sudo rm cspace-server-5.0.tar.gz

Setting the CollectionSpace Environment Variables

For the CollectionSpace server to install and run properly, it requires the following shell environment variables to be defined for the cspace user account. Ensure that the following values correspond to the cspace user's shell environment. In the next paragraph, we provide instructions for setting these environment variables automatically when you login as the cspace user.

• CSPACE_JEESERVER_HOME: The full path to the apache-tomcat-7.0.64 directory that was created when you unpacked the CollectionSpace tarball; example, "/usr/local/share/apache-tomcat-7.0.64"
• CATALINA_HOME: The full path to the apache-tomcat-7.0.64 directory, usually identical to the value of CSPACE_JEESERVER_HOME.
• CATALINA_PID: The full path to a file which will hold the Tomcat server process number. This is used by the Tomcat shutdown script.
• CATALINA_OPTS: Environment options for the Tomcat server process. The example value for this variable in the next section is a Java Virtual Machine (JVM) memory setting.

• JAVA_HOME: The full path to your Java directory. If you are unsure where this variable should point to, you can execute this command:

  readlink -f `which java` | sed -e "s/\/jre\/bin\/java$//"

  which gets you the path to the Java installation taking only the part that comes before the text "jre/bin/java". See the example values below.

• DB_HOST:  The hostname or IP address of the server running PostgreSQL. (Commonly 'localhost' when running on the same machine as catalina/tomcat)
• DB_PORT:  The port for the Postgresql servicer. Usually 5432
• DB_CSADMIN_PASSWORD: The password for the administrative database user for the CollectionSpace application. This must match the password for the user that you specified while setting up PostgreSQL in the prerequisites section. (This administrative user by default will be named csadmin, and will be a postgresql superuser. However, this user will have fewer privileges than the overall database administrator superuser, by default named postgres.)
• DB_NUXEO_PASSWORD: Any database-legal password of your choice for the nuxeo database user. This user can work with CollectionSpace data stored in Nuxeo databases. Nuxeo is essentially the content management system underlying CollectionSpace.
• DB_CSPACE_PASSWORD: Any database-legal password of your choice for the cspace database user. This user can work with CollectionSpace data for users, roles, and authentication and authorization.
• DB_READER_PASSWORD: Any database-legal password of your choice for the reader database user. This user will have read-only access to CollectionSpace data stored in Nuxeo databases.
• CSPACE_INSTANCE_ID: String appended to default CollectionSpace database names. Use a value of "_default" by default. If your instance of CollectionSpace is sharing a PostgreSQL server with other CollectionSpace instances, this environment variable provides a way to distinguish your databases from others.
• JEE_PORT: The HTTP port for the Services layer. Usually 8180
• ANT_OPTS: Environment options for the Apache Ant build tool. The recommended options below are Java Virtual Machine (JVM) memory settings.
• MAVEN_OPTS: Environment options for the Maven build tool. The recommended options below are Java Virtual Machine (JVM) memory settings.

By default, all but the "core" CollectionSpace tenants/profiles are disabled. You'll need to explicitly enable the tenants you want to use by setting environment variables for them.

• CSPACE_CORE_CREATE_DISABLED_OPT: Default value is true. If set to false, enables the core/common tenant.
• CSPACE_BONSAI_CREATE_DISABLED_OPT: Default value is true. If set to false, enables the Bonsai tenant.
• CSPACE_FCART_CREATE_DISABLED_OPT: Default value is true. If set to false, enables the Fine and Contemporary Art tenant.
• CSPACE_HERBARIUM_CREATE_DISABLED_OPT: Default value is true. If set to false, enables the Herbarium tenant.
• CSPACE_LHMC_CREATE_DISABLED_OPT: Default value is true. If set to false, enables the Local History and Material Culture tenant.
• CSPACE_MATERIALS_CREATE_DISABLED_OPT: Default value is true. If set to false, enables the Materials tenant.
• CSPACE_PUBLICART_CREATE_DISABLED_OPT: Default value is true. If set to false, enables the Public Art tenant.
• CSPACE_ANTHRO_CREATE_DISABLED_OPT: Default value is true. If set to false, enables the Anthropology tenant.
• CSPACE_BOTGARDEN_CREATE_DISABLED_OPT: Default value is true. If set to false, enables the Botanical Garden tenant.

Your CollectionSpace instance can be configured to fetch data from another CollectionSpace instance. For example, the Materials profile/tenant can be configured to fetch shared authority and vocabulary data from a CollectionSpace instance that is setup to share common authority data. The following environment variables can used to create a connection to that CollectionSpace instance.

• CSPACE_CLIENT_SAS_URL_OPT: The URL to the "shared" CollectionSpace instance -e.g., http://nightly.collectionspace.org:8180/cspace-services/

• CSPACE_CLIENT_SAS_USER_OPT: A username for an account on the "shared" CollectionSpace instance.

• CSPACE_CLIENT_SAS_PASSWORD_OPT: The password for the account on the "shared" CollectionSpace instance.

• CSPACE_CLIENT_SAS_SSL_OPT: Set to true if the "shared" CollectionSpace instance is running SSL/HTTS.

The example below is for a Linux Bash shell. As the cspace user, edit ~/.bashrc (or ~/.bash_profile) and be sure to substitute the actual values for that are specific to your environment. Login as the cspace user:

sudo su - cspace

Now edit the .bashrc file:

vim ~/.bashrc

Add the following lines of text to the end of the .bashrc file:

#
# Environment variables for the CollectionSpace server
#
export CSPACE_JEESERVER_HOME="/usr/local/share/apache-tomcat-7.0.64"
export CATALINA_HOME="$CSPACE_JEESERVER_HOME"
export CATALINA_PID="$CSPACE_JEESERVER_HOME/bin/tomcat.pid"
export CATALINA_OPTS="-Xmx1524m"
export JAVA_HOME="/usr/lib/jvm/java-8-openjdk-amd64/"
export ANT_OPTS="-Xmx1524m"
export MAVEN_OPTS="-Xmx1524m"
export CSPACE_INSTANCE_ID="_default"
export DB_HOST="localhost"
export DB_PORT="5432"
export JEE_PORT="8180"
#
# PostgreSQL password for the special "csadmin" user/role we setup during the PostgreSQL installation
# Make sure you're using the correct value for the password -i.e., the one you picked/set during installation.
#
export DB_CSADMIN_PASSWORD="csadmin"
#
# Additional passwords for CollectionSpace's databases.  Change these passwords to something more secure and difficult to guess.
#
export DB_NUXEO_PASSWORD="nuxeo"
export DB_CSPACE_PASSWORD="cspace"
export DB_READER_PASSWORD="reader"
#
# Enable/Disable Tenants/Profiles.  A value of "true" will disable and "false" will enable.
#
export CSPACE_CORE_CREATE_DISABLED_OPT="false"
export CSPACE_BONSAI_CREATE_DISABLED_OPT="true"
export CSPACE_FCART_CREATE_DISABLED_OPT="true"
export CSPACE_HERBARIUM_CREATE_DISABLED_OPT="true"
export CSPACE_LHMC_CREATE_DISABLED_OPT="true"
export CSPACE_MATERIALS_CREATE_DISABLED_OPT="false"
export CSPACE_PUBLICART_CREATE_DISABLED_OPT="true"
export CSPACE_ANTHRO_CREATE_DISABLED_OPT="true"
export CSPACE_BOTGARDEN_CREATE_DISABLED_OPT="true"
export CSPACE_TESTSCI_CREATE_DISABLED_OPT="false"
#
# These are just example values for the Shared/Remote CollectionSpace connection information
#
export CSPACE_CLIENT_SAS_URL_OPT="http://nightly.collectionspace.org:8180/cspace-services/"
export CSPACE_CLIENT_SAS_USER_OPT="admin@materials.collectionspace.org"
export CSPACE_CLIENT_SAS_PASSWORD_OPT="Administrator"
export CSPACE_CLIENT_SAS_SSL_OPT="true"

Save your changes and exit the vim editor. Next, make sure to source your ~/.bashrc so the environment variables are set and available. The next time you login to the cspace account, these environment variables will be set automatically.

source ~/.bashrc

WARNING: Use difficult to guess values for the password environment variables above -i.e., the ones ending with "_PASSWORD". The value for the environment variable DB_CSADMIN_PASSWORD should be the password you created when you setup PostgreSQL in a previous section of this installation guide.

cd $HOME
mkdir collectionspace-source
cd collectionspace-source
git clone https://github.com/collectionspace/services -b v5.0-branch
git clone https://github.com/collectionspace/application -b v5.0-branch

Before running the next set of commands, ensure that your tenant will be enabled by checking the corresponding environment variable. For example, to ensure the "core" tenant is enabled, verify that the CSPACE_CORE_CREATE_DISABLED_OPT environment variable is set to the value false.

env | grep CSPACE_CORE_CREATE_DISABLED_OPT

You should see the following output: CSPACE_CORE_CREATE_DISABLED_OPT=false. If you don't, return to the "Setting the CollectionSpace Environment Variables" section of this document and follow the instructions for enabling/disabling a tenant.

Next, let's build and deploy CollectionSpace from its source code.

cd services
mvn clean install -DskipTests

If successful, enter these commands:

cd ../application
mvn clean install -DskipTests

Next, lets run the commands to create the CollectionSpace databases and a default set of users and permissions.

cd ~/collectionspace-source/services
ant undeploy deploy create_db -Drecreate_db=true import