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.

Verify that your installation fulfills the minimum Requirements to ensure you obtain a proper experience using Mayan EDMS.

Installation methods

Docker Compose

Docker Compose is a Docker plugin for defining and orchestrating Docker applications spanning multiple containers.

Note

This is the default installation method and is recommended for the majority of cases.

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).

Kubernetes

For enterprise installations.

Important

This installation method requires deeper Docker knowledge and requires additional software products like load balancers, object storage, container registries, monitoring, among others.

Each enterprise deployment is unique and there is no single recommendation or guidance that applies to all. For this reason information on scaling up is not provided as it alone would be the topic for an entire book.

If you or your organization needs to scale Mayan EDMS beyond what is possible with a default installation, commercial services are available and performed by members of the core team.

We have helped hundreds of companies scale up Mayan EDMS to host millions of documents with unlimited growth potential as well as creating high availability and fault tolerant deployments.

We would love to meet you and your team to have a discussion. For more details, visit https://www.mayan-edms.com/support/

Use the official Helm chart located at: https://gitlab.com/mayan-edms/helm-chart

Note

For more information about installating Mayan EDMS on Kubernetes read Knowledge Base tutorials:

  • Deploy Mayan EDMS on Kubernetes using a MicroK8s cluster and shared storage

Portainer

For users with an existing installation of Portainer.

Direct deployment

The direct deployment method is no longer supported.