-
-
Notifications
You must be signed in to change notification settings - Fork 171
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
28b104c
commit 0ffaf96
Showing
97 changed files
with
3,152 additions
and
3,011 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,23 +17,26 @@ Document Management System | |
| :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html | ||
| :alt: License: LGPL-3 | ||
| .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fdms-lightgray.png?logo=github | ||
| :target: https://github.com/OCA/dms/tree/16.0/dms | ||
| :target: https://github.com/OCA/dms/tree/17.0/dms | ||
| :alt: OCA/dms | ||
| .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png | ||
| :target: https://translation.odoo-community.org/projects/dms-16-0/dms-16-0-dms | ||
| :target: https://translation.odoo-community.org/projects/dms-17-0/dms-17-0-dms | ||
| :alt: Translate me on Weblate | ||
| .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png | ||
| :target: https://runboat.odoo-community.org/builds?repo=OCA/dms&target_branch=16.0 | ||
| :target: https://runboat.odoo-community.org/builds?repo=OCA/dms&target_branch=17.0 | ||
| :alt: Try me on Runboat | ||
|
|
||
| |badge1| |badge2| |badge3| |badge4| |badge5| | ||
|
|
||
| DMS is a module for creating, managing and viewing document files directly | ||
| within Odoo. | ||
| This module is only the basis for an entire ecosystem of apps that extend and | ||
| seamlessly integrate with the document management system. | ||
| DMS is a module for creating, managing and viewing document files | ||
| directly within Odoo. This module is only the basis for an entire | ||
| ecosystem of apps that extend and seamlessly integrate with the document | ||
| management system. | ||
|
|
||
| This module adds portal functionality for directories and files for allowed users, both portal or internal users. You can get as well a tokenized link from a directory or a file for sharing it with any anonymous user. | ||
| This module adds portal functionality for directories and files for | ||
| allowed users, both portal or internal users. You can get as well a | ||
| tokenized link from a directory or a file for sharing it with any | ||
| anonymous user. | ||
|
|
||
| **Table of contents** | ||
|
|
||
|
|
@@ -44,134 +47,185 @@ Installation | |
| ============ | ||
|
|
||
| Preview | ||
| ~~~~~~~ | ||
| ------- | ||
|
|
||
| ``mail_preview_base`` is required for DMS but it is recommended to install all | ||
| the other `mail_preview` modules from `social` OCA repository | ||
| in order to improve the preview of files. | ||
| ``python-magic`` library is recommended to be installed for having whole | ||
| support to get proper file types and file preview. | ||
|
|
||
| ``python-magic`` library is recommended to be installed for having whole support | ||
| to get proper file types and file preview. | ||
| Configuration | ||
| ============= | ||
|
|
||
| Configuration | ||
| ============= | ||
|
|
||
| To configure this module, you need to: | ||
|
|
||
| #. Go to *Documents -> Configuration -> Storages*. | ||
| #. Create a new document storage. You can choose between two options on `Save Type`: | ||
| * `Database`: Store the files on the database as a field | ||
| * `Attachment`: Store the files as attachments | ||
| #. Next create an administrative access group. Go to *Configuration -> Access Groups*. | ||
| * Create a new group, name it appropriately, and turn on all three permissions (Create, Write and Unlink - Read is implied and always enabled). | ||
| * Add any other top-level administrative users to the group if needed (your user should already be there). | ||
| * You can create other groups in here later for fine grained access control. | ||
| #. Afterwards go to *Documents -> Directories*. | ||
| #. Create a new directory, mark it as root and select the previously created setting. | ||
| * Select the *Groups* tab and add your administrative group created above. | ||
| #. On the Directory you can also add other access groups (created above) that will be able to: | ||
| * read | ||
| * create | ||
| * write | ||
| * delete | ||
| 1. Create a storage | ||
| ------------------- | ||
|
|
||
| 1. Go to *Documents -> Configuration -> Storages*. | ||
|
|
||
| Migration | ||
| ~~~~~~~~~ | ||
| 2. Create a new document storage. You can choose between three options | ||
| on ``Save Type``: | ||
|
|
||
| - ``Database``: Store the files on the database as a field | ||
| - ``Attachment``: Store the files as attachments | ||
| - ``File``: Store the files on the file system | ||
|
|
||
| 2. Create an access group | ||
| ------------------------- | ||
|
|
||
| 1. Next, create an administrative access group. Go to *Configuration -> | ||
| Access Groups*. | ||
|
|
||
| - Create a new group, name it appropriately, and turn on all three | ||
| permissions (Create, Write and Unlink. Read is implied and always | ||
| enabled). | ||
| - Add any other top-level administrative users to the group if | ||
| needed (your user should already be there). | ||
| - You can create other groups in here later for fine-grained access | ||
| control. | ||
|
|
||
| 3. Create a directory | ||
| --------------------- | ||
|
|
||
| If you need to modify the storage Save Type you might want to migrate the file data. | ||
| In order to achieve it you need to: | ||
| 1. Afterward, go to *Documents -> Directories*. | ||
|
|
||
| #. Go to *Documents -> Configuration -> Storage* and select the storage you want to modify | ||
| #. Modify the save type | ||
| #. Press the button `Migrate files` if you want to migrate all the files at once | ||
| #. Press the button `Manual File Migration` in order to specify files one by one | ||
| 2. Create a new directory, mark it as root and select the previously | ||
| created setting. | ||
|
|
||
| You can check all the files that still needs to be migrated from all storages | ||
| and migrate them manually on *Documents -> Configuration -> Migration* | ||
| - Select the *Groups* tab and add your administrative group created | ||
| above. If your directory was already created before the group, you | ||
| can also add it in the access groups (*Configuration -> Access | ||
| Groups*). | ||
|
|
||
| 3. In the directory settings, you can also add other access groups | ||
| (created above) that will be able to: | ||
|
|
||
| - read | ||
| - create | ||
| - write | ||
| - delete | ||
|
|
||
| Migration | ||
| ========= | ||
|
|
||
| If you need to modify the storage ``Save Type`` you might want to | ||
| migrate the file data. To achieve it, you need to: | ||
|
|
||
| 1. Go to *Documents -> Configuration -> Storage* and select the storage | ||
| you want to modify | ||
| 2. Modify the save type | ||
| 3. Press the button Migrate files if you want to migrate all the files | ||
| at once | ||
| 4. Press the button Manual File Migration to specify files one by one | ||
|
|
||
| You can check all the files that still need to be migrated from all | ||
| storages and migrate them manually on *Documents -> Configuration -> | ||
| Migration* | ||
|
|
||
| File Wizard Selection | ||
| ~~~~~~~~~~~~~~~~~~~~~ | ||
| ===================== | ||
|
|
||
| There is an action called `action_dms_file_wizard_selector` to open a wizard to list files in kanban view. | ||
| This can be used (example `dms_attachment_link` module) to add a button in kanban view with the action we need. | ||
| There is an action called ``action_dms_file_wizard_selector`` to open a | ||
| wizard to list files in kanban view. This can be used (example | ||
| dms_attachment_link module) to add a button in kanban view with the | ||
| action we need. | ||
|
|
||
| Usage | ||
| ===== | ||
|
|
||
| The best way to manage the documents is to switch to the Documents view. | ||
| Existing documents can be managed there and new documents can be created. | ||
| Existing documents can be managed there and new documents can be | ||
| created. | ||
|
|
||
| Portal functionality | ||
| ~~~~~~~~~~~~~~~~~~~~ | ||
| -------------------- | ||
|
|
||
| You can add any portal user to DMS access groups, and then allow that group in directories, so they will see in the portal such directories and their files. | ||
| Another possibility is to click on "Share" button inside a directory or a file for obtaining a tokenized link for single access to that resource, no matter if logged or not. | ||
| You can add any portal user to DMS access groups, and then allow that | ||
| group in directories, so they will see in the portal such directories | ||
| and their files. Another possibility is to click on "Share" button | ||
| inside a directory or a file for obtaining a tokenized link for single | ||
| access to that resource, no matter if logged or not. | ||
|
|
||
| Known issues / Roadmap | ||
| ====================== | ||
|
|
||
| - Files preview in portal | ||
| - Allow to download folder in portal and create zip file with all content | ||
| - Save in cache own_root directories and update in every create/write/unlink function | ||
| - Add a migration procedure for converting an storage to attachment one for populating existing records with attachments as folders | ||
| - Add a link from attachment view in chatter to linked documents | ||
| - If Inherit permissions from related record (the inherit_access_from_parent_record field from storage) is changed when directories already exist, inconsistencies may occur because groups defined in the directories and subdirectories will still exist, all groups in these directories should be removed before changing. | ||
| - Since portal users can read ``dms.storage`` records, if your module extends this model to another storage backend that needs using secrets, remember to forbid access to the secrets fields by other means. It would be nice to be able to remove that rule at some point. | ||
| - Searchpanel in files: Highlight items (shading) without records when filtering something (by name for example). | ||
| - Files preview in portal | ||
| - Allow to download folder in portal and create zip file with all | ||
| content | ||
| - Save in cache own_root directories and update in every | ||
| create/write/unlink function | ||
| - Add a migration procedure for converting an storage to attachment one | ||
| for populating existing records with attachments as folders | ||
| - Add a link from attachment view in chatter to linked documents | ||
| - If Inherit permissions from related record (the | ||
| inherit_access_from_parent_record field from storage) is changed when | ||
| directories already exist, inconsistencies may occur because groups | ||
| defined in the directories and subdirectories will still exist, all | ||
| groups in these directories should be removed before changing. | ||
| - Since portal users can read ``dms.storage`` records, if your module | ||
| extends this model to another storage backend that needs using | ||
| secrets, remember to forbid access to the secrets fields by other | ||
| means. It would be nice to be able to remove that rule at some point. | ||
| - Searchpanel in files: Highlight items (shading) without records when | ||
| filtering something (by name for example). | ||
|
|
||
| Bug Tracker | ||
| =========== | ||
|
|
||
| Bugs are tracked on `GitHub Issues <https://github.com/OCA/dms/issues>`_. | ||
| In case of trouble, please check there if your issue has already been reported. | ||
| If you spotted it first, help us to smash it by providing a detailed and welcomed | ||
| `feedback <https://github.com/OCA/dms/issues/new?body=module:%20dms%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. | ||
| `feedback <https://github.com/OCA/dms/issues/new?body=module:%20dms%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. | ||
|
|
||
| Do not contact contributors directly about support or help with technical issues. | ||
|
|
||
| Credits | ||
| ======= | ||
|
|
||
| Authors | ||
| ~~~~~~~ | ||
| ------- | ||
|
|
||
| * MuK IT | ||
| * Tecnativa | ||
|
|
||
| Contributors | ||
| ~~~~~~~~~~~~ | ||
| ------------ | ||
|
|
||
| * Mathias Markl <[email protected]> | ||
| * Enric Tobella <[email protected]> | ||
| * Antoni Romera | ||
| * Gelu Boros <[email protected]> | ||
| - Mathias Markl <[email protected]> | ||
| - Enric Tobella <[email protected]> | ||
| - Antoni Romera | ||
| - Gelu Boros <[email protected]> | ||
| - `Tecnativa <https://www.tecnativa.com>`__: | ||
|
|
||
| * `Tecnativa <https://www.tecnativa.com>`_: | ||
| - Víctor Martínez | ||
| - Pedro M. Baeza | ||
| - Jairo Llopis | ||
|
|
||
| * Víctor Martínez | ||
| * Pedro M. Baeza | ||
| * Jairo Llopis | ||
| - `Elego <https://www.elegosoft.com>`__: | ||
|
|
||
| * `Elego <https://www.elegosoft.com>`_: | ||
| - Yu Weng <[email protected]> | ||
| - Philip Witte <[email protected]> | ||
| - Khanh Bui <[email protected]> | ||
|
|
||
| * Yu Weng <[email protected]> | ||
| * Philip Witte <[email protected]> | ||
| * Khanh Bui <[email protected]> | ||
| - `Subteno <https://www.subteno.com>`__: | ||
|
|
||
| Other credits | ||
| ~~~~~~~~~~~~~ | ||
| - Timothée Vannier <[email protected]> | ||
|
|
||
| The migration of this module from 15.0 to 16.0 was financially supported by `AgentERP <https://www.agenterp.com>`_ | ||
| Other credits | ||
| ------------- | ||
|
|
||
| Some pictures are based on or inspired by: | ||
|
|
||
| * `Roundicons <https://www.flaticon.com/authors/roundicons>`_ | ||
| * `Smashicons <https://www.flaticon.com/authors/smashicons>`_ | ||
| - `Roundicons <https://www.flaticon.com/authors/roundicons>`__ | ||
| - `Smashicons <https://www.flaticon.com/authors/smashicons>`__ | ||
| - `EmojiOne <https://github.com/EmojiTwo/emojitwo>`__ : Portal DMS icon | ||
| - `GitHub Octicons <https://github.com/primer/octicons/>`__ : The main | ||
| DMS icon | ||
|
|
||
| Maintainers | ||
| ~~~~~~~~~~~ | ||
| ----------- | ||
|
|
||
| This module is maintained by the OCA. | ||
|
|
||
|
|
@@ -183,6 +237,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose | |
| mission is to support the collaborative development of Odoo features and | ||
| promote its widespread use. | ||
|
|
||
| This module is part of the `OCA/dms <https://github.com/OCA/dms/tree/16.0/dms>`_ project on GitHub. | ||
| This module is part of the `OCA/dms <https://github.com/OCA/dms/tree/17.0/dms>`_ project on GitHub. | ||
|
|
||
| You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.