Skip to content

Instantly share code, notes, and snippets.

@CanOfBees
Created June 15, 2021 14:52
Show Gist options
  • Save CanOfBees/5cc34e4c1054e0b32ef9d6a31ab5e210 to your computer and use it in GitHub Desktop.
Save CanOfBees/5cc34e4c1054e0b32ef9d6a31ab5e210 to your computer and use it in GitHub Desktop.
Setup Steps for ArchivesSpace

Steps to set up ArchivesSpace

ArchivesSpace application

The AS application is self-contained, but you do need a JVM. I think a JRE is sufficient, but we've used the full OpenJDK for deploying. The AS docs specify version 1.8 for your java.

  1. cd /vhosts/ && wget https://github.com/archivesspace/archivesspace/releases/download/v3.0.1/archivesspace-v3.0.1.zip
  2. unzip archivesspace-v3.0.1.zip

Database

For anything other than local fun, use a robust SQL ("squill") database. See the official readme for different info. Note that the following steps assume that you have already downloaded and unpacked the ArchivesSpace release from github.

  1. Grab the appropriate java connector lib for your database (mysql = mysql-connector-java-${version-to-match-your-mysql}.jar; mariadb = connector-java-2.7.3.jar) and drop it in to ${as-root-dir}/lib/.
  2. Set up your database:
    • create your database and be sure to use UTF-8 as the default character encoding.
    • create your user and grant them all privileges on the new database.
  3. Modify the ArchivesSpace config file (${as-root-dir}/config/config.rb) and update the AppConfig[:db_url] line to use the credentials you just set on the database.
  4. Change directory to ${as-root-dir}/scripts and run setup-database.sh to get the new database configured for use by the application.
  5. Head over to the "Getting Started" section to give the application a test start.

Notes and/or Warnings:

  1. During the first startup, start ArchivesSpace as a daemon: cd to ${as-root-dir} and archivesspace.sh start
  2. Tail the log, in ${as-root-dir}/logs/archivesspace.out, and watch for trouble messages.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment