diff --git a/auditlog/readme/CONFIGURE.rst b/auditlog/readme/CONFIGURE.rst new file mode 100644 index 000000000..b23252fa8 --- /dev/null +++ b/auditlog/readme/CONFIGURE.rst @@ -0,0 +1,18 @@ +Rules +~~~~~ + +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 + +Cleanup +~~~~~~~ + +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 diff --git a/auditlog/readme/ROADMAP.rst b/auditlog/readme/ROADMAP.rst index 5a8b6def3..a20cd6bfc 100644 --- a/auditlog/readme/ROADMAP.rst +++ b/auditlog/readme/ROADMAP.rst @@ -1,2 +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 +* Log only operations triggered by some users. Currently it logs all users. +* Logging read operations does not work on all data models. Need investigation. diff --git a/auditlog/readme/USAGE.rst b/auditlog/readme/USAGE.rst index c13f508a4..b92cc0882 100644 --- a/auditlog/readme/USAGE.rst +++ b/auditlog/readme/USAGE.rst @@ -1,21 +1,8 @@ -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 +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 +.. image:: ../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 +.. image:: ../static/description/log.png