diff --git a/README.md b/README.md index 8289e70bbc..293aba10ee 100644 --- a/README.md +++ b/README.md @@ -42,24 +42,35 @@

Installation

-The installation procedure uses the Docker container manager (docker.com). Make sure Docker is properly installed and working before attempting to install Mayan EDMS. +The easiest way to use Mayan EDMS is by using the official +[Docker](https://www.docker.com/) image. Make sure Docker is properly installed +and working before attempting to install Mayan EDMS. -Step 1- Initialize the installation +With Docker properly installed, proceed to download the Mayan EDMS image using +the command: ```bash -docker run --rm -v mayan_media:/var/lib/mayan \ --v mayan_settings:/etc/mayan mayanedms/mayanedms mayan:init + $ docker pull mayanedms/mayanedms:2.3 ``` -Step 2- Deploy a container +After the image finishes downloading, initialize a Mayan EDMS container. ```bash -docker run -d --name mayan-edms --restart=always -p 80:80 \ --v mayan_media:/var/lib/mayan -v mayan_settings:/etc/mayan mayanedms/mayanedms + $ docker run -d --name mayan-edms --restart=always -p 80:80 \ + -v mayan_data:/var/lib/mayan mayanedms/mayanedms ``` -Step 3- Open a browser and go to http://localhost +Point your browser to the IP address 127.0.0.1 (or the alternate port chosen, +ie: 127.0.0.1:81) and use the automatically created admin account. +All files will be stored in the Docker volume ``mayan_data`` + +If another web server is running on port 80 use a different port in the ``-p`` +option, ie: ``-p 81:80``. + +For the complete set of installation, configuration, upgrade, and backup +instructions visit the Mayan EDMS Docker Hub page at: +https://hub.docker.com/r/mayanedms/mayanedms/

Important links

diff --git a/README.rst b/README.rst index 041f0b4b8d..da7611e96d 100644 --- a/README.rst +++ b/README.rst @@ -16,25 +16,37 @@ are its workflow system, role based access control, and REST API. :align: center -The installation procedure uses the Docker container manager -(docker.com). Make sure Docker is properly installed and working before -attempting to install Mayan EDMS. +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. -Step 1- Initialize the installation +With Docker properly installed, proceed to download the Mayan EDMS image using +the command: -.. code:: bash +.. code-block:: bash - docker run --rm -v mayan_media:/var/lib/mayan \ - -v mayan_settings:/etc/mayan mayanedms/mayanedms mayan:init + $ docker pull mayanedms/mayanedms:2.3 -Step 2- Deploy a container +After the image finishes downloading, initialize a Mayan EDMS container. -.. code:: bash +.. code-block:: bash - docker run -d --name mayan-edms --restart=always -p 80:80 \ - -v mayan_media:/var/lib/mayan -v mayan_settings:/etc/mayan mayanedms/mayanedms + $ docker run -d --name mayan-edms --restart=always -p 80:80 \ + -v mayan_data:/var/lib/mayan mayanedms/mayanedms -Step 3- Open a browser and go to http://localhost +Point your browser to the IP address 127.0.0.1 (or the alternate port chosen, +ie: 127.0.0.1:81) and use the automatically created admin account. + +All files will be stored in the Docker volume ``mayan_data`` + +If another web server is running on port 80 use a different port in the ``-p`` +option, ie: ``-p 81:80``. + +For the complete set of installation, configuration, upgrade, and backup +instructions visit the Mayan EDMS Docker Hub page at: +https://hub.docker.com/r/mayanedms/mayanedms/ + +.. _Docker: https://www.docker.com/ Important links