ArchivesSpace technical documentation

• Basic administration
  • Getting started
  • Running ArchivesSpace as a Unix daemon
  • Running ArchivesSpace as a Windows service
  • Backup and recovery
  • Re-creating indexes
  • Resetting passwords
  • Upgrading
• Architecture and components
  • The ArchivesSpace backend
  • The ArchivesSpace staff interface
  • The ArchivesSpace public user interface
  • Background Jobs
  • Search indexing
  • OAI-PMH interface
• Working with the ArchivesSpace API

  Additional documentation is needed for these sections - please consider contributing documentation via a pull request to this repo

  • GET requests (retrieving records)
  • POST requests (creating and updating records)
  • DELETE requests
  • API reference
• Customization and configuration
  • Configuring ArchivesSpace
  • Adding support for additional username/password-based authentication backends
  • Configuring LDAP authentication
  • ArchivesSpace Plug-ins
  • Customizing text in ArchivesSpace
  • Theming ArchivesSpace
  • Managing frontend assets with Bower
  • Creating Custom Reports
• Provisioning and server configuration
  • Running ArchivesSpace with load balancing and multiple tenants
  • Serving ArchivesSpace over subdomains
  • Serving ArchivesSpace user-facing applications over HTTPS
  • JMeter Test Group Template
  • Running ArchivesSpace against MySQL
  • Application monitoring with New Relic
  • Running ArchivesSpace under a prefix
  • Running ArchivesSpace with external Solr
  • Tuning ArchivesSpace
• Information for developers and code contributors
  • ArchivesSpace build system
  • Building an ArchivesSpace release
  • Using Supervisord for development
  • Docker
  • DB versions listed by release
  • Public User Interface Test Suite
• Importing and exporting data in ArchivesSpace
  • ArchivesSpace repository EAD Exporter
  • ArchivesSpace XSL stylesheets
• Migration tools and data mapping
  • Archivists' Toolkit migration tool instructions
  • Archon migration tool instructions

Note: the yard directory was removed from this repository. For now, the documentation will be maintained in the main ArchivesSpace repository.