Installation

The easiest way to use Mayan EDMS is by using the official Docker image. Make sure Docker is properly installed and working before attempting to install Mayan EDMS.

Requirements

Minimum

  • RAM: 1 GB with OCR turned off.

  • CPU: dual core, 64 bit, 1 GHz, Intel Core 2 Duo or similar.

  • Debian GNU/Linux, or a derivative distribution for direct operating system installations. Other operating system can serve as host if the Docker image is used.

Note

Installation in hardware with even lower specifications, like single board computer with ARM CPUs is possible with below minimal performance and user experience expectations.

Note

Due to the way container and virtualization technologies work, expected a performance reduction if these are used, with the performance reduction being greater with virtualization. Use hardware that includes hardware level optimizations for virtualization for best results.

Installation methods

Docker

Docker is a computer program that performs operating-system-level virtualization also known as containerization. It allows independent “containers” to run within a single Linux instance, avoiding the overhead of starting and maintaining virtual machines (VMs).

Note

Starting with version 3.4, the preferred method of installation when using Docker is with Docker Compose. The installation script at https://get.mayan-edms.com and the Simple Docker installation are deprecated and will be removed in the future.

Direct installation

For users with knowledge of Python, Django, Ubuntu, and databases.