mirror of
https://github.com/Cacti/documentation.git
synced 2026-10-26 04:57:17 +09:00
Thomas Vincent
cb29d10426
* docs: update stale PHP/MySQL/MariaDB version requirements - Requirements.md: PHP 5.4 -> 8.1 (matches 1.2.31+ requirement note) - Requirements.md: MySQL 5.6 -> 5.7, MariaDB 5.5 -> 10.2 (current minimums) - Requirements.md: MySQL section header updated to >= 5.7 / 10.2 - Requirements.md, Install-Under-CentOS_LAMP.md, Install-Under-CentOS_LEMP.md, Installing-Under-Windows.md: comment out innodb_file_format and innodb_large_prefix (removed in MySQL 8.0 / MariaDB 10.3+) Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * docs: upgrade http:// links to https:// and fix dead wiki URLs - Upgrade http:// to https:// in 8 files: General-Installing-Instructions.md, Graph-Templates.md, How-To-SSH-Tunnels.md, Plugin-Development.md, Standards-Code-Formatting.md, Templates.md, Upgrading-Cacti-Under-Windows.md - Replace two dead docs.cacti.net wiki links: How-To-SSH-Tunnels.md: old wiki SNMP guide -> Net-SNMP man page Plugin-Syslog.md: dead plugin:syslog.config -> plugin_syslog repo Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * docs: fix technically inaccurate MySQL configuration recommendations - innodb_additional_mem_pool_size: removed in MySQL 5.7.4 / MariaDB 10.0; replaced with removal notice in Requirements.md and comments in Install-Under-CentOS_LAMP.md and Install-Under-CentOS_LEMP.md - max_heap_table_size: clarify ">= 5" means ">= 5% of system RAM" - innodb_buffer_pool_size: clarify ">= 25" means ">= 25% of system RAM" Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * docs: add missing required PHP extensions to Requirements.md Add dom, mysqlnd, pcntl, Phar, and sqlite3 — all declared as required in composer.json but absent from the module list. pcntl is Linux-only (process control for the poller). Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * docs: fix 36 spelling errors across 19 documentation files Corrections detected by codespell: - somone->someone, Walkthough->Walkthrough, GUAGE->GAUGE - asociate->associate, messege->message, therefor->therefore - get's->gets, Proxys->Proxies, paralelisation->parallelization - parms->params (6 instances in script data query examples) - finialise->finalise, buildin->built-in, everytime->every time - Unistall->Uninstall, resiliant->resilient, build-in->built-in - requriments->requirements (2 instances), explanitory->explanatory (3 instances) - fro->for, invole->involve, reulting->resulting - stauts->status, tge->the Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * ci: add codespell spelling check workflow for documentation Adds GitHub Actions workflow that runs codespell==2.4.1 on all Markdown files on every push/PR to main. Also adds .codespell.cfg to skip binary and generated files (JSON, shell scripts, HTML, images). Update .gitignore to allow .github directory (was blocked by .git* glob). Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * docs: improve voice, consistency, and note formatting across 10 files - Convert passive/impersonal constructions to active voice - Standardize NOTE -> Note in blockquotes for consistency - Reformat inline IMPORTANT/Note callouts as blockquotes - Fix awkward phrasing in LXC container notes - Consolidate fragmented note bullets into single blockquote Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * docs: fix technical accuracy and correct typos across 10 files - Requirements.md: clarify Composer is for source/develop installs only; RRDtool minimum updated to 1.5+ (1.8+ for 1.3.x); php-snmp section rewritten to describe selective fallback behavior; SELinux/AppArmor advice reworded to recommend policy exceptions over blanket disable - Spine.md: fix PHP Script Server range (10 -> 15); fix 'senstivive' and 'Davices' typos - Trees.md: fix broken table rows split across lines; 'Sporting' -> 'Sorting' - Data-Sources.md: restructure storage table to standard 3-column layout; fix '19b' unit typo -> '19kb' - How-To-SNMP-Custom-Script.md: convert bold/backtick commands to proper fenced code blocks; fix 'intex' and 'BNSMPD' typos - Plugins.md: fix 'onfiguration' typo; fix YouTube thumbnail http -> https; fix 'Tuturial' typo - Standards-Security.md: fix 'invalidate' -> 'invalid' - template_apache_config.md: fix 'apcache2' -> 'apache2' - device-template-specific-proxmox.md: replace service file edit with drop-in approach; remove ProtectSystem=off/ProtectHome=off; add note on minimal required systemd overrides - resource/xml/query_interface_traffic.php: http -> https URL Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * docs: rename CentOS install guides to Enterprise Linux; fix grammar, logic, and security flaws - Rename Install-Under-CentOS_LAMP.md → Install-Under-Enterprise-Linux-LAMP.md - Rename Install-Under-CentOS_LEMP.md → Install-Under-Enterprise-Linux-LEMP.md - Update README.md ToC links to match new filenames and correct labels LAMP fixes: - Title updated to reflect RHEL/Rocky Linux/AlmaLinux coverage - Fix step numbering: "2.Install" / "3.Enable" missing space after number - Spine build deps: restructure for EL7/EL8/EL9+ separately; EL8 was missing package install after repo enable; EL9+ uses 'crb' not 'powertools' - SELinux URL: fix quadruple-slash typo; switch to English wiki URL LEMP fixes: - Title: "CentOS 7" → "Enterprise Linux (RHEL / Rocky Linux / AlmaLinux)" - TLS: remove TLSv1 and TLSv1.1 (RFC 8996 prohibited, fails OpenSSL 3.x); set ssl_protocols TLSv1.2 TLSv1.3 - Ciphers: remove DH+3DES (Sweet32 / CVE-2016-2183) - HTTP redirect: uncomment return 301 (comment claiming nginx lacks support for 'return' has been wrong since nginx 0.8 / 2009) - PHP location block: fix 'alias' → 'root' (alias breaks $document_root in fastcgi_param SCRIPT_FILENAME); add missing semicolon after index directive - Cron: poller path was /var/www/html/cacti but install target throughout this guide is /usr/share/nginx/html/cacti — align them - DB: split GRANT...IDENTIFIED BY into CREATE USER + GRANT (IDENTIFIED BY on GRANT removed in MySQL 8.0 / MariaDB 10.5.2) - Fix comment typo: "Compression increases performance0" → remove trailing 0 - SELinux URL: fix quadruple-slash typo README.md: - Update section 3.1 and 3.2 links to new filenames - Correct labels from "CentOS 7" to "Enterprise Linux" - Fix "Reports Admistrative Interface" → "Administrative" - Fix "requriments" (×2) → "requirements" * docs: remove Install-Under-CentOS_LAMP.md (superseded by Install-Under-Enterprise-Linux-LAMP.md) * docs: remove Install-Under-CentOS_LEMP.md (superseded by Install-Under-Enterprise-Linux-LEMP.md) * docs: update README ToC links and fix typos - Update 3.1 and 3.2 links from CentOS to Enterprise Linux filenames - Correct labels: "CentOS 7" → "Enterprise Linux (RHEL/Rocky/AlmaLinux)" - Fix "Reports Admistrative" → "Reports Administrative" - Fix "requriments" (×2) → "requirements" * docs: fix grammar, logic, and technical errors in remaining install/upgrade guides Installing-Under-Windows.md: - Replace php_mysql.dll with php_pdo_mysql.dll (php_mysql removed in PHP 7.0) - Remove IIS ISAPI steps referencing php8isapi.dll (ISAPI dropped in PHP 8.0); replace with FastCGI instructions via php-cgi.exe - Remove NO_AUTO_CREATE_USER from sql_mode (removed MySQL 8.0, breaks startup) - sort_buffer_size = 200M → 32M with caveat (per-session; 200M causes OOM under load) - Fix step numbering gaps: main list 5→8, IIS 3→5, Finishing 5→8 - "you will have to user 8.3 notation" → "use" - "c:cygwin" → "c:\cygwin" (missing backslash) - "it's subfolders" → "its subfolders" - "A anm example" → "An example" - "verify/udate" → "verify/update" Installing-Under-Ubuntu-Debian.md: - Cron user: apache → www-data (apache user does not exist on Ubuntu/Debian) - CREATE DATABASE: use utf8mb4 directly; remove redundant ALTER DATABASE - php8.1-mbstring listed twice in apt-get install; deduplicated - "may received" → "may receive" - Note php8.1 is EOL; recommend checking current supported release Upgrading-Cacti-Under-Windows.md: - Fix all steps numbered 1. → proper sequential numbering (1–10) - Remove hardcoded MySQL 5.7 path; use generic %MYSQL_HOME% note Upgrading-Cacti-Under-FreeBSD.md: - mysqldump: remove contradictory -l / --lock-tables=false flags; replace with --single-transaction (correct for InnoDB, no locking) How-To-SSH-Tunnels.md: - Add prominent note: SSH -L is TCP-only; standard SNMP uses UDP; this guide requires TCP transport configured on snmpd and does not work for most network devices - Fix unclosed code fence after ssh-keygen output block - Replace rc.local persistence with systemd unit (rc.local is deprecated and disabled by default on systemd distros: Ubuntu 16.04+, Debian 9+) - ssh-keygen: recommend ed25519 over RSA * docs: correct PHP 8.1 EOL date, Net-SNMP link, and grammar PHP 8.1 security support ended 31 December 2025, not November 2024. Point the snmpd.conf link at www.net-snmp.org (the sourceforge.io mirror is bot-blocked). Fix 'There a two ways extending' to 'There are two ways to extend'. Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * ci: fix spelling workflow trigger to target develop, not main The repo's default branch is develop; main hasn't moved since 2023. The workflow's push/pull_request filters targeted main, so it never ran on any PR opened against develop. Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> --------- Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
123 lines
3.8 KiB
Markdown
123 lines
3.8 KiB
Markdown
# Plugin Management
|
|
|
|
Installing or updating plugins on cacti is a simple procedure.
|
|
For most of the plugins a few basic steps are enough, which are described below.
|
|
Each plugin directory should contain a README.md file. We recommend to study
|
|
this file. It may contain important installation information.
|
|
|
|
## Installing Plugins
|
|
|
|
|
|
|
|
|
|
1. Download the plugin to cactidir/cacti/plugins
|
|
|
|
```console
|
|
git clone https://github.com/Cacti/plugin_thold.git
|
|
```
|
|
|
|
```console
|
|
mv plugin_thold /var/www/html/cacti/plugins
|
|
```
|
|
|
|
2. Now assign the proper permissions to the folder
|
|
|
|
```console
|
|
chown -R apache:apache plugin_thold
|
|
```
|
|
|
|
3. From `Console > Configuration > Plugins` Install the plugin by Clicking on
|
|
the wrench Icon as showng below.
|
|
|
|
Below you will now see the THOLD plugin available to install in this case we
|
|
are installing thold
|
|
|
|
|
|
|
|
4. After installing the plugin by clicking on the grey gear you will now how to
|
|
enable it this can be done via clicking on the green check mark
|
|
|
|
|
|
|
|
After this, the **Plugin** is installed and enabled. However, there will likely
|
|
be configuration that must take place after the **Plugin** is enabled. See the
|
|
**Plugin** documentation for instructions on how to configure and use them.
|
|
|
|
## Updating a Plugin
|
|
|
|
Updating a plugin not only keeps you up to date with the latest release of the
|
|
code for that plugin. It also allows you to keep all of your settings for that
|
|
plugin ensure you DO NOT UNINSTALL the plugin. You must instead disable the
|
|
plugin which will not drop the SQL tables and thus save your settings.
|
|
|
|
1. Disable the **Plugin** you want to update
|
|
|
|
2. Backup the current **Plugin** folder typically in
|
|
`<path_cacti>/plugins/plugin_name`
|
|
|
|
```console
|
|
cp -R /var/www/html/cacti/plugin/thold /tmp
|
|
```
|
|
|
|
3. git pull or download the new version of the **Plugin**
|
|
|
|
```console
|
|
git pull
|
|
```
|
|
|
|
4. Change name of **Plugin** folder i.e plugin_thold to thold
|
|
|
|
```console
|
|
mv plugin_thold thold
|
|
```
|
|
|
|
5. Assign proper permissions usually either www-data for Ubuntu/debian or apache
|
|
for CentOS/RHEL
|
|
|
|
```console
|
|
chown -R apache:apache thold
|
|
```
|
|
|
|
6. Re-enable the **Plugin** in the **Console**
|
|
|
|
### Video Walkthrough
|
|
|
|
[](https://youtu.be/TPKu-2XYKok)
|
|
|
|
## Uninstall a Plugin
|
|
|
|
To uninstall a plugin go into the plugins page
|
|
`Console > Configuration > Plugins` Click on the plugin to Disable the plugin.
|
|
|
|
Click on the red dot beside the plugin to uninstall the plugin a dialogue box
|
|
will appear now click uninstall.
|
|
|
|
|
|
|
|
This will uninstall the plugin from cacti but will NOT remove the files from the
|
|
server to do that you must manually remove the plugin until you remove the files
|
|
the plugin will show to be available to be installed.
|
|
|
|
> **WARNING**: Uninstalling a Cacti **Plugin** generally also removes any
|
|
> database tables that that **Plugin** created, which means your data! Before
|
|
> uninstalling **Plugins**, it would be wise to have a backup strategy in place
|
|
> in case you accidentally uninstall a **Plugin** and loose your data!
|
|
|
|
### Dependencies in plugins
|
|
|
|
Some dependencies such as THOLD aka Thresholds rely on another plugin in this
|
|
case thold reliese on the monitor plugin which is missing in this case you will
|
|
see the below message box in order to continue you must install the required
|
|
plugin.
|
|
|
|
|
|
|
|
### Delete plugin data and settings
|
|
Some plugins have new functionality and allow you to delete data and plugin
|
|
settings and start from scratcg. This can be done with the trash can icon in
|
|
Console > Configuration > Plugins
|
|
|
|
---
|
|
|
|
Copyright (c) 2004-2026 The Cacti Group
|