====== Shinken Official Documentation ======

  * [[::start|Getting started]]
  * Shinken official documentation [You are here]
  * [[::official:how to contribute] | How to contribute]]
  * [[::the_project_vision] | The project vision]]
  * [[::official:how to contribute#Shinken resources for users :] | Getting help!]]
  * [[::discussion | Global Discussion Page]]

<note tip>You are welcome to improve this wiki. Simply create an account, login and ask on the forum to get activated for edition. :)</note>


**Table of Contents**

  * [[:::official:part-about|About]]
    * [[:::official:about|About Shinken]]
    * [[:::official:about-whatsnew|What's different between Shinken and Nagios]]
  * [[:::official:part-gettingstarted|Getting Started]]
    * [[:::official:gettingstarted-beginners|Advice for Beginners]]
    * [[:::official:gettingstarted-quickstart|Quickstart Installation Guides]]
    * [[:::official:gettingstarted-quickstart-gnulinux|GNU/Linux Quickstart]]
    * [[:::official:gettingstarted-quickstart-windows|Windows Quickstart]]
    * [[:::official:ch07|Upgrading Shinken]]
    * [[:::official:gettingstarted-monitoring-windows|Monitoring Windows Machines]]
    * [[:::official:gettingstarted-monitoring-linux|Monitoring Linux/Unix Machines]]
    * [[:::official:gettingstarted-monitoring-printers|Monitoring Network Printers]]
    * [[:::official:gettingstarted-monitoring-routers|Monitoring Routers and Switches]]
    * [[:::official:gettingstarted-monitoring-publicservices|Monitoring Publicly Available Services]]
  * [[:::official:part-configuringshinken|Configuring Shinken]]
    * [[:::official:configuringshinken-config|Configuration Overview]]
    * [[:::official:configuringshinken-configmain|Main Configuration File Options]]
    * [[::the_broker_modules|Main Configuration File - Broker modules]].
    * [[:::official:configuringshinken-configobject|Object Configuration Overview]]
    * [[:::official:configuringshinken-objectdefinitions|Object Definitions]]
    * [[:::official:configuringshinken-customobjectvars|Custom Object Variables]]
   * [[:::official:part-runningshinken|Running Shinken]]
    * [[:::official:runningshinken-verifyconfig|Verifying Your Configuration]]
    * [[:::official:runningshinken-startstop|Starting and Stopping Shinken]]
  * [[:::official:part-thebasics|The Basics]]
    * [[:::official:thebasics-plugins|Nagios/Shinken Plugins]]
    * [[:::official:thebasics-macros|Understanding Macros and How They Work]]
    * [[:::official:thebasics-macrolist|Standard Macros in Shinken]]
    * [[:::official:thebasics-hostchecks|Host Checks]]
    * [[:::official:thebasics-servicechecks|Service Checks]]
    * [[:::official:thebasics-activechecks|Active Checks]]
    * [[:::official:thebasics-passivechecks|Passive Checks]]
    * [[:::official:thebasics-statetypes|State Types]]
    * [[:::official:thebasics-timeperiods|Time Periods]]
    * [[:::official:thebasics-networkreachability|Determining Status and Reachability of Network Hosts]]
    * [[:::official:thebasics-notifications|Notifications]]
  * [[:::official:part-advancedtopics|Advanced Topics]]
    * [[:::official:advancedtopics-extcommands|External Commands]]
    * [[:::official:advancedtopics-eventhandlers|Event Handlers]]
    * [[:::official:advancedtopics-volatileservices|Volatile Services]]
    * [[:::official:advancedtopics-freshness|Service and Host Freshness Checks]]
    * [[:::official:advancedtopics-distributed|Distributed Monitoring]]
    * [[:::official:advancedtopics-redundancy|Redundant and Failover Network Monitoring]]
    * [[:::official:advancedtopics-flapping|Detection and Handling of State Flapping]]
    * [[:::official:advancedtopics-escalations|Notification Escalations]]
    * [[:::official:advancedtopics-oncallrotation|On-Call Rotations]]
    * [[:::official:advancedtopics-clusters|Monitoring Service and Host Clusters]]
    * [[:::official:advancedtopics-dependencies|Host and Service Dependencies]]
    * [[:::official:advancedtopics-stalking|State Stalking]]
    * [[:::official:advancedtopics-perfdata|Performance Data]]
    * [[:::official:advancedtopics-downtime|Scheduled Downtime]]
    * [[:::official:advancedtopics-adaptative|Adaptive Monitoring]]
    * [[:::official:advancedtopics-dependencychecks|Predictive Dependency Checks]]
    * [[:::official:advancedtopics-cachedchecks|Cached Checks]]
    * [[:::official:advancedtopics-passivestatetranslation|Passive Host State Translation]]
    * [[:::official:advancedtopics-checkscheduling|Service and Host Check Scheduling]]
    * [[:::official:advancedtopics-objectinheritance|Object Inheritance]]
    * [[:::official:advancedtopics-objecttricks|Time-Saving Tricks For Object Definitions]]
    * [[:::official:part-problemsandimpacts | Problems and impacts correlation management]]
    * [[:::official:advancedtopics-businessrules | Business rules]]
    * [[:::official:advancedtopics-migratingfromnagios | Migrating from Nagios to Shinken]]
  * [[:::official:part-securityandperformancetuning|Security and Performance Tuning]]
    * [[:::official:securityandperformancetuning-security|Security Considerations]]
    * [[:::official:securityandperformancetuning-tuning|Tuning Shinken For Maximum Performance]]
    * [[:::official:securityandperformancetuning-largeinstalltweaks|Scaling a Shinken Installation]]
    * [[:::official:securityandperformancetuning-statistics|Performance statistics ]]
  * [[:::official:part-integrationwithothersoftware|Integration With Other Software]]
    * [[:::official:integrationwithothersoftware-integration|Integration Overview]]
    * [[:::official:integrationwithothersoftware-int-snmptrap|SNMP Trap Integration]]
    * [[:::official:integrationwithothersoftware-int-tcpwrappers|TCP Wrappers Integration]]
  * [[:::official:part-shinkenaddons| Extending Shinken]]
    * [[:::official:shinkenaddons-addons| Extending Shinken]]
  * [[:::official:part-development|Development]]
    * [[:::official:development-pluginapi|Nagios/Shinken Plugin API]]
    * [[:::official:development-modules|Developing Shinken daemon modules]]
    * [[:::official:development-hackingcode|Hacking the Shinken Code]]

|  |  | [[:::official:part-about|Next]] |
|  |  | Part I. About |

=== Authors ===
  * Ethan Galstad (Nagios Enterprises): first versions, 1999->2007
  * Sébastien Guilbaud: HTML to Docbook transformation 
  * Olivier Jan: HTML to Docbook transformation 
  * Jean Gabès: DocBook to xhtml, xhtml to dokuwiki, adaptation to Shinken
  * xkilian: Rewrite, reorganize, update and cleanup the documentation



=== Copyrights ====

__Shinken is not related with the official Nagios project nor Nagios Enterprise.__ 

Nagios, the Nagios logo, and Nagios graphics are the servicemarks, trademarks, or registered trademarks owned by Nagios Enterprises. All other servicemarks and trademarks are the property of their respective owner.·

Shinken is provided “AS IS” with “NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.”

Copyright © 1999-2007 Ethan Galstad, Nagios Enterprises
Copyright © 2007-2009 Sébastien Guilbaud and Olivier Jan
Copyright © 2009->now Jean Gabès and the Shinken community