ESSArch
  • Introduction
  • Installation
    • Prerequisites
      • Supported OS platforms
      • Database
      • Redis (Minimum version: 5.0)
      • RabbitMQ (Minimum version: 3.8)
      • Elasticsearch (Supported version: 7.*)
    • Automatic installation
    • Docker
      • Dependencies
    • Python
      • Dependencies
      • Install ESSArch
      • Configuring ESSArch
      • Starting the built-in webserver
    • Safety backup procedures
      • Important files to backup
    • Logfiles
      • Events and log information
  • Authentication and authorization
    • Groups
      • Creating groups
      • Adding users to groups
    • Permissions
      • Archival description
        • Agents
        • Structures and nodes
      • Authorization
        • Users
        • Groups
        • Roles
    • Roles
      • Creating roles
      • Assigning roles
  • Configuration
    • Authentication
      • Single Sign-On (SSO)
    • Database
    • Redis
    • RabbitMQ
    • Elasticsearch
    • Paths
      • path_mimetypes_definitionfile
    • Transformers
  • Development Environment
    • Getting the source
    • Setting up virtual Python environments
    • Installing Python dependencies
    • Setting environment variables
    • Configuring services
    • Running migrations
    • Installing initial data
    • Building the frontend
    • Starting the development web server
    • Starting background workers
    • Starting background beat processes
  • Directory Structure
  • External logging and monitoring
    • Using the Elastic Stack
      • Configuration
      • Using Docker
      • Viewing logs in Kibana
  • Format Identifier
    • FormatIdentifier
      • FormatIdentifier.identify_file_format()
    • MIME types
    • Fido
  • Profiles
    • Transformation Profile
      • Specification
    • Validation Profile
      • Specification
      • Built-in validators
        • ChecksumValidator
        • StructureValidator
  • REST API
    • Authentication
      • Token Authentication
        • Get token
        • Use token in request
      • Basic Authentication
      • Session Authentication
    • Archival description management
      • Agents
      • Agent Type
      • Agent Identifier Type
      • Agent Name Types
      • Agent Note Types
      • Agent Place Type
      • Agent Relation Types
      • Authority Types
      • Deliveries
      • Delivery Types
      • Location
      • Location Level Type
      • Location Function Type
      • Language
      • Metric Type
      • Node Relation Type
      • Node Note Type
      • Node Identifier Type
      • Structures
      • Structure Units
      • Structure Type
      • Tag
      • Tag Version Type
      • Ref Code
      • Transfers
    • Events
      • Event Types
    • Information Packages
    • Notifications
    • Orders
      • Orders
    • Profiles
      • Profiles
    • Search
      • Retrieve results
      • Filters
      • Combining filters
      • Stored Search
    • Storage
      • Storage Object
      • Storage Medium
      • Storage Methods
      • Storage Method Target Relation
      • Storage Policy
      • Storage Target
    • Submission Agreement
  • User guide
    • Interface
      • List view
      • State view
      • Events view
      • Delete IP
      • User settings
        • Column picker
        • IP view type
        • File browser view type
    • Producer
      • Prepare IP
        • Prepare
        • Profile editor
      • Collect content
        • Upload
      • Create SIP
      • Submit SIP
    • Ingest
      • Reception
        • Receive SIP
      • Approval
        • Preserve
        • Get
        • Get as new generation
    • Access
      • Storage units
        • Get
        • Get as container
        • Get as new generation
      • Dissemination
    • Workspace
    • Archive maintenance
      • Appraisal
        • Create appraisal rule
        • Connect rule to AIP
        • Appraisal job lists
      • Format conversion
        • Create conversion rule
        • Connect rule to AIP
        • Conversion job lists
    • Archival description management
      • Authority records
        • Creating and managing authority records
      • Archival Descriptions
        • Structures
        • Top-level Resources
      • Location Records
        • Creating and managing location records
      • Accession Records
        • Adding new accession records
        • Accession Events
        • Adding transfers
        • Linking resources
      • ESSArch - ICA-Standards
        • ISAAR (CPF)
        • ISAD-G
        • ISDF
    • Storage migration
      • Select storage mediums
      • Select Information packages
      • Storage migration options
      • Preview storage migration
      • Start storage migration
  • XML Generator
    • XML Specification
      • Creating an empty element
    • XML Variables
      • Reserved XML Variables
    • XML Formatters
    • Django Templates
      • Template Tags
ESSArch
  • Installation
  • Edit on GitHub

Installation

To install and run ESSArch, a set of services first needs to be setup.

  • Prerequisites
    • Supported OS platforms
    • Database
    • Redis (Minimum version: 5.0)
    • RabbitMQ (Minimum version: 3.8)
    • Elasticsearch (Supported version: 7.*)
  • Automatic installation
  • Docker
    • Dependencies
  • Python
    • Dependencies
    • Install ESSArch
    • Configuring ESSArch
    • Starting the built-in webserver
  • Safety backup procedures
    • Important files to backup
  • Logfiles
    • Events and log information
Previous Next

© Copyright 2024, ES Solutions.

Built with Sphinx using a theme provided by Read the Docs.