Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,30 @@
# 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,
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](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
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 **`<cacti-root>/plugins/intropage`**, using the directory
name `intropage` rather than `plugin_intropage`.

See [CHANGELOG.md](https://github.com/Cacti/plugin_intropage/blob/develop/CHANGELOG.md) for the version history.

## Original Author

All thanks goes to Petr Macek (petr.macek@kostax.cz) the original author of
Expand Down Expand Up @@ -140,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:
Expand All @@ -156,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).
Expand All @@ -166,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
Expand Down
Loading