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

.. toctree::
   :hidden:

   installationguide/index
   userguide/index
   api
   web_ui_api
   faq
   contributing

Welcome to ZoneMinder's documentation. Please navigate to one of the links below.

If you are facing issues that are not covered in the documentation, please feel free to check the `ZoneMinder Forums <https://forums.zoneminder.com/viewforum.php?f=26>`__ or join the `ZoneMinder-Chat Slack channel <https://join.slack.com/t/zoneminder-chat/shared_invite/enQtNTU0NDkxMDM5NDQwLTdhZmQ5Y2M2NWQyN2JkYTBiN2ZkMzIzZGQ0MDliMTRmM2FjZWRlYzUwYTQ2MjMwMTVjMzQ1NjYxOTdmMjE2MTE>`__ if you prefer real time interaction.

: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:`web_ui_api`
  Information on interfacing to ZoneMinder's Web UI

: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 Notification Server and Machine Learning for Object/People/Face detection.



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

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

