Appliance category: 
Business management
Storage
Python
Media

Mayan-EDMS

An electronic vault for your documents

Mayan EDMS is a Free Open Source Electronic Document Management System, coded in the Python language using the Django web application framework and released under the Apache 2.0 License. It provides an electronic vault or repository for electronic documents.

This appliance includes all the standard features in TurnKey Core:

  • Mayan EDMS 3.1.9 installed via PIP from PyPI into virtualenv within /opt/mayan-edms

    Security note: Updates to Mayan EDMS may require supervision so they ARE NOT configured to install automatically. See below for updating Mayan EDMS.

  • Includes all pre-reqs: Virtualenv/Django/Gunicorn/Celery/Redis/Supervisor
  • SSL support out of the box.
  • PostgreSQL is is installed as Mayan's backend database
  • Adminer administration frontend for PostgreSQL (listening on port 12322 - uses SSL).
  • Nginx configured as reverse proxy for Mayan WebUI.
  • Webmin modules for configuring PostgreSQL.

Note: as of v15.0 build of Mayan-EDMS appliance, Mayan now uses environment variables to provide config settings. A convenience copy of these can be found at /etc/mayan/env. This makes it easier to run the mayan-edms commandline tool. For example:

ENV=/etc/mayan/env
BIN=/opt/mayan-edms/bin
su - mayan -c ". $ENV && $BIN/mayan-edms.py help"

Supervised Manual Mayan EDMS Update

Always ensure that you have a current, working backup before performing an upgrade.

Read through the relevant Mayan EDMS Release Notes since the version you are upgrading from.

Check Mayan EDMS Direct Deployment - Basic documentation for dependency updates, and other adjustments that may be required. Then to upgrade to the latest version (using 3.1.9 as an example below) of Mayan EDMS from the command line:

REMOVE=/etc/mayan/removals.txt
curl https://gitlab.com/mayan-edms/mayan-edms/raw/master/removals.txt > $REMOVE
supervisorctl stop all
ENV=/etc/mayan/env
BIN=/opt/mayan-edms/bin
su - mayan -c ". $ENV && $BIN/pip uninstall -r $REMOVE"
su - mayan -c ". $ENV && $BIN/pip install mayan-edms==3.1.9"
supervisorctl start all
Share

Usage details & Logging in for Administration

  • Mayan EDMS Admin Account: admin

No default passwords: For security reasons there are no default passwords. All passwords are set at system initialization time.

Ignore SSL browser warning: browsers don't like self-signed SSL certificates, but this is the only kind that can be generated automatically. If you have a domain configured, then via Confconsole Advanced menu, you can generate free Let's Encypt SSL/TLS certificates.

Web - point your browser at either:

  1. http://12.34.56.789/ - not encrypted so no browser warning
  2. https://12.34.56.789/ - encrypted with self-signed SSL certificate

Note: some appliances auto direct http to https.

Web - point your browser at either:

  1. http://12.34.56.789/ - not encrypted so no browser warning
  2. https://12.34.56.789/ - encrypted with self-signed SSL certificate

Note: some appliances auto direct http to https.

Username for database administration:

Login as PostgreSQL username postgres at

  1. https://12.34.56.789:12322/ - Adminer database management web app
  2. PostgreSQL command line tool: 
    $ psql -U postgres -h localhost
Password for user postgres:
Type "help" for help.

postgres=#

Username for OS system administration:

Login as root except on AWS marketplace which uses username admin.

  1. Point your browser to:
  2. Login with SSH client: 
    ssh root@12.34.56.789

    Special case for AWS marketplace:

    ssh admin@12.34.56.789

* Replace 12.34.56.789 with a valid IP or hostname.