diff --git a/HISTORY.rst b/HISTORY.rst index dbc3e76de1..3eb843de53 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -7,6 +7,7 @@ Importer branch ================== * Support configurable GUnicorn timeouts. Defaults to current value of 120 seconds. +* Fix help text of the platformtemplate command. 3.2.3 (2019-06-21) ================== diff --git a/docs/chapters/deploying.rst b/docs/chapters/deploying.rst index 3a90e44556..425f3274f9 100644 --- a/docs/chapters/deploying.rst +++ b/docs/chapters/deploying.rst @@ -4,7 +4,6 @@ Direct deployments Mayan EDMS should be deployed like any other Django_ project and preferably using virtualenv_. Below are some ways to deploy and use Mayan EDMS. -Do not use more than one method. Being a Django_ and a Python_ project, familiarity with these technologies is recommended to better understand why Mayan EDMS does some of the things it @@ -38,7 +37,7 @@ For another setup that offers more performance and scalability refer to the Platforms with the ARM CPU might also need additional requirements. :: - apt-sudo get libffi-dev libssl-dev -y + sudo apt-get install libffi-dev libssl-dev -y 2. Create the user account for the installation: @@ -149,7 +148,7 @@ For another setup that offers more performance and scalability refer to the ------------------------------------------------------------------------ :: - MAYAN_DATABASE_ENGINE=django.db.backends.postgresql MAYAN_DATABASE_NAME=mayan \ + sudo MAYAN_DATABASE_ENGINE=django.db.backends.postgresql MAYAN_DATABASE_NAME=mayan \ MAYAN_DATABASE_PASSWORD=mayanuserpass MAYAN_DATABASE_USER=mayan \ MAYAN_DATABASE_HOST=127.0.0.1 MAYAN_MEDIA_ROOT=/opt/mayan-edms/media \ /opt/mayan-edms/bin/mayan-edms.py platformtemplate supervisord > /etc/supervisor/conf.d/mayan.conf @@ -161,17 +160,17 @@ For another setup that offers more performance and scalability refer to the database and only keep 1 database: :: - echo "maxmemory-policy allkeys-lru" >> /etc/redis/redis.conf - echo "save \"\"" >> /etc/redis/redis.conf - echo "databases 1" >> /etc/redis/redis.conf - systemctl restart redis + sudo echo "maxmemory-policy allkeys-lru" >> /etc/redis/redis.conf + sudo echo "save \"\"" >> /etc/redis/redis.conf + sudo echo "databases 1" >> /etc/redis/redis.conf + sudo systemctl restart redis 13. Enable and restart the services [1_]: ----------------------------------------- :: - systemctl enable supervisor - systemctl restart supervisor + sudo systemctl enable supervisor + sudo systemctl restart supervisor 14. Cleaning up: @@ -180,7 +179,7 @@ For another setup that offers more performance and scalability refer to the installation and can be removed. :: - apt-get remove --purge libjpeg-dev libpq-dev libpng-dev libtiff-dev zlib1g-dev + sudo apt-get remove --purge libjpeg-dev libpq-dev libpng-dev libtiff-dev zlib1g-dev .. _deployment_advanced: @@ -227,7 +226,7 @@ of a restart or power failure. The Gunicorn workers are increased to 3. with:: - MAYAN_BROKER_URL="amqp://mayan:mayanuserpass@localhost:5672/mayan", + MAYAN_BROKER_URL="amqp://mayan:mayanrabbitmqpassword@localhost:5672/mayan", increase the number of Gunicorn workers to 3 in the line (``-w 2`` section):: @@ -240,7 +239,7 @@ of a restart or power failure. The Gunicorn workers are increased to 3. ------------------------ :: - supervisorctl restart all + sudo supervisorctl restart all diff --git a/docs/releases/3.2.4.rst b/docs/releases/3.2.4.rst index 3220236ed3..9db3ec8308 100644 --- a/docs/releases/3.2.4.rst +++ b/docs/releases/3.2.4.rst @@ -9,7 +9,7 @@ Changes - Support configurable GUnicorn timeouts. Defaults to current value of 120 seconds. - +- Fix help text of the platformtemplate command. Removals -------- diff --git a/mayan/apps/platform/management/commands/platformtemplate.py b/mayan/apps/platform/management/commands/platformtemplate.py index f76fcc8c7e..3517d5c14a 100644 --- a/mayan/apps/platform/management/commands/platformtemplate.py +++ b/mayan/apps/platform/management/commands/platformtemplate.py @@ -16,7 +16,8 @@ class Command(management.BaseCommand): ) parser.add_argument( '--context', action='store', default='', dest='context', - help='Show a list of available templates.', + help='Pass a context to the template in the form of a JSON encoded ' + 'dictionary.', ) def handle(self, *args, **options):