Skip to content

Update the README to match the code - #423

Merged
TheWitness merged 1 commit into
developfrom
docs/readme-verified
Oct 24, 2026
Merged

TheWitness merged 1 commit into
developfrom
docs/readme-verified

Conversation

@somethingwithproof

Copy link
Copy Markdown
Member

Description

README-only change (no code, no INFO change). Corrects statements that did not match origin/develop and adds missing install, uninstall, realm, table, rule, settings, CLI and test-command information.

Related Issue

None.

Motivation and Context

The README named PHP 8.1 to 8.3 and release/1.2.31 for CI (the workflow runs 8.2 to 8.4 against the 1.2.x branch), referred to a "pinned" Cacti, described a 2.0 upgrade procedure, left a sentence about rsyslog unfinished, used "Host" and "Hide" where the UI says "Device" and "Transferal", and said nothing about uninstalling.

Version INFO was checked and is correct (compat = 1.2.23), so it is unchanged.

How Has This Been Tested?

Checked against origin/develop (7635b1a) on a throwaway Cacti 1.3.0-dev with MariaDB, plus PHP 8.0 and 8.1 containers for syntax.

Claim Result Evidence
Needs Cacti 1.2.23+ confirmed INFO:29 compat = 1.2.23; Plugin Management shows ">= 1.2.23"
PHP 8.0+ changed to "passes php -l" php -l on every non-test file under php:8.0-cli and php:8.1-cli: no errors. Runtime on 8.0/8.1 not run
CI matrix corrected to 8.2, 8.3, 8.4 and Cacti 1.2.x, MariaDB 11.8 .github/workflows/plugin-ci-workflow.yml:38,52
"pinned Cacti checkout" corrected workflow ref: ${{ env.CACTI }} = 1.2.x
Install, enable, allperms confirmed plugin_manage.php --plugin=syslog --install --enable --allperms: installed, 11 hooks, 6 realms
Disable / enable confirmed status 4 then 1; tables untouched
Uninstall, Remove Everything added UI uninstall: 28 tables to 0, hooks 0, realms 0; settings rows stay (35 before and after)
Uninstall, Syslog Data Only added syslog and syslog_removed dropped; alerts, removals, reports, hosts kept
Upgrade Advisor options added Truncate, Inline, Background each run on existing partitioned tables: all rows kept (messages, rules, hosts)
Reinstall over existing tables observed the advisor shows; data kept
CLI plugin_manage --uninstall not documented it renders the advisor HTML and does nothing from the CLI; uninstall through the UI
Separate syslog DB confirmed with correction $use_cacti_db = false and a dedicated user: 28 tables created in syslog when the plugin is enabled; defaults in config.php.dist are user cactiuser (README said cacti)
Realms added setup.php:73-78, six realms
Alert Level System/Device corrected ("Host" to "Device") syslog_alerts.php:729
Alert method / match type confirmed syslog_alerts.php:737,768 Individual/Threshold; Filter Builder/SQL Expression
Removal "Delete or Hide" corrected to Deletion/Transferal syslog_removal.php:637
Tables created added 28 tables, listed from information_schema
Settings names and defaults added includes/settings.php, defaults read from source
syslog_process.php options added --help: --debug, --force-report, worker options; --version; unknown option exits 1
cli/syslog_schema.php added --audit on a full install: "audit passed", exit 0; --help text quoted
Test commands confirmed cli_schema_upgrade_test.php, threshold_recovery_database_test.php (76 checks), quality_must_fix_database_test.php (40), incoming_preservation_database_test.php (44) all pass; Pest 503 passed on develop
Playwright / browser scripts not run need Chromium and CACTI_ROOT; tests/browser/README.md unchanged
rsyslog and syslog-ng configs not verified no rsyslog or syslog-ng available; text kept except the unfinished sentence left by the removed 2.0 note

Finding for a separate change: the uninstall dialog labels the first option "Remove Everything (Logs, Tables, Settings)", but the syslog_* settings remain. The README documents the actual behaviour.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Documentation only.

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation repository accordingly.

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
@sonarqubecloud

Copy link
Copy Markdown

@TheWitness
TheWitness merged commit 554e709 into develop Oct 24, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants