diff --git a/docs/chapters/index_examples.rst b/docs/chapters/index_examples.rst index d42ba86edf..27c9e4f45e 100644 --- a/docs/chapters/index_examples.rst +++ b/docs/chapters/index_examples.rst @@ -9,18 +9,18 @@ This index will create one level for each document type in the system and place links to the document of each respective type. #. Go to the :menuselection:`System --> Setup --> Indexes` menu. -#. Create a new index using :menuselection:`Actions --> Create new`. +#. Create a new index using :guilabel:`Actions` > :guilabel:`Create new`. #. Give it a label to describe it, and an internal name. The internal name is used when referencing this index in other parts of the system. -#. Press the :menuselection:`Template` link of the newly created index. -#. Select :menuselection:`New child node` to create a new level in which the +#. Press the :guilabel:`Template` link of the newly created index. +#. Select :guilabel:`New child node` to create a new level in which the following template code will be entered. :: {{ document.document_type }} #. Save the template. -#. Go to :menuselection:`Document types` and associate this index with +#. Click on :guilabel:`Document types` and associate this index with existing document types in the system. #. Finally go to :menuselection:`Tools --> Rebuild indexes` to execute the index template. The rebuild process is only necessary when changes are diff --git a/docs/chapters/languages.rst b/docs/chapters/languages.rst index 5304bb9ac8..f3f77df3bc 100644 --- a/docs/chapters/languages.rst +++ b/docs/chapters/languages.rst @@ -6,7 +6,7 @@ The list of languages choices in the language dropdown used for documents is based on the current ISO 639 list. This list can be quite extensive. To reduce the number of languages available use the setting ``DOCUMENTS_LANGUAGE_CODES``, and set it to a nested list of abbreviations. This setting can be found in the -:menuselection:`System --> Setup -> Settings -> Common` menu. +:menuselection:`System --> Setup --> Settings --> Common` menu. For example, to reduce the list to just English and Spanish use :: diff --git a/docs/chapters/scaling_up.rst b/docs/chapters/scaling_up.rst index 1b716e1433..01a59cecb3 100644 --- a/docs/chapters/scaling_up.rst +++ b/docs/chapters/scaling_up.rst @@ -50,37 +50,8 @@ low volume, medium duration tasks. It is not advisable to have the same worker processing OCR to process image rendering too. If the worker is processing several OCR tasks it will not be able to provide fast images when an user is browsing the user interface. This is why by default the -queues are split into 3 workers: fast, medium, and slow. - -The fast worker handles the queues: - -* converter: Handles document page rendering -* sources_fast: Does staging file image rendering - -The medium worker handles the queues: - -* checkouts_periodic: Scheduled tasks that check if a document's checkout - period has expired -* documents_periodic: -* indexing: Does reindexing of documents in the background when their - properties change -* metadata: -* sources: -* sources_periodic: Checking email accounts and watch folders for new - documents. -* uploads: Processes files to turn the into Mayan documents. Processing - encompasses MIME type detection, page count detection. -* documents: - -The slow worker handles the queues: - -* mailing: Does the actual sending of documents via email as requested by - users via the mailing profiles -* tools: Executes in the background maintenance requests from the options - in the tools menu -* statistics: Recalculates statistics and charts -* parsing: Parses documents to extract actual text content -* ocr: Performs OCR to transcribe page images to text +queues are split into 3 workers: fast, medium, and slow. Each worker will handle +queues based on the latency required by each queue group. Optimizations @@ -94,15 +65,16 @@ Optimizations * By default each worker process uses 1 thread. You can increase the thread count of each worker process with the Docker environment options: - * MAYAN_WORKER_FAST_CONCURRENCY - * MAYAN_WORKER_MEDIUM_CONCURRENCY - * MAYAN_WORKER_SLOW_CONCURRENCY + * ``MAYAN_WORKER_FAST_CONCURRENCY`` + * ``MAYAN_WORKER_MEDIUM_CONCURRENCY`` + * ``MAYAN_WORKER_SLOW_CONCURRENCY`` -* If using direct deployment, increase the value of the --concurrency=1 +* If using direct deployment, increase the value of the ``--concurrency=1`` argument of each worker in the supervisor file. You can also remove this argument and let the Celery algorithm choose the number of threads to launch. Usually this defaults to the number of CPU cores + 1. + Change the message broker ========================= Messages are the method of communication between front end interactive code @@ -133,7 +105,7 @@ calculation, these are stored for a while so that whoever requested the background task, is able retrieve the result. These results are stored in the result storage. By default a Redis server is launched inside the Mayan EDMS container. You can launch a separate Docker Redis container and tell the Mayan -EDMS container to use this via the MAYAN_CELERY_RESULT_BACKEND environment +EDMS container to use this via the ``MAYAN_CELERY_RESULT_BACKEND`` environment variable. The format of this variable is explained here: http://docs.celeryproject.org/en/3.1/configuration.html#celery-result-backend diff --git a/docs/chapters/sources.rst b/docs/chapters/sources.rst index 00203bb3c9..09fb3c47fe 100644 --- a/docs/chapters/sources.rst +++ b/docs/chapters/sources.rst @@ -51,11 +51,13 @@ The current document sources supported are: web -> manual; } -Document source can be configure to allow document bundles to uploaded as +Document sources can be configure to allow document bundles to uploaded as compressed files which are decompressed and their content uploaded as separate documents. This feature is useful when migrating from another document manager system. +Sources are create in the :menuselection:`System --> Setup --> Sources` menu. + .. note:: If you deployed a Mayan EDMS Docker container and want to use watched folders