Update documentation

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
2019-05-16 01:31:36 -04:00
parent ebc7886c81
commit b2ddf0c6bb
4 changed files with 443 additions and 292 deletions
+21 -4
View File
@@ -7,10 +7,11 @@ How to use this image
.. _docker_install: .. _docker_install:
Start a Mayan EDMS image Start a Mayan EDMS Docker image
------------------------ -------------------------------
With Docker properly installed, proceed to download the Mayan EDMS image using the command:: With Docker properly installed, proceed to download the Mayan EDMS image using
the command::
docker pull mayanedms/mayanedms:<version> docker pull mayanedms/mayanedms:<version>
@@ -37,7 +38,7 @@ expose its internal 5432 port (PostgreSQL's default port) via the host's
``/docker-volumes/mayan-edms/postgres`` folder. ``/docker-volumes/mayan-edms/postgres`` folder.
Finally create and run a Mayan EDMS container. Change <version> with the Finally create and run a Mayan EDMS container. Change <version> with the
latest version in numeric form (example: 2.7.3) or use the ``latest`` latest version in numeric form (example: 3.2) or use the ``latest``
identifier:: identifier::
docker run -d \ docker run -d \
@@ -252,6 +253,17 @@ category. Default is 1. Use 0 to disable hardcoded concurrency and allow the
Celery worker to launch its default number of child processes (equal to the Celery worker to launch its default number of child processes (equal to the
number of CPUs detected). number of CPUs detected).
``MAYAN_USER_UID``
Optional. Changes the UID of the ``mayan`` user internal to the Docker
container. Defaults to 1000.
``MAYAN_USER_GUID``
Optional. Changes the GUID of the ``mayan`` user internal to the Docker
container. Defaults to 1000.
Accessing outside data Accessing outside data
====================== ======================
@@ -297,6 +309,7 @@ too need to be backed up using their respective procedures. A simple solution
is to copy the entire database container volume after the container has is to copy the entire database container volume after the container has
been stopped. been stopped.
Restoring from a backup Restoring from a backup
======================= =======================
@@ -304,6 +317,7 @@ Uncompress the backup archive in the original docker volume using::
sudo tar -xvzf backup.tar.gz -C / sudo tar -xvzf backup.tar.gz -C /
Upgrading Upgrading
========= =========
@@ -333,6 +347,7 @@ Start the container again with the new image version::
docker run -d --name mayan-edms --restart=always -p 80:8000 -v /docker-volumes/mayan:/var/lib/mayan mayanedms/mayanedms:latest docker run -d --name mayan-edms --restart=always -p 80:8000 -v /docker-volumes/mayan:/var/lib/mayan mayanedms/mayanedms:latest
Building the image Building the image
================== ==================
@@ -355,6 +370,7 @@ Or using an apt cacher to speed up the build::
Replace the IP address `172.17.0.1` with the IP address of the computer Replace the IP address `172.17.0.1` with the IP address of the computer
running the APT proxy and caching service. running the APT proxy and caching service.
Customizing the image Customizing the image
===================== =====================
@@ -379,6 +395,7 @@ Specifies a list of Python packages to be installed via ``pip``. Packages will
be downloaded from the Python Package Index (https://pypi.python.org) by be downloaded from the Python Package Index (https://pypi.python.org) by
default. default.
Using Docker compose Using Docker compose
==================== ====================
+407 -288
View File
File diff suppressed because it is too large Load Diff
+1
View File
@@ -20,6 +20,7 @@ versions of the documentation contain the release notes for any later releases.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
3.2
3.1.11 3.1.11
3.1.10 3.1.10
3.1.9 3.1.9
+14
View File
@@ -1,3 +1,5 @@
Archlinux
archlinux
adf adf
ajax ajax
ajaxForm ajaxForm
@@ -173,3 +175,15 @@ YaN
yasg yasg
YbN YbN
YrcN YrcN
metacopy
overlayfs
sys
supervisord
Monkeypatch
Bootswatch
sortable
Odroid
callables
ModelPermission
mixins
kwargs