zoneminder: A Perl repository from deltoss

Zoneminder Docker

(Current version: 1.34)

About

This is an easy to run dockerized image of ZoneMinder along with the the ZM Event Notification Server and its machine learning subsystem (which is disabled by default but can be enabled by a simple configuration).

The configuration settings that are needed for this implementation of Zoneminder are pre-applied and do not need to be changed on the first run of Zoneminder.

This verson will now upgrade from previous versions.

You can donate here.

Support

Go to the Zoneminder Forum here for support.

Installation

Install the docker by going to a command line and enter the command:

docker pull dlandon/zoneminder

This will pull the zoneminder docker image. Once it is installed you are ready to run the docker.

Before you run the image, feel free to read configuration section below to customize various settings

To run Zoneminder:

docker run -d --name="Zoneminder" \
--net="bridge" \
--privileged="true" \
-p 8443:443/tcp \
-p 9000:9000/tcp \
-e TZ="America/New_York" \
-e SHMEM="50%" \
-e PUID="99" \
-e PGID="100" \
-e INSTALL_HOOK="0" \
-e INSTALL_FACE="0" \
-e INSTALL_TINY_YOLO="0" \
-e INSTALL_YOLO="0" \
-e MULTI_PORT_START="0" \
-e MULTI_PORT_END="0" \
-v "/mnt/Zoneminder":"/config":rw \
-v "/mnt/Zoneminder/data":"/var/cache/zoneminder":rw \
dlandon/zoneminder

For http:// access use: -p 8080:80/tcp

Note: If you have opted to install face recognition, and/or have opted to download the yolo models, it takes time. Face recognition in particular can take several minutes (or more). Once the docker run command above completes, you may not be able to access ZoneMinder till all the downloads are done. To follow along the installation progress, do a docker logs -f Zoneminder to see the syslog for the container that was created above.

Subsequent runs

You can start/stop/restart the container anytime. You don't need to run the command above every time. If you have already created the container once (by the docker run command above), you can simply do a docker stop Zoneminder to stop it and a docker start Zoneminder to start it anytime (or do a docker restart Zoneminder)

Customization

Set INSTALL_HOOK="1" to install the hook processing packages and run setup.py to prepare the hook processing. The initial installation can take a long time.
Set INSTALL_FACE="1" to install face recognition packages. The initial installation can take a long time.
Set INSTALL_TINY_YOLO="1" to install the tiny yolo hook processing files.
Set INSTALL_YOLO="1" to install the yolo hook processing files.
Set MULTI_PORT_START and MULTI_PORT_END to define a port range for ES multi-port operation.
The command above use a host path of /mnt/Zoneminder to map the container config and cache directories. This is going to be persistent directory that will retain data across container/image stop/restart/deletes. ZM mysql/other config data/event files/etc are kept here. You can change this to any directory in your host path that you want to.

User Script

You can enable a custom user script that will run every time the container is started.

Put your script in the /mnt/Zoneminder/ folder and name it userscript.sh. The script will be executed each time the Docker is started before Zoneminder is started. Be sure to chmod +x userscript.sh so the script is executable.

Set ADVANCED_SCRIPT="1" environment variable to enable your script

Adding Nvidia GPU support to the Zoneminder.

You will have to install support for your graphics card. If you are using Unraid, install the Nvidia plugin and follow these instructions. On other systems install the Nvidia Docker, see here.

After you confirm the graphics card is seen by the Zoneminder docker, you can then compile opencv with GPU support. Be sure your Zoneminder docker can see the graphics card. Get into the docker command line and do this:

cd /config
./opencv.sh

This will compile the opencv with GPU support. It takes a LONG time. You should then have GPU support.

You will have to install the CuDNN runtime yourself based on your particular setup.

Post install configuration and caveats

After successful installation, please refer to the ZoneMinder, Event Server and Machine Learning configuration guides from the authors of these components to set it up to your needs. Specifically, if you are using the Event Server and the Machine learning hooks, you will need to customize /etc/zm/zmeventnotification.ini and /etc/zm/objectconfig.ini
Note that by default, this docker build runs ZM on port 443 inside the docker container and maps it to port 8443 for the outside world. Therefore, if you are configuring /etc/zm/objectconfig.ini or /etc/zm/zmeventnotification.ini remember to use https://localhost:443/<etc> as the base URL
Push notifications with images will not work unless you replace the self-signed certificates that are auto-generated. Feel free to use the excellent and free LetsEncrypt service if you'd like.

Usage

To access the Zoneminder gui, browse to: https://<your host ip>:8443/zm

The zmNinja Event Notification Server is accessed at port 9000. Security with a self signed certificate is enabled. You may have to install the certificate on iOS devices for the event notification to work properly.

deltoss/zoneminder