Cacti (home)ForumsDocumentation

Install Plugins

Plugins are made to be easy to install, upgrade and remove.

Before you can begin to install a plugin, you will need to install the Cacti Plugin Architecture. But once that is done, its all fairly simple.

The first step to is to download∞ the plugin of your choice. You can choose either the zip or gzip compressed archive. You will then need to extract this archive to a temporary location. When you extract the archive it should, depending on your archive software, create a directory with several files inside of it. We will use the Monitor Plugin∞ as an example.

Download

Begin by downloading the Monitor plugin. After the download is complete, the filename should look something like this.

monitor-0.3.zip

or

monitor-0.3.tar.gz

Extract

You will need to extract this archive. On Windows there are several ways to extract zips/gzips, just use the program of your choice (ex: Winzip). Using Unix you can extract it using a command similar to this one, but your milage may vary depending on the Distribution you are running.

tar -xvzf monitor-0.3.tar.gz

If all goes well, you should have a folder called monitor with a few files and possibly a few folders in it. To be sure that you are looking at the correct directory, check and make sure that you have a file called “setup.php” directly inside of your monitor folder. On Windows if you happen to end up with a parent folder called monitor-0.3 with a subfolder called monitor then you will need to ignore the parent folder and just use the subfolder.

It is extremely important that you do not alter the case or the name of this folder or the plugin will not function at all.

Upload

Once you are satisfied that you are working with the correct directory, then you will need to upload this file into your Cacti install's Plugin directory. This will vary greatly depending on where you actually installed Cacti. For example, on Linux, if your Cacti files are in a directory like this.

/var/www/html/cacti/

then your Plugin Directory would be here

/var/www/html/cacti/plugins/

On Windows using IIS, it could be located here

C:\inetpub\wwwroot\cacti\plugins\

You will need to upload/copy the complete “monitor” folder into this “plugins” folder on your web server. So that you have a structure kinda like this

/var/www/html/cacti/plugins/monitor/

or

C:\inetpub\wwwroot\cacti\plugins\monitor\

That takes care of the difficult part of the installation (download, uncompress, upload). Now we will just turn the newly installed plugin on.

Activate

Go to Console/Utilities/User Management and enable the 'Plugin Management' realm for your admin user, then go to Console/Configuration/Plugin Management and click the 'Enable Plugin' icon

Install Plugin

Then click the 'Enable Plugin' icon

Enable Plugin

Since PIA 2.8 with Cacti 0.8.7g, you no longer need to edit your include/config.php

Simply ensure that your config.php has been updated to PIA 2.8, and you can add plugins via the Plugin Management page

There is no longer a requirement to add 2.x compliant plugins to the plugin array

Configuration

A few plugins will require their own little tweaks or configuration changes to complete the installation of the Plugin. These are outside the scope of this document, as you will need to consult the individual documentation of the Plugin. But if you are stuck and can not locate the specific configuration options for a Plugin, you might try looking at the Settings link in the Console to see if any new options were added.

Removal

To remove a plugin, go to Console/Configuration/Plugin Management

First, click on the 'Disable Plugin' icon.

Next, click the 'Uninstall Plugin' icon.

Finally, remove the specific plugin directory from the 'plugins' directory






Personal Tools