Documentation for Cacti, Spine, RRDProxy and more
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
bin Fix up build process Oct 5, 2018
images Adding missing Data Input Method walkthrough and image files Oct 15, 2018
resources Fix up build process Oct 5, 2018
.gitignore Initial documentation html build script Oct 1, 2018
.mdl_style.rb Update markdownlint style with notes Aug 21, 2018
.mdlrc Turn off verbosity for markdownlint Aug 21, 2018
.travis.yml Move scripts into bin directory Oct 1, 2018
Command-Line-Scripts.md Shorten tables Sep 16, 2018
Contributing-Translations.md Add Translation instructions from repository wiki Oct 11, 2018
Contributing.md Add Translation instructions from repository wiki Oct 11, 2018
Data-Input-Methods.md Adding missing Data Input Method walkthrough and image files Oct 15, 2018
Data-Queries.md Oh dear, another missing table for the same file. Table 12-4 Sep 15, 2018
Debugging.md Fix up copyrights and add missing ones Sep 9, 2018
Frequently-Asked-Questions.md Fix up copyrights and add missing ones Sep 9, 2018
General-Installing-Instructions.md Fix up copyrights and add missing ones Sep 9, 2018
Graph-Overview.md Fix up copyrights and add missing ones Sep 9, 2018
Graph-a-Single-SNMP-OID.md Adding missing Table 10-1. Field Description: SNMP - Generic OID Temp… Sep 15, 2018
How-To-Data-Query-Templates.md Fenced code changes. Sep 26, 2018
How-To-Determine-Template-Version.md Making Mark happy (?) Sep 26, 2018
How-To-SSH-Tunnels.md Fenced code to INI Sep 26, 2018
How-to-Graph-Your-Network.md Be sane about bullet list indentions Sep 9, 2018
How-to-Graph-a-Custom-Collection-Script.md Fixup How To to a single file and fix current proceedure formatting Sep 9, 2018
Installing-Under-Windows.md Fix up copyrights and add missing ones Sep 9, 2018
PHP-Script-Server.md Fix up copyrights and add missing ones Sep 9, 2018
Plugin-Creating-Plugins.md Adding missing copyright to several files Oct 1, 2018
Plugin-Development.md Fix up copyrights and add missing ones Sep 9, 2018
Plugin-Guidelines.md Adding missing copyright to several files Oct 1, 2018
Plugin-Hook-API-Ref.md Adding missing copyright to several files Oct 1, 2018
Plugin-Reference.md Adding missing copyright to several files Oct 1, 2018
Principles-of-Operation.md Fix up copyrights and add missing ones Sep 9, 2018
README.md Add Translation instructions from repository wiki Oct 11, 2018
RRDTool-Specific-Features.md Adding missing tables 19-1 and 19-2 Sep 16, 2018
Requirements.md Adding various recommendations for PHP/MySQL/MariaDB Sep 17, 2018
Spine.md Adding missing Table 15-1 Sep 15, 2018
Standards-Code-Formatting.md Removing unnecessary scl command and adding Standards-Code-Formatting… Oct 1, 2018
Standards-Documentation.md Removing unnecessary scl command and adding Standards-Code-Formatting… Oct 1, 2018
Standards-FileSystem-Layout.md Adding missing copyright to several files Oct 1, 2018
Standards-PHP-Spec-Constructs.md Adding missing copyright to several files Oct 1, 2018
Standards-Patch-Creation.md Adding missing copyright to several files Oct 1, 2018
Standards-SQL.md Adding missing copyright to several files Oct 1, 2018
Standards-Security.md Adding missing copyright to several files Oct 1, 2018
Templates.md Adding missing Walkthrough's and images Oct 14, 2018
Upgrading-Cacti.md Fix up copyrights and add missing ones Sep 9, 2018
User-Management.md Remove helper ruler Sep 9, 2018
Variables.md Fix up copyrights and add missing ones Sep 9, 2018
Version-Specific-Release-Notes.md Fix up copyrights and add missing ones Sep 9, 2018
Viewing-Graphs.md Fix up copyrights and add missing ones Sep 9, 2018

README.md

Cacti (tm) Documentation

Cacti

Cacti is designed to be a complete graphing solution based on the RRDtool's framework. Its goal is to make a network administrator's job easier by taking care of all the necessary details necessary to create meaningful graphs.

Please see the official Cacti website for information, support, and updates.

Developers

  • Ian Berry (raX)

  • Larry Adams (TheWitness)

  • Tony Roman (rony)

  • J.P. Pasnak, CD (Linegod)

  • Jimmy Conner (cigamit)

  • Reinhard Scheck (gandalf)

  • Andreas Braun (browniebraun)

  • Mark Brugnoli-Vinten (netniV)

Thanks

A very special thanks to Tobi Oetiker, the creator of RRDtool and the very popular MRTG. The users of Cacti Especially anyone who has taken the time to create an issue report, or otherwise help fix a Cacti related problems. Also to anyone who has contributed to supporting Cacti.

Cacti is licensed under the GNU GPL:

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Table of Contents

  1. Installation

    This section contains information on how to install and/or upgrade the Cacti system. It covers requirements, different platforms and the steps needed to get your system working under normal circumstances.

  2. Standard Operations

    This section covers materials from viewing your graphs to templates and script server operations.

  3. Advanced Operations

    This section covers more advanced material such as using a custom script or the replacement variables that can be used within templates, etc.

  4. Plugins

    This section contains all Plugin related information. Guidelines, hooks, references, etc. More information can be found on the Cacti Forums.

  5. How To's

    This section contains how to's for several topics.

  6. Contributing

    This section contains information on how to contribute to Cacti.

  7. Development Standards

    This section contains the relevant information on how to ensure that any contribution is kept to the same standards that are applied for the Cacti Group. It should be noted that non-compliance does not mean automatically exclusion of proposed changes.

Installation

  1. Requirements

  2. General Installing Instructions

  3. Installing Under Windows

  4. Upgrading Cacti

Standard Operations

  1. Principles of Operation

  2. Graph Overview

  3. How to Graph Your Network

  4. Viewing Graphs

  5. Aggregate Overview

  6. User Management

  7. Graph a Single SNMP OID

  8. Data Input Methods

  9. Data Queries

  10. Templates

  11. PHP Script Server

  12. Spine

Advanced Operations

  1. How to Graph a Custom Collection Script

  2. Frequently Asked Questions

  3. Variables

  4. RRDTool Specific Features

  5. Command Line Scripts

  6. Debugging

  7. Version Specific Release Notes

  8. Plugin Development

Plugins

  1. Plugin Guidelines

  2. Creating Plugins

  3. References

  4. Hook API Reference

How Tos

  1. Determine template version

  2. Using SSH Tunnels

  3. Data Query Templates

Contributing

  1. Contributing

  2. Translations

Development Standards

  1. Documentation

  2. Code Formating

  3. PHP Specific Constructs

  4. File System Layout

  5. Patch Creation

  6. SQL Standards

  7. Security


Copyright (c) 2018 Cacti Group