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

update readme

Browse Source
This commit is contained in:
mmattel
2022-11-30 16:24:57 +01:00
parent 35e5c6aeda
commit a0c06d733d
1 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
services/audit/README.md
View File

@@ -1,18 +1,30 @@
# Audit service
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 like:
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.
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.
Example key-value pairs:
```
file_delete)
user 'user_id' trashed file 'item_id'
file_trash_delete)
user 'user_id' removed file 'item_id' from trashbin
```
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.
Example json:
```
{"RemoteAddr":"","User":"user_id","URL":"","Method":"","UserAgent":"","Time":"","App":"admin_audit","Message":"user 'user_id' trashed file 'item_id'","Action":"file_delete","CLI":false,"Level":1,"Path":"path","Owner":"user_id","FileID":"item_id"}
{"RemoteAddr":"","User":"user_id","URL":"","Method":"","UserAgent":"","Time":"","App":"admin_audit","Message":"user 'user_id' removed file 'item_id' from trashbin","Action":"file_trash_delete","CLI":false,"Level":1,"Path":"path","Owner":"user_id","FileID":"item_id"}
```
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.
The autit 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.
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)
- 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)