From 432b211353160ba42ee0507753b5cfc0805da098 Mon Sep 17 00:00:00 2001 From: sebalix Date: Tue, 9 Apr 2019 12:05:34 +0200 Subject: [PATCH] [UPD] README.rst --- auditlog/README.rst | 70 +++- auditlog/readme/CONTRIBUTORS.rst | 3 + auditlog/readme/CREDITS.rst | 1 + auditlog/readme/DESCRIPTION.rst | 2 + auditlog/readme/ROADMAP.rst | 2 + auditlog/readme/USAGE.rst | 21 ++ auditlog/static/description/index.html | 457 +++++++++++++++++++++++++ 7 files changed, 538 insertions(+), 18 deletions(-) create mode 100644 auditlog/readme/CONTRIBUTORS.rst create mode 100644 auditlog/readme/CREDITS.rst create mode 100644 auditlog/readme/DESCRIPTION.rst create mode 100644 auditlog/readme/ROADMAP.rst create mode 100644 auditlog/readme/USAGE.rst create mode 100644 auditlog/static/description/index.html diff --git a/auditlog/README.rst b/auditlog/README.rst index 2cc5c87c8..3fda82516 100644 --- a/auditlog/README.rst +++ b/auditlog/README.rst @@ -1,14 +1,38 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: https://www.gnu.org/licenses/agpl-3.0-standalone.html +========= +Audit Log +========= + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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 - -================================= -Audit Log - Track user operations -================================= +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/12.0/auditlog + :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-12-0/server-tools-12-0-auditlog + :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/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| This module allows the administrator to log user operations performed on data models such as ``create``, ``read``, ``write`` and ``delete``. +**Table of contents** + +.. contents:: + :local: + Usage ===== @@ -38,41 +62,51 @@ Known issues / Roadmap ====================== * log only operations triggered by some users (currently it logs all users) - + * log read operations does not work on all data models, need investigation 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 -`here `_. +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 +~~~~~~~ + +* ABF OSIELL + Contributors ------------- +~~~~~~~~~~~~ -* Sebastien Alix +* Sebastien Alix * Holger Brunn * Holden Rehg -Images ------- +Other credits +~~~~~~~~~~~~~ * Icon: built with different icons from the `Oxygen theme `_ (LGPL) -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. -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. -To contribute to this module, please visit https://odoo-community.org. +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/auditlog/readme/CONTRIBUTORS.rst b/auditlog/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..1567f0b2c --- /dev/null +++ b/auditlog/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* Sebastien Alix +* Holger Brunn +* Holden Rehg diff --git a/auditlog/readme/CREDITS.rst b/auditlog/readme/CREDITS.rst new file mode 100644 index 000000000..037907b61 --- /dev/null +++ b/auditlog/readme/CREDITS.rst @@ -0,0 +1 @@ +* Icon: built with different icons from the `Oxygen theme `_ (LGPL) diff --git a/auditlog/readme/DESCRIPTION.rst b/auditlog/readme/DESCRIPTION.rst new file mode 100644 index 000000000..97cd1bd9d --- /dev/null +++ b/auditlog/readme/DESCRIPTION.rst @@ -0,0 +1,2 @@ +This module allows the administrator to log user operations performed on data +models such as ``create``, ``read``, ``write`` and ``delete``. diff --git a/auditlog/readme/ROADMAP.rst b/auditlog/readme/ROADMAP.rst new file mode 100644 index 000000000..5a8b6def3 --- /dev/null +++ b/auditlog/readme/ROADMAP.rst @@ -0,0 +1,2 @@ + * log only operations triggered by some users (currently it logs all users) + * log read operations does not work on all data models, need investigation diff --git a/auditlog/readme/USAGE.rst b/auditlog/readme/USAGE.rst new file mode 100644 index 000000000..c13f508a4 --- /dev/null +++ b/auditlog/readme/USAGE.rst @@ -0,0 +1,21 @@ +Go to `Settings / Technical / Audit / Rules` to subscribe rules. A rule defines +which operations to log for a given data model. + +.. image:: /auditlog/static/description/rule.png + +Then, check logs in the `Settings / Technical / Audit / Logs` menu. You can +group them by user sessions, date, data model or HTTP requests: + +.. image:: /auditlog/static/description/logs.png + +Get the details: + +.. image:: /auditlog/static/description/log.png + +A scheduled action exists to delete logs older than 6 months (180 days) +automatically but is not enabled by default. +To activate it and/or change the delay, go to the +`Configuration / Technical / Automation / Scheduled Actions` menu and edit the +`Auto-vacuum audit logs` entry: + +.. image:: /auditlog/static/description/autovacuum.png diff --git a/auditlog/static/description/index.html b/auditlog/static/description/index.html new file mode 100644 index 000000000..533b49ad4 --- /dev/null +++ b/auditlog/static/description/index.html @@ -0,0 +1,457 @@ + + + + + + +Audit Log + + + +
+

Audit Log

+ + +

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

+

This module allows the administrator to log user operations performed on data +models such as create, read, write and delete.

+

Table of contents

+ +
+

Usage

+

Go to Settings / Technical / Audit / Rules to subscribe rules. A rule defines +which operations to log for a given data model.

+/auditlog/static/description/rule.png +

Then, check logs in the Settings / Technical / Audit / Logs menu. You can +group them by user sessions, date, data model or HTTP requests:

+/auditlog/static/description/logs.png +

Get the details:

+/auditlog/static/description/log.png +

A scheduled action exists to delete logs older than 6 months (180 days) +automatically but is not enabled by default. +To activate it and/or change the delay, go to the +Configuration / Technical / Automation / Scheduled Actions menu and edit the +Auto-vacuum audit logs entry:

+/auditlog/static/description/autovacuum.png +
+
+

Known issues / Roadmap

+
+
    +
  • log only operations triggered by some users (currently it logs all users)
    • +
  • log read operations does not work on all data models, need investigation
    • +
+
+
+
+

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

+
    +
  • ABF OSIELL
    • +
+
+
+

Contributors

+ +
+
+

Other credits

+
    +
  • Icon: built with different icons from the Oxygen theme (LGPL)
    • +
+
+
+

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.

+
+
+
+ +