From f79ec19bfa9bc1a86988554041bc3702f7373d1b Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Tue, 28 May 2019 13:58:44 +0000 Subject: [PATCH] [UPD] README.rst --- base_directory_file_download/README.rst | 68 ++- .../static/description/index.html | 444 ++++++++++++++++++ 2 files changed, 488 insertions(+), 24 deletions(-) create mode 100644 base_directory_file_download/static/description/index.html diff --git a/base_directory_file_download/README.rst b/base_directory_file_download/README.rst index bcf1941c8..23290292d 100644 --- a/base_directory_file_download/README.rst +++ b/base_directory_file_download/README.rst @@ -1,11 +1,30 @@ -.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png - :target: https://www.gnu.org/licenses/agpl - :alt: License: AGPL-3 - ======================== Directory Files Download ======================== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/10.0/base_directory_file_download + :alt: OCA/server-tools +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-tools-10-0/server-tools-10-0-base_directory_file_download + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/149/10.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + View and download the files contained in a directory on the server. This functionality can have impacts on the security of your system, @@ -15,6 +34,10 @@ Be careful when choosing the directory! Notice that, for security reasons, files like symbolic links and up-level references are ignored. +**Table of contents** + +.. contents:: + :local: Configuration ============= @@ -23,7 +46,6 @@ To configure this module, you need to: #. Set the group "Download files of directory" for the users who need this functionality. - Usage ===== @@ -35,44 +57,42 @@ To use this module, you need to: #. Download the file you need #. In case the content of the directory is modified, refresh the list by clicking the button on the top-right of the form - -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/149/10.0 - - Bug Tracker =========== -Bugs are tracked on `GitHub Issues -`_. In case of trouble, please -check there if your issue has already been reported. If you spotted it first, -help us smash it by providing detailed and welcomed feedback. +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* Onestein Contributors ------------- +~~~~~~~~~~~~ * Andrea Stirpe -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/server-tools `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/base_directory_file_download/static/description/index.html b/base_directory_file_download/static/description/index.html new file mode 100644 index 000000000..f0d68ce5a --- /dev/null +++ b/base_directory_file_download/static/description/index.html @@ -0,0 +1,444 @@ + + + + + + +Directory Files Download + + + +
+

Directory Files Download

+ + +

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runbot

+

View and download the files contained in a directory on the server.

+

This functionality can have impacts on the security of your system, +since it allows to download the content of a directory. +Be careful when choosing the directory!

+

Notice that, for security reasons, files like symbolic links +and up-level references are ignored.

+

Table of contents

+ +
+

Configuration

+

To configure this module, you need to:

+
    +
  1. Set the group “Download files of directory” for the users who need this functionality.
    2. +
+
+
+

Usage

+

To use this module, you need to:

+
    +
  1. Go to Settings -> Downloads -> Directory Content
    2. +
  2. Create a record specifying Name and Directory of the server
    3. +
  3. Save; a list of files contained in the selected directory is displayed
    4. +
  4. Download the file you need
    5. +
  5. In case the content of the directory is modified, refresh the list by clicking the button on the top-right of the form
    6. +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Onestein
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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/server-tools project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +