Repository navigation
Update the README to match the code - #423
Merged
Merged
Conversation
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
|
TheWitness
approved these changes
Oct 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Description
README-only change (no code, no
INFOchange). Corrects statements that did not matchorigin/developand 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.31for CI (the workflow runs 8.2 to 8.4 against the1.2.xbranch), 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
INFOwas 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.INFO:29compat = 1.2.23; Plugin Management shows ">= 1.2.23"php -l"php -lon every non-test file underphp:8.0-cliandphp:8.1-cli: no errors. Runtime on 8.0/8.1 not run1.2.x, MariaDB 11.8.github/workflows/plugin-ci-workflow.yml:38,52ref: ${{ env.CACTI }}=1.2.xplugin_manage.php --plugin=syslog --install --enable --allperms: installed, 11 hooks, 6 realmssettingsrows stay (35 before and after)syslogandsyslog_removeddropped; alerts, removals, reports, hosts keptplugin_manage --uninstall$use_cacti_db = falseand a dedicated user: 28 tables created insyslogwhen the plugin is enabled; defaults inconfig.php.distare usercactiuser(README saidcacti)setup.php:73-78, six realmssyslog_alerts.php:729syslog_alerts.php:737,768Individual/Threshold; Filter Builder/SQL Expressionsyslog_removal.php:637information_schemaincludes/settings.php, defaults read from sourcesyslog_process.phpoptions--help:--debug,--force-report, worker options;--version; unknown option exits 1cli/syslog_schema.php--auditon a full install: "audit passed", exit 0;--helptext quotedcli_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 ondevelopCACTI_ROOT;tests/browser/README.mdunchangedFinding 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
Documentation only.
Checklist: