mayan-edms

Go to file

Roberto Rosario 2bd649ab52 Documentation: Add install troubleshooting

Add section to outline common pitfalls when installing.
Reference GitLab issue #487.

Update installation instructons to use the setting
MAYAN_DATABASES instead of the old MAYAN_DATABASE_*.

Unify the installation instructions by converting the
chapters into partials that are now included in the
topic file.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>

2018-11-28 05:09:49 -04:00

.tx

Rename statistics app to mayan_statistics to avoid library class

2017-08-29 02:01:41 -04:00

contrib

Make sure the test requirements are installed in the virtualenv.

2018-09-07 04:55:46 -04:00

docker

Release: Bump version to 3.1.9

2018-11-01 03:55:06 -04:00

docs

Documentation: Add install troubleshooting

2018-11-28 05:09:49 -04:00

mayan

Mirroring: Increase cache timeouts

2018-11-28 04:13:48 -04:00

requirements

Initial settings: Refactor setting bootstrapping

2018-11-27 04:06:21 -04:00

__init__.py

Don't import metadata info on top level __init__.py

2012-03-06 00:34:42 -04:00

__init__.py.tmpl

Documentation: Use Sphinx's extlinks to cut down on repeated URLs. Merge Administration and Maintenance topics. Add database conversion chapter. Unify the header format of all recent release notes. Fix :doc: references.

2018-10-18 23:02:30 -04:00

.coveragerc

Exclude tests and settings from coverage report.

2015-10-17 01:28:59 -04:00

.dockerignore

Include the version file in the final docker image.

2018-06-30 00:33:10 -04:00

.flake8

Add flake8 configuration file.

2017-09-05 01:51:04 -04:00

.gitignore

Ignore virtualenv for Python 3.

2018-10-06 02:14:54 -04:00

.gitlab-ci.yml

Add libfuse2 library to test suit.

2018-10-07 14:16:15 -04:00

.magnum.yml

Initial configuration files for magnum-ci.

2015-08-19 01:57:20 -04:00

.travis.yml

Update Travis CI configuration to use Ubuntu Trusty instead of

2017-06-07 10:27:18 -04:00

CONTRIBUTING.md

Fix the link to the documenation. Closes GitLab issue #516 . Thanks to Matthias Urlichs @smurfix for the report.

2018-10-02 02:19:05 -04:00

DCO

Add Developer Certificate of Origin.

2017-02-16 01:50:00 -04:00

generate_setup.py

Add template variable for the setup module build number.

2018-10-18 16:29:31 -04:00

HISTORY_1_x.rst

Split changelog by series.

2018-10-04 03:33:23 -04:00

HISTORY_2_x.rst

Documenation: Fix spelling errors

2018-10-31 18:41:20 -04:00

HISTORY.rst

Mirroring: Increase cache timeouts

2018-11-28 04:13:48 -04:00

increase_version.py

Utilities: Remove remarked statement

2018-10-31 19:05:47 -04:00

LICENSE

Update LICENSE copyright time span to match main module's copyright time span.

2018-07-08 23:01:14 -04:00

Makefile

Add utility and makefile target to increase version number mechanically. Update release checklist.

2018-10-29 12:55:24 -04:00

manage.py

Update project to work with Django 1.10.x

2016-12-22 02:53:06 -04:00

MANIFEST.in

Include the test file in the manifes.

2018-09-07 19:17:02 -04:00

README.md

Update related links. Add links to the new Wiki and Forum.

2018-10-02 02:26:09 -04:00

README.rst

Update related links. Add links to the new Wiki and Forum.

2018-10-02 02:26:09 -04:00

removals.txt

Initial settings: Refactor setting bootstrapping

2018-11-27 04:06:21 -04:00

requirements.txt

Merge branch 'master' of https://github.com/cccs-web/mayan-edms into cccs-web-master

2014-07-11 00:32:50 -04:00

setup.cfg

Don't build universal wheel package

2014-07-12 16:59:14 -04:00

setup.py

Update required Django version to 1.11.16.

2018-10-03 15:16:09 -04:00

setup.py.tmpl

Take the project description from the project main module.

2018-08-23 13:06:00 -04:00

tox.ini

Add Python 3.6 and Django 2.0 targets to the tox file.

2018-10-07 14:17:48 -04:00

README.md

Mayan EDMS is a document management system. Its main purpose is to store, introspect, and categorize files, with a strong emphasis on preserving the contextual and business information of documents. It can also OCR, preview, label, sign, send, and receive thoses files. Other features of interest are its workflow system, role based access control, and REST API.

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.

For the complete set of installation instructions visit the Mayan EDMS documentation at: https://docs.mayan-edms.com/topics/installation.html

Hardware requirements

2 Gigabytes of RAM (1 Gigabyte if OCR is turned off).
Multiple core CPU (64 bit, faster than 1 GHz recommended).

Important links

Languages

Gettext Catalog 47.9%

Python 26.9%

Modelica 23.2%

HTML 0.8%

reStructuredText 0.7%

Other 0.3%