.. _meg-docs-access:

Enabling Access to MEG Docs
===============================

MEG Docs is disabled by default and has to be enabled for :term:`institution` or :term:`group <Institution group>`
by creating a :class:`~megdocs.models.MegDocsConfig` object with the following minimal config:

.. code-block:: json

    {
      "enabled": true
    }

Enabling Access to MEG Docs
---------------------------

Individual users need to have ``megdocs.view_document`` :ref:`permission <permissions>` to access the document management system.
This grants them access to all root level documents within the institutions they are a part of.

.. note::
    User may still be able to access documents even without access to the root folder.
    :class:`~megdocs.models.FolderPermissionRule` can grant a user access to a folder without granting access to the root directory.

Access to folders
^^^^^^^^^^^^^^^^^^^

Access to individual :term:`folders <folder>` is controlled by :class:`~megdocs.models.FolderPermissionRule` model.
It allows you to specify which users or :term:`teams <team>` can access documents within the folders,
and set permissions to specify which operations they can carry out on the contents of the folder.

.. seealso:: :ref:`document_folder_levels` in Levels section for more detailed access behaviour.

Permission cache
----------------
Users permissions to documents and folders are compiled into a :class:`cache <megdocs.models.FolderPermissionCache>` that helps optimize DMS performance to acceptable levels.
This can introduce a delay after a user or document is added, or permission changed until the permission cache becomes effective.