diff --git a/Docs/Dev/en/structure.md b/Docs/Dev/en/structure.md deleted file mode 100755 index 0e7db89..0000000 --- a/Docs/Dev/en/structure.md +++ /dev/null @@ -1,5 +0,0 @@ -# Structure - -## ER - -![ER](Modules/Auditor/Docs/Dev/img/er.png) \ No newline at end of file diff --git a/Docs/Dev/img/er.png b/Docs/Dev/img/er.png deleted file mode 100644 index e22759c..0000000 Binary files a/Docs/Dev/img/er.png and /dev/null differ diff --git a/Docs/Help/en/SUMMARY.md b/Docs/Help/en/SUMMARY.md new file mode 100644 index 0000000..0adfff4 --- /dev/null +++ b/Docs/Help/en/SUMMARY.md @@ -0,0 +1,3 @@ +# User Content + +* [Audits]({%}&page=Help/audit) diff --git a/Docs/Help/en/audit.md b/Docs/Help/en/audit.md new file mode 100644 index 0000000..6b76b6d --- /dev/null +++ b/Docs/Help/en/audit.md @@ -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) \ No newline at end of file diff --git a/Docs/Help/en/introduction.md b/Docs/Help/en/introduction.md new file mode 100644 index 0000000..8dd693b --- /dev/null +++ b/Docs/Help/en/introduction.md @@ -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. \ No newline at end of file diff --git a/Docs/Help/img/audit.png b/Docs/Help/img/audit.png new file mode 100644 index 0000000..ec5ff4f Binary files /dev/null and b/Docs/Help/img/audit.png differ diff --git a/Docs/img.json b/Docs/img.json new file mode 100644 index 0000000..075dbc2 --- /dev/null +++ b/Docs/img.json @@ -0,0 +1,7 @@ +[ + [ + "/admin/audit/view?id=1", + "//*[@id=\"content\"]/div[2]/div/section", + "/Auditor/Docs/Help/img/audit.png" + ] +] \ No newline at end of file diff --git a/info.json b/info.json index ac347d0..4f2f7a0 100755 --- a/info.json +++ b/info.json @@ -12,7 +12,7 @@ }, "creator": { "name": "Jingga", - "website": "jingga.app" + "website": "https://jingga.app" }, "directory": "Auditor", "dependencies": {