Technical Requirements¶
On this page
- Hardware and server environment
- Minimum hardware requirements
- Software dependencies
- Other dependencies
Hardware and server environment¶
Please note that it is difficult to provide an authoritative baseline or recommended system specification for running AtoM. What is considered an “acceptable” performance level is subjective, and the performance of the application depends greatly on factors such as the how much data is in the database and how many users are accessing the site simultaneously.
Furthermore, AtoM makes use of different components and services that could be deployed in a distributed manner (across multiple machines in a network) in order to accept an escalating number of users. The main goal of this documentation is to describe the configuration of AtoM and its dependencies on a single machine, but some aspects of a multi-node installation will also be discussed.
Minimum hardware requirements¶
Note
The following information is intended to provide a starting point for setting up your system. It provides specifications for an “all-in-one” deployment, with all of the services (i.e. nginx, Percona server, ES, memcached) installed in a single virtual machine.
For a frame of reference, Artefactual’s standard AtoM test/demo site deployment is a cloud VM with the following specifications:
- Processor: 2 vCPUs @ 2.3GHz
- Memory: 7GB
- Disk space (processing): 50GB at a minimum for AtoM’s core stack plus more storage would be required for supporting any substantial number of digital objects.
Software dependencies (required)¶
These are the minimum requirements, but please remember that in most of the cases you’ll experience better results working with the latest stable releases of each component.
- A webserver like Apache or Nginx; Artefactual prefers the latter in development
- Elasticsearch 5.x (we use ES 5.6 in development). Elasticsearch 6.0 or newer is not supported as they have deprecated a number of APIs still used in AtoM
- Java 8 (required for Elasticsearch)
- MySQL 8.0
- PHP 7.4
- Gearman job server
Optionally, Memcached can be used as cache engine:
Additionally, the following PHP extensions are mandatory:
- cURL
- JSON
- APC (apcu-bc also required)
- PDO and PDO-MySQL
- XSL
And the following PHP extensions are optional:
- Readline (not available in Windows).
- Memcache (needs`php-memcache`, not php-memcached).
Note
All these dependencies can run in a number of different operative systems, including Windows, Mac OS X, or Ubuntu Linux Linux - Ubuntu 20.04 LTS (Focal Fossa).
Other dependencies¶
ImageMagick
ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 100) including DPX, EXR, GIF, JPEG, JPEG-2000, PDF, PhotoCD, PNG, Postscript, SVG, and TIFF. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.
ImageMagick is used in AtoM to create image derivatives (reference and thumbnail) from the master digital object, including the creation of derivatives from uploaded multi-page TIFFs. ImageMagick and Ghostscript are required for creating single page and multi-page PDF derivative images as well.
Ghostscript
Ghostscript is a suite of software based on an interpreter for Adobe Systems’ PostScript and Portable Document Format (PDF) page description languages. Its main purposes are the rasterization or rendering of such page description language files, for the display or printing of document pages, and the conversion between PostScript and PDF files. (Wikipedia)
Ghostscript is used in AtoM with ImageMagick for creating single-page and multi-page PDF derivative images
FFmpeg
FFmpeg is a complete, cross-platform solution to record, convert and stream audio and video. It includes libavcodec - the leading audio/video codec library.
FFmpeg is used in AtoM to create video derivatives, including creating a flash reference video derivative for in-browser viewing.
pdftotext (part of poppler-utils)
pdftotext is an open source command-line utility for converting PDF files to plain text files —i.e. extracting text data from PDF-encapsulated files. It is freely available and included by default with many Linux distributions, and is also available for Windows as part of the Xpdf Windows port. (Wikipedia)
pdftotext is used in AtoM to extract PDF text to make it searchable via AtoM’s user interface.
Apache FOP
Apache™ FOP (Formatting Objects Processor) is a print formatter driven by XSL formatting objects (XSL-FO) and an output independent formatter. It is a Java application that reads a formatting object (FO) tree and renders the resulting pages to a specified output.
Apache FOP is used in AtoM to create PDF finding aids.