Welcome to the EHRI documentation

Welcome to the EHRI documentation pages. This documentation is intended for people working on the EHRI project or using using related tools.

For general information about the EHRI project please go to:

• The EHRI Project Homepage

• The EHRI Portal

• The EHRI Document Blog

For EHRI staff and administrators:

• Portal Administrator documentation
  • Creating a profile on the EHRI portal
  • First look at the EHRI portal
  • Accessing the Portal Administration pages
  • How to Create Archival Institutions
  • How to Create Archival Descriptions
  • How to create Connections between Originals and Copies
  • Managing Users
  • Managing Groups
  • Understanding Permissions
  • Managing XML Datasets for Ingest
  • Accessing the EAD Manager
  • Overview of the EAD Manager
  • Editing Vocabulary Concepts
  • SKOS Ingest
  • EAD Ingest
  • Superuser Administration Tools
  • Use-Cases

For users of the Omeka-based TEI digital edition platform

• EHRI Digital Editions - Documentation
  • Editorial Process
  • TEI encoding and annotation
  • EHRI Omeka (Classic) plugins and theme
  • Omeka Setup and Installation

For users of the Geonetwork-based geospatial repository

• EHRI Geospatial Repository - Documentation
  • EHRI Geospatial Repository
  • How to contribute

For developers and system administrators:

Backend Web Service

• EHRI Portal Back-end Technical Documentation
  • Overview of the EHRI Data Management Backend
  • The Backend Model Layer
  • Validation & Persistence
  • Serialization
  • Setup of development environment
  • Initialising a fresh Neo4j database and importing some data
  • Deployment
  • Loading JSON Data Dumps
  • Audit Log
  • Miscellaneous Gotchas
  • Identifiers
  • Importing via the Command Line
  • Example Ingest
  • SKOS Ingest
  • Database Migration Changelog
  • Scripting the EHRI environment
  • Using the Web Service
  • Web Service API Documentation
  • WS API Docs

Frontend Portal Site

• EHRI Portal Front-end Technical Documentation
  • Overview of the EHRI Portal and Admin front-end
  • EHRI Portal API - Version 1 - Experimental
  • Controllers and Action Composition
  • Example Cypher usage
  • Deployment
  • Disaster Recover and General Troubleshooting
  • External HTML Pages
  • Miscellaneous Gotchas
  • Setting up the development environment
  • Miscellaneous docs / pre-emptive justification
  • Models
  • Permissions
  • Scala Notes
  • Staging Server
  • Notes on testing

System Administration

• EHRI System Administration
  • Hosting
  • File Storage

National Node Sites

• Adapting the National Node template site
  • Hugo Full Walkthrough
  • Setting up a new NN page on Github

See also

• Metadata Publishing Tool (MPT) manual

• EAD Conversion Tool (ECT) manual