From 943e9dfbbad319bc267ad27c297d685aada219b4 Mon Sep 17 00:00:00 2001 From: David Christofas Date: Wed, 30 Nov 2022 12:05:09 +0100 Subject: [PATCH] add a README to the audit package --- services/audit/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 services/audit/README.md diff --git a/services/audit/README.md b/services/audit/README.md new file mode 100644 index 0000000000..efdf1885e0 --- /dev/null +++ b/services/audit/README.md @@ -0,0 +1,11 @@ +# Audit service + +The audit service logs all events of the system into an audit log. To be able to prove compliance with corporate guidelines as well as to enable reporting and auditing of operations, the Auditing extension takes note of actions conducted by users and administrators. Per default it will be logged to standard out but can also be configured to a file output. Supported log formats are json or a simple key value ("key1=value1 key2=value2"). + +The service is not started automatically when running `ocis server` (single binary setup), it has to be started explicitly. + +Specifically, the application logs + +- file system operations (create/delete/move; including actions on the trash bin and versioning) +- user management operations (creation/deletion of users) +- sharing operations (user/group sharing, sharing via link, changing permissions, calls to sharing API from clients)