Developer documentation
- Elizabeth Roke
This documentation is designed for developers working in ArchivesSpace. Full Emory documentation for ArchivesSpace is in the aspace-deployment github repository.
To set up a local development environment using Docker, follow the steps in the ArchivesSpace tech-docs github repository. To add Emory’s plug-ins to your local instance, follow the steps outlined in the ArchivesSpace plug-ins documentation.
For getting started with ArchivesSpace, the following documentation may be helpful:
Installing, configuring, and maintaining an ArchivesSpace instance (see the customization and theming section)
Environments
There are three ArchivesSpace environments we use:
development: refers to the local development environment each developer is running on their machine.test: refers to the remote test instance managed by Lyrasis. This is the instance where testing is done prior to a production deployment.production: refers to the ArchivesSpace production instance, which is also managed by Lyrasis.
Each directory in this repository is named after one of the environments listed above. Under each directory, there are two files:
config.rb: contains all the custom configurations to the ArchivesSpace environmentplugins.yml: contains a list of all the plugins included in the the ArchivesSpace environment. Each plugin must have the following attributes:
plugins:
- name: aspace_static_plugins # matches git repository name
git: true
branch: "v0.2.1" # matches the version tag or branch in that plugin's repository
url: https://github.com/emory-libraries/aspace_static_plugins.git # url of the plugin's git repositoryGithub
All code related to Emory’s instance of ArchivesSpace is maintained in Github:
aspace-deployment: deployment configuration for ArchivesSpace and processes for deployments with Lyrasis
aspace_static_plugins: local customizations and configurations for ArchivesSpace
API access
Emory maintains two API users for developers: developer_1_api and developer_2_api. They have read/write access and are associated with the Sharepoint email for LTDS.
Emory also maintains a read-only API user for Curate called curate_api.
Credentials for these users are in the division 1Password account so the LTDS division can share them.