ZoneMinder Documentation
========================

.. toctree::
   :hidden:

   installationguide/index
   userguide/index
   api
   faq
   contributing

Welcome to ZoneMinder's documentation, the following resources are available

:doc:`installationguide/index`
  Many distribution repos only hold older versions of ZoneMinder, current versions contain many bug fixes and updated functionality. Instructions here for installing updated packages or compiling from source.

:doc:`userguide/index`
  Guide to setting up ZoneMinder for the first time and detailed guides for using the ZoneMinder front end.

:doc:`api`
  Information on using the CakePHP based API for interfacing to ZoneMinder

:doc:`faq`
  Frequently Asked Questions

:doc:`contributing`
  How to contribute to ZoneMinder. As a community project we always need help, you don't need to be a coder to test or update documentation.

`Event Notification Server and Machine Learning hooks <https://zmeventnotification.readthedocs.io/en/latest/index.html>`__
        Documentation for the 3rd party Event Server and Machine Learning for Object/People/Face detection.



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`