ARON — Administration Guide

ARON (Archiv online) is a public portal for presenting archival records. The backend indexes archival presentation units (APU) and exposes a REST API consumed by a React single-page application; data is ingested from the separate Transfagent application over a SOAP file-transfer interface.

This guide is intended for administrators who install, configure and operate an ARON deployment, and for integrators who connect other systems to it. It contains no help for the portal’s readers; Overview explains why. The Release notes list the changes of every build and mark those that need an administrator’s attention.

Administration guide

• 1. Overview
  • 1.1. What a deployment consists of
  • 1.2. Who this guide is for
  • 1.3. How this documentation is versioned
• 2. Installation
  • 2.1. Prerequisites
  • 2.2. Artifact and layout
  • 2.3. Running
  • 2.4. URL layout
  • 2.5. Reverse proxy and subpath deployment
  • 2.6. Separate port for the internal interfaces
• 3. Upgrading
  • 3.1. General procedure
  • 3.2. Rolling back
  • 3.3. Steps of individual releases
  • 3.4. Coming from the old portal
• 4. Configuration
  • 4.1. application.yml
  • 4.2. types.yaml
  • 4.3. Translating configured text
  • 4.4. Dating vocabulary
  • 4.5. searchConfig.yaml
  • 4.6. pageTemplate.yaml
  • 4.7. Home page
  • 4.8. Citations
  • 4.9. Structured search results
• 5. Search
  • 5.1. Search behavior
  • 5.2. Result ordering
  • 5.3. How ranking works
  • 5.4. Which facets a section offers
  • 5.5. Ordering a facet’s values
  • 5.6. Explaining a facet’s options
  • 5.7. Tuning the weights
  • 5.8. Limits
• 6. Operations
  • 6.1. Search index lifecycle
  • 6.2. Data ingest
  • 6.3. Database
  • 6.4. Monitoring
  • 6.5. Why a request failed

Release notes

• Release notes
  • How to read a changelog entry

Todo

Describe the recommended logging configuration and log locations once the deployment packaging (service unit, log rotation) is settled.

(The original entry is located in /builds/archivonline/aron2/doc/source/admin/operations.rst, line 141.)