Installation
============

There are two ways to use ML-powered object detection with ZoneMinder:

.. topic:: Path 1: Detection + optional push (no ES)

   Wire ``zm_detect.py`` directly to ZoneMinder using ``EventStartCommand``
   (requires ZM 1.38.1+). ZM calls the detection script automatically when
   an event starts. No daemon needed — simpler to set up. Can optionally
   send FCM push notifications directly (requires ZM 1.39.2+).
   See :doc:`install_path1` for setup instructions.

.. topic:: Path 2: Full Event Server

   Install and run the Event Notification Server alongside ZoneMinder. The ES
   detects new events via shared memory, invokes the ML hooks, and handles
   push notifications, WebSockets, MQTT, rules, and more.
   See :doc:`install_path2` for setup instructions.

.. include:: _feature_table.rst

If you only need detection results written to your ZM events (with optional push
notifications), Path 1 is simpler to set up.
If you need WebSocket notifications, MQTT, notification rules, or the ES control
interface, you need Path 2.

.. note::

   Both paths require ``pip3`` (and ``python3-venv`` on Debian/Ubuntu). Install
   with ``sudo apt install python3-pip python3-venv`` (Debian/Ubuntu),
   ``sudo dnf install python3-pip`` (Fedora/RHEL), ``sudo zypper install python3-pip``
   (openSUSE), or ``sudo pacman -S python-pip`` (Arch).

.. toctree::

   install_path1
   install_path2