matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation: Add install troubleshooting

Browse Source 
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>
This commit is contained in:
Roberto Rosario
2018-11-28 05:07:09 -04:00
parent 13524f5ce0
commit 2bd649ab52
6 changed files with 168 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/topics/administration.rst
View File

@@ -9,3 +9,4 @@ Administration
.. include:: ../chapters/backups.rst
.. include:: ../chapters/scaling_up.rst
.. include:: ../chapters/database_conversion.rst
.. include:: ../chapters/docker.rst

37
docs/topics/installation.rst
View File

@@ -2,9 +2,11 @@
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.
Mayan EDMS can be install in several way. The two recommended ways are: by
using Docker_, and by doing a direct installation.
The Docker method provides the easiest installation process while the direct
installation provides better performance and customization.
*****************************
Minimum hardware requirements
@@ -15,34 +17,9 @@ Minimum hardware requirements
- Unix-like operating system like Linux and OpenBSD. For other operating systems
user container technologies like Docker or virtual machines.
****************
Docker procedure
****************
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).
Docker can be installed using their automated script::
wget -qO- https://get.docker.com/ | sh
This installs the latest versions of Docker. If you don't want run an automated
script follow the instructions outlined in their documentation: https://docs.docker.com/install/
Once the Docker installation is finished, proceed to the link below to install
the Docker image for Mayan EDMS.
Docker image chapter: :ref:`docker_install`
*******************
Direct installation
*******************
For users with knowledge of Python, Django, Ubuntu, and databases.
Deployments chapter: :doc:`../chapters/deploying`
.. include:: ../chapters/docker_installation.rst
.. include:: ../chapters/deploying.rst
.. _Docker: https://www.docker.com/