ELZA Administration Guide

ELZA is a web application for processing archival materials and preparing finding aids. This guide is for administrators who install, configure, upgrade and operate an ELZA instance, and for integrators who connect it to other systems.

Archival description rules (ZP2015), methodics and the user guide are published separately in Czech.

Contents

• 1. Overview and Requirements
  • 1.1. Architecture
  • 1.2. Server requirements
  • 1.3. Client requirements
• 2. Installation
  • 2.1. Installation with the install scripts
  • 2.2. Manual installation
  • 2.3. First start
• 3. Upgrading
  • 3.1. Upgrading within the 3.x line
  • 3.2. Upgrading from 2.x
  • 3.3. Upgrading from 1.x and 0.x
• 4. Configuration Reference
  • 4.1. The configuration file
  • 4.2. Database and working directory
  • 4.3. Web server and uploads
  • 4.4. Logging
  • 4.5. Background processing
  • 4.6. Search and caches
  • 4.7. Scheduled maintenance
  • 4.8. Outputs
  • 4.9. Attachments
  • 4.10. Import
  • 4.11. Restart from the administration
  • 4.12. Archival entities
  • 4.13. Map layers
  • 4.14. Web services
  • 4.15. AI assistant
  • 4.16. Monitoring
  • 4.17. Diagnostics
  • 4.18. Keys that are no longer used
• 5. Authentication and Security
  • 5.1. Authentication methods
  • 5.2. The first administrator
  • 5.3. The default user
  • 5.4. Internal accounts and passwords
  • 5.5. Active Directory
  • 5.6. Kerberos (SPNEGO)
  • 5.7. SSO header
  • 5.8. OAuth2 / JWT
  • 5.9. Personal API keys
  • 5.10. Security audit log
  • 5.11. Other settings
• 6. Running Behind a Reverse Proxy
  • 6.1. ELZA on its own host name
  • 6.2. ELZA under a path
• 7. Integrations
  • 7.1. CAM
  • 7.2. Map servers
  • 7.3. REST API
  • 7.4. SOAP web services
  • 7.5. Entry URLs
  • 7.6. Integration script
• 8. Monitoring
  • 8.1. Management port
  • 8.2. Endpoints
  • 8.3. ELZA metrics
  • 8.4. Reporting to a supervision service
• 9. Backup and Restore
  • 9.1. What to back up
  • 9.2. Database
  • 9.3. The dms directory
  • 9.4. Schedule and retention
  • 9.5. Restore
• 10. Troubleshooting
  • 10.1. Log files
  • 10.2. The database is locked
  • 10.3. A package is older than the imported one
  • 10.4. Wrong characters in texts
  • 10.5. WebSocket does not work
  • 10.6. Data fixes for old versions
• 11. Appendix: Legacy Upgrades
  • 11.1. Duplicate item objects (upgrade to 2.1.2 and later)
  • 11.2. Duplicate CAM bindings (upgrade to 2.3.4 and later)
  • 11.3. Language of the fund root (2.8.5 and later)
  • 11.4. Numerical scale (2.8.16 and later)
• 12. Release Notes
  • 12.1. Changes in 3.4.x