Skip to content

[SKIP CI] fix: add file_read documentation to audit log docu #3503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
schweigisito wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −4
Open

[SKIP CI] fix: add file_read documentation to audit log docu #3503

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions services/audit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,24 @@
user 'user_id' trashed file 'item_id'
file_trash_delete)
user 'user_id' removed file 'item_id' from trashbin
file_read)
user 'user_id' read file 'item_id'
```

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"}
{"RemoteAddr":"","User":"user_id","URL":"","Method":"","UserAgent":"","Time":"","App":"admin_audit","Message":"user 'user_id' read file 'item_id'","Action":"file_read","CLI":false,"Level":1,"Path":"path","Owner":"user_id","FileID":"item_id"}

Check notice on line 21 in services/audit/README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

services/audit/README.md#L21 

Expected: 80; Actual: 241
```

The audit service is not started automatically when running as single binary started via `opencloud 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
- File system operations
(create/delete/move/read; including actions on the trash bin and versioning)
- User management operations
(creation/deletion of users)
- Sharing operations
- Sharing operations
(user/group sharing, sharing via link, changing permissions, calls to sharing API from clients)