Mayan#

Mayan EDMS Mayan EDMS is a document management system.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling mayan#

Command:#

vlab set mayan.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

mayan
enable: True

Finalising changes:#

run: vlab update_one service=mayan

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

Setting up Watched and Staged folders#

  1. Change the owner of the watch and staged directories to www-data

    You may or may not need to do this.

    [client]$ sudo chown www-data path/to/your/watch/dir
    [client]$ sudo chown www-data path/to/your/staged/dir

2) Go to the Mayan web interface.

- Go to `System -> settings -> sources`.
- Click on `actions -> add new watch folder`
- Fill out the options, for `Folder Path` type "/watched_files"
- By default, it will scan for new files every 600 seconds (10 minutes), change that to a lower number if you'd like.
- Save
- Click on `actions -> add new stagging folder`
- fill out the options, for `Folder Path` type "/staged_files"
- Save

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=mayan to complete the changes

ACCESS#

mayan (HTTPS) link: https://mayan.vivumlab.xyz/ mayan (HTTP) link: http://mayan.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set mayan.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

mayan
https_only: True
Finalising changes:#

run: vlab update_one service=mayan

AUTH#

Default: False
Options: True/False

Command:#

vlab set mayan.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

mayan
auth: True
Finalising changes:#

run: vlab update_one service=mayan

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set mayan.domain mayan.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

mayan
domain: mayan.com
Finalising changes:#

run: vlab update_one service=mayan

SUBDOMAIN#

Default: mayan
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set mayan.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

mayan
subdomain: media
Finalising changes:#

run: vlab update_one service=mayan

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set mayan.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

mayan
version: 2.7
Finalising changes:#

run: vlab update_one service=mayan

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.