18 Commits
Author SHA1 Message Date
Thomas Vincent 57b8088e13 docs: comprehensive validation audit, Spine poller overhaul, and technical refactor (#229)
* docs: comprehensive audit, Spine poller overhaul, and technical refactor

- Overhaul Spine documentation (Spine.md) with complete end-to-end guide: architecture, prerequisites for modern distros (EL8/9 CRB, Ubuntu 22/24, Debian 11/12, FreeBSD), SUID root permissions, secure spine.conf setup (0640), Web UI configuration (Paths, Poller type, Data Collectors tuning), MySQL max_connections sizing, and troubleshooting.
- Fix broken links and anchors (Hardening, SNMP data queries, Hook API references).
- Fix broken image reference in Sites.md (add-site.JPG -> add-site.png).
- Fix syntax errors in documentation PHP code blocks, including invalid parenthesization, missing SQL execute quotes, and malformed comments in FAQ.
- Fix DevOps installation commands: use config.php.dist, correct systemctl service names for MySQL/MariaDB/PHP-FPM, remove nonexistent php-json, add missing composer install, and correct Debian/Ubuntu systemd environment path.
- Correct grammatical errors, repeated words, and typos across all markdown documents.
- Remove obsolete unreferenced duplicate installation guides.

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

* docs: correct reviewed examples and guidance

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

* docs: correct guidance that disagrees with the Cacti source

Verified each claim against include/global_arrays.php, lib/auth.php,
lib/functions.php, host_templates.php and the Spine config parser. The
notable ones: api_plugin_safe_exec() does not exist on either branch,
Spine reads DB_Pass rather than DB_Password, and the CDEF special data
source table was missing five entries and renamed four others.

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

* docs: wrap Spine prose and fence the connection sizing formula

The formula's bare asterisks rendered as emphasis, dropping the multiplication signs.

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

* chore: refresh copyright year in scripts and issue templates

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

---------

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
2026-09-08 09:41:21 -04:00
Thomas Vincent c92faa6f53 docs: add Hardening-Cacti-Installation guide (#224)
* docs: add Hardening-Cacti-Installation guide

* docs: add Hardening-Cacti-Installation to Cacti Installation nav

* docs: cross-reference hardening guide from Standards-Security

* docs(hardening): correct harmful PHP/permission/AppArmor guidance

The disable_functions list blocked exec/shell_exec/proc_open/popen/system,
which the web tier uses for RRDtool, fping and spikekill, so graphs stopped
rendering; restrict it to passthru and pcntl_exec. The recursive chmod 755
left config.php DB credentials world-readable; lock it to 640 root:www-data.
Cite the real package-import advisory (GHSA-7cmj-g5qc-pj88, CVE-2024-25641),
add execute rules for helper binaries to the AppArmor profile, and stop
forcing the spine daemon into httpd_t.

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

* docs(hardening): fix .htaccess DirectoryMatch guidance and footer order

DirectoryMatch is invalid in .htaccess context; scope that example to
vhost config and add an .htaccess-compatible FilesMatch alternative.
Also move Standards-Security.md's See Also section above the copyright
footer instead of after it, and add the missing footer to the new
hardening guide.

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

---------

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
2026-08-16 22:28:40 +01:00
Thomas Vincent 21981b389c docs: fix SQL syntax error, stale version references, and prose errors (#222)
Refs #222

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
2026-03-11 22:52:23 +00:00
TheWitness ed4c330dd5 Updating Copyrights and 4 new sections (#206)
* Updating Copyrights and 4 new sections

* Syntax issue with Copyright

* Removing .travis.yml

* Fixing some case and path informaiton
2026-02-06 06:57:59 -05:00
TheWitness 660f054809 QA: Update Copyrights 2025-11-18 17:01:31 -05:00
TheWitness 08efd1fa30 QA: Updating Copyrights to 2024 2024-03-16 05:04:49 +05:30
Linegod b32a6092f1 last of the typos - I believe 2023-11-22 22:29:36 -06:00
5973e4ea3a Fix MD formatting issues on Multiple documents (#177)
Co-authored-by: Mark Brugnoli-Vinten <netniv@hotmail.com>
Co-authored-by: Sean Mancini <sean@seanmancini.com>
Co-authored-by: TheWitness <thewitness@cacti.net>
2023-07-23 22:35:57 +01:00
Mark Brugnoli-Vinten 80be2916f5 Update copyright year for 2023 2023-01-03 23:43:28 +00:00
Linegod cfa5bc4e7b documentation spelling 2022-06-20 20:41:36 -06:00
TheWitness 1af42fcc09 Updating Copyright Year 2022-02-06 17:24:31 -05:00
netniV 764b5e75fe Updating documentation to use <copy> tags 2021-05-09 11:50:12 +00:00
TheWitness cbfd0b4db0 Update Standards-Security.md 2021-01-01 20:16:46 -05:00
TheWitness b55e7ecd7d Update Standards-Security.md 2021-01-01 20:14:18 -05:00
netniV 2446ce2daf Update Copyright to 2020 2020-03-01 22:38:10 +00:00
netniV 4b9d7edf1c Update copyright notice 2019-03-14 13:44:33 +00:00
jpobeda 6423aad2ac Adding missing copyright to several files
Spelling mistakes/typos
Small addition to Standard-Documentation
Merged @cigamit DevelopmentStandards wiki page to Standards-Code-Formatting as Overview.
And whatever I forgot to mention :)
2018-10-01 10:00:28 +01:00
jpobeda d2a391e522 Adding missing files dev-standards_sql_standards.txt and dev-standards_secutiry.txt
https://docs.cacti.net/dev_standards:security#security
https://docs.cacti.net/dev_standards:sql_standards
2018-09-25 08:54:07 +01:00