From 0a503d0e3ed355fbeecbac9cad20ac06874c135f Mon Sep 17 00:00:00 2001 From: Thomas Vincent Date: Tue, 17 Nov 2026 20:32:20 -0800 Subject: [PATCH 1/3] docs: align README with source and published releases Signed-off-by: Thomas Vincent --- CHANGELOG.md | 3 +++ README.md | 20 ++++++++++++++++++-- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 25fe046..5b85869 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ # Changelog +Documentation update (unreleased): Refresh README release/source compatibility, +installation guidance and source-checked behavior. + --- develop --- * bug: Open the Syslog plugin's own database connection before the Syslog panels query it, so a Syslog database that is separate from Cacti's no longer fails with "Table 'cacti.syslog' doesn't exist"; the panels now skip cleanly when that connection cannot be opened diff --git a/README.md b/README.md index 66b0505..85c1d74 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # plugin_intropage -## Intropage/Dashboard plugin for Cacti - Intropage adds dashboards made of panels to Cacti. A panel shows one piece of information, for example the state of the devices, the poller statistics, an analysis of the Cacti log, the worst ping times or the last threshold events, @@ -9,6 +7,24 @@ or a graph that a user has added. The dashboards are shown on the console page or on a separate tab. A script that the Cacti poller starts after every polling cycle collects the data the panels show. +## Versions and compatibility + +This README describes the `develop` source branch. + +| Code | Plugin version | Minimum Cacti declared in `INFO` | +| --- | --- | --- | +| [Source branch](INFO) | 4.1.0 | 1.2.29 | +| [Published v4.0.4](https://github.com/Cacti/plugin_intropage/releases/tag/v4.0.4) | 4.0.4 | 1.2.17 | + +Use the published release’s assets and tagged documentation when installing that +package. Branch code can include later changes, even when its version number +matches the release. Cacti’s own PHP and database requirements also apply. + +Install this plugin in **`/plugins/intropage`**, using the directory +name `intropage` rather than `plugin_intropage`. + +See [CHANGELOG.md](CHANGELOG.md) for the version history. + ## Original Author All thanks goes to Petr Macek (petr.macek@kostax.cz) the original author of From 6517ca820df87ba7c390fdcdf4fbdd960e55b7f5 Mon Sep 17 00:00:00 2001 From: Thomas Vincent Date: Wed, 18 Nov 2026 01:10:53 -0800 Subject: [PATCH 2/3] docs: correct remaining claims against the plugin code Re-checked the documentation against INFO, setup.php, the settings arrays, registered realms and CLI usage text, and fixed the statements that did not match. Adds the realms, settings and command line tools the README did not mention. Signed-off-by: Thomas Vincent --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 85c1d74..888f27d 100644 --- a/README.md +++ b/README.md @@ -156,7 +156,7 @@ that is no longer installed are removed. - Check the file permissions (Linux/unix - readable for the web server) - Install and enable the plugin (Console > Configuration > Plugins). Installing - creates the tables, the two realms and the hooks; the plugin is not active + creates the tables, the three realms and the hooks; the plugin is not active until it is enabled. The same from the command line, in the Cacti directory: @@ -172,7 +172,7 @@ that is no longer installed are removed. Who has what after the installation: -- Only the Cacti admin user (user 1) gets the two realms listed below. Give the +- Only the Cacti admin user (user 1) gets the three realms listed below. Give the other users the "Intropage Viewer" realm under Plugin Permissions on the Permissions tab of the user or of a group (Console > Configuration > Users or User Groups). @@ -182,10 +182,12 @@ Who has what after the installation: Graphs". The system level panels have to be granted one by one. - Users that exist already see an empty dashboard until they are given panels. -The plugin adds two realms. "Intropage Viewer" opens the dashboard and is part +The plugin adds three realms. "Intropage Viewer" opens the dashboard and is part of the Normal User role. "Intropage Administration" is part of the System Administration role; it allows "Reload Panel Definitions" and changing the -update frequencies of the system panels. +update frequencies of the system panels. "Intropage Panel Library" guards the +Panel Library page (`intropage_panels.php`); it is not added to any role, so +grant it under Plugin Permissions where it is needed. More information about installation and upgrade of plugins: https://docs.cacti.net/Plugins.md From 3aa3eee25507f67cfcdaec60b678e012a8932644 Mon Sep 17 00:00:00 2001 From: Thomas Vincent Date: Wed, 18 Nov 2026 16:51:47 -0800 Subject: [PATCH 3/3] docs: use absolute links in README and CHANGELOG Plugin Management renders README.md and CHANGELOG.md from the release tag in a dialog, so relative links resolve against the Cacti server and return 404. Signed-off-by: Thomas Vincent --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 888f27d..70f1bef 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This README describes the `develop` source branch. | Code | Plugin version | Minimum Cacti declared in `INFO` | | --- | --- | --- | -| [Source branch](INFO) | 4.1.0 | 1.2.29 | +| [Source branch](https://github.com/Cacti/plugin_intropage/blob/develop/INFO) | 4.1.0 | 1.2.29 | | [Published v4.0.4](https://github.com/Cacti/plugin_intropage/releases/tag/v4.0.4) | 4.0.4 | 1.2.17 | Use the published release’s assets and tagged documentation when installing that @@ -23,7 +23,7 @@ matches the release. Cacti’s own PHP and database requirements also apply. Install this plugin in **`/plugins/intropage`**, using the directory name `intropage` rather than `plugin_intropage`. -See [CHANGELOG.md](CHANGELOG.md) for the version history. +See [CHANGELOG.md](https://github.com/Cacti/plugin_intropage/blob/develop/CHANGELOG.md) for the version history. ## Original Author