From 7cfed1e19f2e340d966ed2068176d21a0e8e9834 Mon Sep 17 00:00:00 2001
From: stephanchrst <stephanchrst@gmail.com>
Date: Mon, 6 Feb 2023 15:29:55 +0700
Subject: add audit log

---
 auditlog/readme/CONTRIBUTORS.rst | 10 ++++++++++
 auditlog/readme/CREDITS.rst      |  1 +
 auditlog/readme/DESCRIPTION.rst  |  2 ++
 auditlog/readme/ROADMAP.rst      |  2 ++
 auditlog/readme/USAGE.rst        | 25 +++++++++++++++++++++++++
 5 files changed, 40 insertions(+)
 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

(limited to 'auditlog/readme')

diff --git a/auditlog/readme/CONTRIBUTORS.rst b/auditlog/readme/CONTRIBUTORS.rst
new file mode 100644
index 0000000..6616b77
--- /dev/null
+++ b/auditlog/readme/CONTRIBUTORS.rst
@@ -0,0 +1,10 @@
+* Sebastien Alix <sebastien.alix@camptocamp.com>
+* Holger Brunn <hbrunn@therp.nl>
+* Holden Rehg <holdenrehg@gmail.com>
+* Eric Lembregts <eric@lembregts.eu>
+* Pieter Paulussen <pieter.paulussen@me.com>
+* Alan Ramos <alan.ramos@jarsa.com.mx>
+* Stefan Rijnhart <stefan@opener.amsterdam>
+* Bhavesh Odedra <bodedra@opensourceintegrators.com>
+* Hardik Suthar <hsuthar@opensourceintegrators.com>
+* Kitti U. <kittiu@ecosoft.co.th>
diff --git a/auditlog/readme/CREDITS.rst b/auditlog/readme/CREDITS.rst
new file mode 100644
index 0000000..037907b
--- /dev/null
+++ b/auditlog/readme/CREDITS.rst
@@ -0,0 +1 @@
+* Icon: built with different icons from the `Oxygen theme <https://en.wikipedia.org/wiki/Oxygen_Project>`_ (LGPL)
diff --git a/auditlog/readme/DESCRIPTION.rst b/auditlog/readme/DESCRIPTION.rst
new file mode 100644
index 0000000..97cd1bd
--- /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 0000000..5a8b6de
--- /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 0000000..b09f7d9
--- /dev/null
+++ b/auditlog/readme/USAGE.rst
@@ -0,0 +1,25 @@
+Go to `Settings / Technical / Audit / Rules` to subscribe rules. A rule defines
+which operations to log for a given data model.
+
+.. image:: ../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:: ../static/description/logs.png
+
+Get the details:
+
+.. image:: ../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:: ../static/description/autovacuum.png
+
+In case you're having trouble with the amount of records to delete per run,
+you can pass the amount of records to delete for one model per run as the second
+parameter, the default is to delete all records in one go.
-- 
cgit v1.2.3