From 8fcc61bde52ab2342e114d4b9dbbee431045edbc Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Wed, 17 Oct 2018 21:38:58 -0400 Subject: [PATCH] Update documentation. Add chapter on password resets. Add administration topic. Signed-off-by: Roberto Rosario --- docs/chapters/languages.rst | 4 ++-- docs/chapters/mailing.rst | 31 +++++++----------------- docs/chapters/ocr_backend.rst | 7 +++++- docs/chapters/password_reset.rst | 41 ++++++++++++++++++++++++++++++++ docs/chapters/settings.rst | 4 ++++ docs/index.rst | 34 +++++++++++++------------- docs/releases/index.rst | 6 ++--- docs/topics/administration.rst | 9 +++++++ docs/topics/advanced.rst | 3 --- docs/topics/development.rst | 7 +++--- docs/topics/maintenance.rst | 1 + docs/topics/settings.rst | 4 ---- 12 files changed, 95 insertions(+), 56 deletions(-) create mode 100644 docs/chapters/password_reset.rst create mode 100644 docs/topics/administration.rst diff --git a/docs/chapters/languages.rst b/docs/chapters/languages.rst index b97bd86a7a..5304bb9ac8 100644 --- a/docs/chapters/languages.rst +++ b/docs/chapters/languages.rst @@ -30,7 +30,7 @@ Example:: -e MAYAN_DOCUMENTS_LANGUAGE_CODES='["eng", "spa"]' For more information check out the -:ref:`environment variables ` section of the -:doc:`../chapters/settings` chapter. +:ref:`environment variables ` chapter of the +:doc:`../topics/settings` topic. diff --git a/docs/chapters/mailing.rst b/docs/chapters/mailing.rst index 532a5e9ac9..a36777d2d5 100644 --- a/docs/chapters/mailing.rst +++ b/docs/chapters/mailing.rst @@ -1,31 +1,14 @@ +.. _mailing: + ***************** Mailing documents ***************** Sending emails in Mayan EDMS is controlled by two different system depending on the type of email being sent. These are administrative emails like password -reset emails and user emails sent from the application. - -Sending administrative emails -============================= - -To be able to send password reset emails configure the Django email settings -via the :ref:`configuration file `. - -Example:: - - EMAIL_BACKEND: django.core.mail.backends.smtp.EmailBackend - EMAIL_HOST: '' - EMAIL_HOST_PASSWORD: '' - EMAIL_HOST_USER: '' - EMAIL_PORT: 25 # or 587 or your server's SMTP port - EMAIL_TIMEOUT: - EMAIL_USE_SSL: true - EMAIL_USE_TLS: false - -For more details consult Django's documentation on the topic: -https://docs.djangoproject.com/en/1.11/ref/settings/#email-backend - +reset emails and user emails sent from the application. To configure +administrative email for things like password reset check the topic: +:doc:`../topics/administration` Application emails ================== @@ -35,3 +18,7 @@ Mayan EDMS provides its our own email system called Mailing Profiles. Mailing Profiles support access control per user role and can use different email backends. Mailing Profiles are created from the :menuselection:`System --> Setup` menu. + +Once created mailing profiles allow users to send email messages from +within the user interafce containing either an URL link to the document or +the actual document as an attachment. diff --git a/docs/chapters/ocr_backend.rst b/docs/chapters/ocr_backend.rst index 305df60c68..30de256544 100644 --- a/docs/chapters/ocr_backend.rst +++ b/docs/chapters/ocr_backend.rst @@ -18,4 +18,9 @@ To add support to OCR more languages when using Tesseract, install the corresponding language file. If using a Debian based OS, this command will display the available language files: - apt-cache search tesseract-ocr + apt-cache search tesseract-ocr + +If using the Docker image, pass the environment variable MAYAN_APT_INSTALLS +with the corresponding Tesseract language option. Example:: + + -e MAYAN_APT_INSTALLS='tesseract-ocr-deu' diff --git a/docs/chapters/password_reset.rst b/docs/chapters/password_reset.rst new file mode 100644 index 0000000000..ee23ce66d5 --- /dev/null +++ b/docs/chapters/password_reset.rst @@ -0,0 +1,41 @@ +************** +Password reset +************** + +To use the password reset feature, administrative emails need to be configured. +These are sent by the system itself and not by the users. Their usage and +configuration is different than the +:ref:`email system used to share documents via email`. + +Sending administrative emails +============================= + +To be able to send password reset emails configure the Django email settings +via the :ref:`configuration file `. + +Example:: + + EMAIL_BACKEND: django.core.mail.backends.smtp.EmailBackend + EMAIL_HOST: '' + EMAIL_HOST_PASSWORD: '' + EMAIL_HOST_USER: '' + EMAIL_PORT: 25 # or 587 or your server's SMTP port + EMAIL_TIMEOUT: + EMAIL_USE_SSL: true + EMAIL_USE_TLS: false + +For more details consult Django's documentation on the topic: +https://docs.djangoproject.com/en/1.11/ref/settings/#email-backend + +To change the reference URL in the password reset emails on in the +default document mailing template modify the ``COMMON_PROJECT_URL`` setting. +For information on the different ways to change a setting check the +:doc:`../topics/settings` topic. + +To test the email settings use the management command ``sendtestemail``. +Example:: + + mayan-edms.py sendtestemail myself@example.com + + + diff --git a/docs/chapters/settings.rst b/docs/chapters/settings.rst index ad214f5819..59410c1efb 100644 --- a/docs/chapters/settings.rst +++ b/docs/chapters/settings.rst @@ -1,3 +1,7 @@ +******** +Settings +******** + Mayan EDMS can be configure via environment variables or by setting files. diff --git a/docs/index.rst b/docs/index.rst index fa446e46c0..769278440e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,23 +17,23 @@ repository for electronic documents. .. toctree:: :hidden: - Features - Installation - Release notes and upgrading - Getting started - Access control - Categorization - Collaboration - Settings - Storage - Integration - Maintenance - Advanced topics - Development - FAQ - Licensing - Contact - + topics/features + topics/installation + releases/index + topics/getting_started + topics/access_control + topics/categorization + topics/collaboration + topics/settings + topics/storage + topics/integration + topics/maintenance + topics/administration + topics/advanced + topics/development + topics/faq + topics/license + topics/contact .. _Docker: https://www.docker.com/ .. _Django: http://www.djangoproject.com/ diff --git a/docs/releases/index.rst b/docs/releases/index.rst index 1368d3afc2..b242956747 100644 --- a/docs/releases/index.rst +++ b/docs/releases/index.rst @@ -1,6 +1,6 @@ -############# -Release notes -############# +########################### +Release notes and upgrading +########################### Release notes for the official Mayan EDMS releases. Each release note will tell you what's new in each version, and will also describe any backwards-incompatible diff --git a/docs/topics/administration.rst b/docs/topics/administration.rst new file mode 100644 index 0000000000..e73931a077 --- /dev/null +++ b/docs/topics/administration.rst @@ -0,0 +1,9 @@ +############## +Administration +############## + + +.. include:: ../chapters/languages.rst +.. include:: ../chapters/password_reset.rst +.. include:: ../chapters/ocr_backend.rst +.. include:: ../chapters/scaling_up.rst diff --git a/docs/topics/advanced.rst b/docs/topics/advanced.rst index a8aca62e99..8c26bda021 100644 --- a/docs/topics/advanced.rst +++ b/docs/topics/advanced.rst @@ -4,10 +4,7 @@ Advanced topics .. include:: ../chapters/workflows.rst -.. include:: ../chapters/languages.rst .. include:: ../chapters/signatures.rst .. include:: ../chapters/metadata.rst -.. include:: ../chapters/ocr_backend.rst .. include:: ../chapters/transformations.rst .. include:: ../chapters/versioning.rst -.. include:: ../chapters/scaling_up.rst diff --git a/docs/topics/development.rst b/docs/topics/development.rst index 7f4de931c5..33cdf8e0c9 100644 --- a/docs/topics/development.rst +++ b/docs/topics/development.rst @@ -1,7 +1,6 @@ -############### -Advanced topics -############### - +############## +For developers +############## .. include:: ../chapters/development.rst .. include:: ../chapters/app_creation.rst diff --git a/docs/topics/maintenance.rst b/docs/topics/maintenance.rst index ba822d76a2..17046b1c45 100644 --- a/docs/topics/maintenance.rst +++ b/docs/topics/maintenance.rst @@ -4,3 +4,4 @@ Maintenance .. include:: ../chapters/backups.rst + diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index d62ee3db7f..9520b34ee5 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -1,6 +1,2 @@ -######## -Settings -######## - .. include:: ../chapters/settings.rst