mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-01-10 06:10:05 -06:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Martin <github@diemattels.at>
This commit is contained in:
Edith Parzefall
2022-11-30 15:39:54 +01:00
committed by GitHub
parent 943e9dfbba
commit e554f7b4ee
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
services/audit/README.md
View File

@@ -1,11 +1,13 @@
# 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 audit service logs all events of the system as an audit log. 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 pair ("key1=value1 key2=value2").
The service is not started automatically when running `ocis server` (single binary setup), it has to be started explicitly.
With audit logs you are able to prove compliance with corporate guidelines as well as to enable reporting and auditing of operations. The audit service takes note of actions conducted by users and administrators.
Specifically, the application logs
The service is not started automatically when running as single binary started via `ocis server` or when running as docker container and must be started and stopped manually on demand.
- 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)
Specifically, the audit service 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)