Test fixes
Some checks failed
Image optimization / general_image_workflow (push) Has been cancelled
CI / general_module_workflow_php (push) Has been cancelled
CI / general_module_workflow_js (push) Has been cancelled

This commit is contained in:
Dennis Eichhorn 2024-05-16 02:14:54 +00:00
parent f69e74e525
commit 8e091eeab8
8 changed files with 69 additions and 6 deletions

View File

@ -1,5 +0,0 @@
# Structure
## ER
![ER](Modules/Auditor/Docs/Dev/img/er.png)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

3
Docs/Help/en/SUMMARY.md Normal file
View File

@ -0,0 +1,3 @@
# User Content
* [Audits]({%}&page=Help/audit)

47
Docs/Help/en/audit.md Normal file
View File

@ -0,0 +1,47 @@
# Audit
Audit logs contian the following information:
## Action
What kind of action is responsible for the creation of this audit log:
1. Create - data creation
2. Read - data was read (very rarely used)
3. Update - data updated
4. Delete - data deleted (includes soft deletes)
5. Unknown - unknown
## Type
Which data type is associated with the audit log. This number is only for internal purposes.
## Trigger
Trigger describing what caused the audit log.
## By
Who created the audit log. Internal actions are assigned to the admin account.
## Ref
Reference identifier to the data (e.g. news id, client id, address id, ...).
## Date
Date of the audit log creation.
## Module
Which module is responsible for creating the audit log.
## IP
Which IP address is responsible for creating the audit log. Internal audit logs are attributed to 127.0.0.1.
## Data
The audit log shows what kind of data change was performed. For `Create` statements no data is logged, since the data stored in the database itself already logs the current state of the data.
![General Settings](Modules/Auditor/Docs/Help/img/audit.png)

View File

@ -0,0 +1,11 @@
# Introduction
The **Auditor** module is one of the essential core modules that is always required. This module logs activities of all modules and users making it possible to track data changes.
## Target Group
The target group for this module is everyone, since every application must have this module. However mainly administrators should have access permissions to this module since the audit logs may contain confidential information.
# Setup
This module doesn't have any additional setup requirements. This module cannot be uninstalled if it is manually deleted from the hard drive please manually download the module from the page and put it into the `Modules/` directory.

BIN
Docs/Help/img/audit.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

7
Docs/img.json Normal file
View File

@ -0,0 +1,7 @@
[
[
"/admin/audit/view?id=1",
"//*[@id=\"content\"]/div[2]/div/section",
"/Auditor/Docs/Help/img/audit.png"
]
]

View File

@ -12,7 +12,7 @@
},
"creator": {
"name": "Jingga",
"website": "jingga.app"
"website": "https://jingga.app"
},
"directory": "Auditor",
"dependencies": {