Technical documentation for ArchivesSpace
View the Project on GitHub archivesspace/tech-docs
ArchivesSpace is a stack of web applications which may require special tuning in order to run most effectively. This is especially the case for institutions with lots of data or many simultaneous users editing metadata. Keep in mind that ArchivesSpace can be hosted on multiple server, either in a multitenant setup or by deploying the various applications ( i.e. backend, frontend, public, solr, & indexer ) on separate servers.
The application itself can tuned in numerous ways. It’s a good idea to read the configuration documentation, as there are numerous settings that can be adjusted to fit your needs.
An important thing to note is that since ArchivesSpace is a Java application, it’s possible to set the memory allocations used by the JVM. There are numerous articles on the internet full of information about what the optimal settings are, which will depend greatly on the load your server is experiencing and the hardware. It’s a good idea to monitor the application and ensure that it’s not hitting the top limits what you’ve set as the heap.
These settings are:
To modify these settings, Linux users can either export an environment variable ( e.g. $ export ASPACE_JAVA_XMX=”Xmx2048m” ) or edit the archivesspace.sh startup script and modify the defaults.
Windows users must edit the archivesspace.bat file.
If you’re having trouble with errors like java.lang.OutOfMemoryError try doubling the ASPACE_JAVA_XMX. On Linux you can do this either by setting an environment variable like $ export ASPACE_JAVA_XMX="Xmx2048m" or by editing archivsspace.sh:
if [ "$ASPACE_JAVA_XMX" = "" ]; then
ASPACE_JAVA_XMX="-Xmx2048m"
fi
For Windows, you’ll change archivesspace.bat:
java -Darchivesspace-daemon=yes %JAVA_OPTS% -XX:+CMSClassUnloadingEnabled -XX:+UseConcMarkSweepGC -XX:NewRatio=1 -Xss2m -X
mx2048m -Dfile.encoding=UTF-8 -cp "%GEM_HOME%\gems\jruby-rack-1.1.12\lib\*;lib\*;launcher\lib\*!JRUBY!" org.jruby.Main "la
uncher/launcher.rb" > "logs/archivesspace.out" 2>&1
NOTE: THE APPLICATION WILL NOT USE THE AVAILABLE MEMORY UNLESS YOU SET THE MAXIMUM HEAP SIZE TO ALLOCATE IT For example, if your server has 4 gigs of RAM, but you haven’t adjusted the ArchivesSpace settings, you’ll only be using 1 gig.
The ArchivesSpace application can hit a database server rather hard, since it’s a metadata rich application. There are many articles online about how to tune a MySQL database. A good place to start is try something like MySQL Tuner or Tuning Primer which can give good hints on possible tweaks to make to your MySQL server configuration.
Keep a close eye on the memory available to the server, as well as your InnoDB buffer pool.
The internet is full of many suggestions on how to optimize a Solr index. Running an external Solr index can be beneficial to the performance of ArchivesSpace, since that moves the index to its own server.