Dummies Guide

This is a short guide for using ZM. It's concise, and tells you what you need to know.

If you wish to view the full ZM Documentation, I recommend viewing it through the PDF view, as the sphinx website is not efficient and requires javascript. PDF View: https://readthedocs.org/projects/zoneminder/downloads/pdf/stable/ If you want a hard copy, you can order the documentation through a self publishing service like lulu.com

Zoneminder is a powerful tool, but it has a learning curve. The forums are there to answer questions. Search then post if its not already answered.

Install

Use the install guides provided by Bbunge on the wiki: Zoneminder Wiki: Contents These are the best supported install guides.

Ubuntu or Debian / Devuan 1.34 is recommended.

Even numbers (1.34) are stable. Use those. Odd numbers are testing/development (1.35).

Here's a guide for using an external HDD: Using a dedicated Hard Drive

For ZM < 1.29 Make sure you add innodb_file_per_table=1 and ensure that the ZM database is InnoDB format, otherwise you may run into the issues described in MySQL. This is not necessary in 1.30.4 and later.

Test out a Camera

Once you get ZM installed, you will want to test out a camera. You can do a webcam, or you can do an IP camera. See the Hardware_Compatibility_List

I recommend you start with an old Axis IP Camera. They are well documented and easy to setup. Buy an old one for $10-20. Follow the instructions on either the Zoneminder Hardware compatiblity list, on ispyconnect's url list, or in the user manual for the camera. Any respectable camera will document it's RTSP and MJPEG / JPG paths for you to access. ONVIF is also an option to find the path for RTSP cameras. This is covered in more detail in Finding Camera Stream Paths.

Follow the instructions in the Hardware Compatiblity List for parameters for setting up a camera the first time. If you have an error, look at the logs. FFMPEG and VLC can be used to test that the streams are valid. e.g. ffmpeg -i rtsp://username:password@<ipaddress>:554/path output.mp4 This is faster than using ZM.

In ZM, IP address, path, port, and Resolution must be correct. Most other fields can be left at defaults in the source section.

If you can view the MJPEG or JPG url in your browser, you will be in good shape. Take that path, and put it into Zoneminder. If the camera requires authorization, consult the user manual, or you can try adding the username and password before the ip like so username:password@ipaddress e.g. root:mypass@192.168.1.5 This is an alternative to 192.168.1.5?username=root&pwd=mypass which most guides tell you to do. Both will work, however the latter can vary in what keywords it uses (pwd vs pass vs password) while the former requires no keywords.

If pass is blank, you type in root:@192.168.1.5

RTSP always specifies the port. e.g. rtsp://user:password@192.168.1.10:554/somepath

Obtaining more Cameras

In ZoneMinder, when you add a camera, you have a few options:

• LOCAL Camera connected directly to computer (webcam, or analog camera thorugh bttv card)(typically /dev/video0)

• REMOTE Grab MJPEG stream from IP camera on the network.

• FILE Grab a jpg file somewhere locally and display that (you provide jpeg images that change from somewhere). Can be used in unusual ways (i.e. a slide show, <insert use here>).

• FFMPEG and LIBVLC use the respective libraries to pull a stream similar to REMOTE does for RTSP only. Anything RTSP should use FFMPEG.

Local is for webcams (usb), or BTTV (pci) cards for analog aka coax cameras. Webcams are ok. BTTV is obsolete, but usable as legacy hardware. If you have analog cameras, you are best off using a video encoder. See the Hardware_Compatibility_List

After that you have FILE and REMOTE. I have not used FILE for anything but testing. I will cover REMOTE / FFMPEG.

REMOTE & FFMPEG have the option of either RTSP (h264) or MJPEG streams.

MJPEG

These include Arecont Vision, Axis, Bosch, Foscam, Grandstream, Instar, Messoa, Zavio and others. The prices scale with features. Old indoor Axis cameras at 480p-720p resolution (no IR) can be found online easily for $10-80.

Also see, Hardware_Compatibility_List#Single_Board_Computers SBC cameras.

RTSP

These cameras use h264 (or h265) compression. They serve it on an RTSP server. h264 uses compression, so you end up using less HDD space than compared with MJPEG. H264 is recommended when possible.

Note: Users with 1.32+ can use H264 passthrough, which writes the h264 direct to mp4, and saves some CPU usage. 1.36 has further efficiency improvements on this.

How Powerful of a Computer to Use

High-end server hardware will perform better than desktop, or low end server hardware. I have seen this firsthand between two servers: KFSN4-DRE and the KGPE-D16. The latter runs ZM with 25+ cameras, not breaking a sweat. The former reaches a limit at about 10. Another limitation is HDD size.

I currently recommend buying Axis (new is expensive, so you'll probably purchase used), although many do not have IR. This is not a problem, as outdoors IR on cameras attracts spider webs, and external IR is recommended. Another recommended brand is Hikvision. Hikvision can be bought new for a lower price if warranty is an issue (for business clients that can't afford Axis). The cameras work well with ZM, and are configurable without Windows, Otherwise, any respectable name brand camera will work. Look through the hardware compatibility list. Read the user manual before you purchase the camera, and look for the following: Outdoors/indoors, IR/no-IR, Resolution. IR can be supplemented with external appliances.

A note on Analog Cameras

If you are upgrading an existing camera installation, you will likely have coaxial cables for the old cameras. These can be used with Zoneminder in either LOCAL, or REMOTE/FFMPEG. LOCAL, via a PCI or PCI-Express card, REMOTE/FFMPEG through a video encoder that takes the analog stream and converts to either MJPG or RTSP. I recommend the latter.

There is no reason to rip out, or ignore old coaxial cables. They are perfectly viable for Zoneminder. They may be a step behind the IP cameras, however they can be used.

I have not worked with HD analog (a new type of analog camera that does HD over the coax), and I don't recommend it. It is not standardized yet. Ethernet only for new cameras.

Watching the Cameras

Cameras can be watched from the ZM apache server. Montage view is good. See notes section for a hint about > 6 camera setups.

Another way is to make an html file on a remote machine with the following code embedded in an img tag. Adjust monitor ID as needed. How to stream from another ZoneMinder installation. Also an easy way to embed video in a website (img tag). See Dedicated SBC Camera Monitor for notes on refreshing the stream periodically. [[1]]

Streaming in ZM, does not slow it down, in my experience.

If you embed the URL in an img tag, include http prefix or it wont work.

img width="500px" height="500px" src="http://zmserveripaddress/zm/cgi-bin/nph-zms?mode=jpeg&monitor=#&scale=100&maxfps=5&user=username&pass=password"

Call it locally:

firefox file:///home/username/file.html

When you have > 6 cameras, you can either use firefox and edit about:config (explained below in guide), or see https://forums.zoneminder.com/viewtopic.php?t=28168&p=113934#p113934 for instructions regarding multi port.

Watch the scale parameter. That can be adjusted for clients with low power CPUs (ARM SBCs).

Quick Example

Example Camera View HTML

Embedding Streaming Video in External Website from Forums

Recording in Zoneminder

The zmc binary handles recording.

You can record everything (good, but no way to find events). You can modect everything (light HDD use, but misses stuff). You can mocord everything (best, but uses HDD). And finally, You can mix it up. I would recommend in small setups, to throw a >1TB HDD in there for videos and set everything to mocord. For larger setups, you will want to customize each camera based on its priority.

In ZM 1.32 and newer, you can use multiple HDs, and assign cameras to where they should be saved. These are storage areas

Some cameras have two streams. Run Mocord on the low res stream, and record or modect w/linked monitors - search forums for more details. Which you choose will depend whether you want to record all of the this camera or not. How much HDD space do you have?

Motion Detection

The zma binary handles analysis.

What's all this motion detection stuff, anyhow?

The strength of zoneminder lies in its motion detection analysis (thus the 'zone' in zoneminder, being the motion detection zones). See: Understanding Zoneminder's Zoning system for Dummies This is the ZMA binary.

Start with the most sensitive settings, and make them less sensitive until no false alarms are recorded. Night IR detects more false events than daylight. Monitoring for all alarms can easily be done by $ tail -f /var/log/syslog in Devuan based distros.

Or you can record everything, if modect isn't working. Mocord will combine both modect and record, having everything recorded, but making a graph where motion occurs (in show timeline https://wiki.zoneminder.com/How_to_view_recorded_history_from_show_timeline. Mocord is the best, but uses more HDD. Beware of running into issues with PurgeWhenFull not able to keep up.

I personally like using hardware motion detectors, as ZMA/zmeventnotification and all the associated software to detect people can be a rabbit hole. But, these come at a cost - more initial setup and wiring. I have an arduino sketch here: https://forums.zoneminder.com/viewtopic.php?f=9&t=27442

Why motion detection?

Using modect or mocord is recommended here. Because you are able to click from the main zm index - events - show timeline, and from there quickly review your modect events. Because you save HDD space. And SMS Notifications and ZMTrigger can be setup off of modect alarms (the latter requiring either modect, mocord, or nodect).

Any downsides?

Zones must be tuned to be sensitive enough to see all events, but not so sensitive as to detect false alarms. This requires work, and is not guaranteed to work 100% even after tweaking. POTENTIAL RABBIT HOLE WARNING...

Help, I missed an event!? After using this setup for some years, a sudden rise in the cost of some goods a business kept in storage led to thefts. The bad news was, my modect zone wasn't sensitive enough. This, with the added ability of ZM>1.32's storage areas led me to re-evaulate the above. It turns out, there is another way. Instead of Modect on a zone, you can Record (or mocord). And, instead of motion detecting on the live video, you can do analysis on old videos. With a combination of these two posts (note: untested, for the record) https://forums.zoneminder.com/viewtopic.php?f=11&t=24686 and https://forums.zoneminder.com/viewtopic.php?f=8&t=28013&p=109190 You can re-create videos from your (JPEG ONLY) footage, and then reanalyze them. (those with ffmpeg mp4s created, may need to combine the footage into one video).

This gives the CPU reductions of not actively Modect/Mocord, while still not missing anything. A dedicated ZM computer (RPI) can be used to analyze old footage. EDIT: This is a lot of work, and I don't recommend it.

tl;dr: Use mocord.

4K Cameras Mocord on the low res stream, and record on the high res stream. Do NOT use any analysis (zma) on the high res stream. Analysis is where the CPU is eaten up. If you want, you can use the 'linked monitors' function, and only record the 4K on motion (search forums).

Conclusion

After all is said and done, motion detection works but has limitations. Motion detection tends to report false alarms from weather, wildlife, changing from IR to Day sensor, and others. For users that need accurate motion detection, you will either need to A) tune the zones so that no false alarms occur (see Understanding Zoneminder's Zoning system for Dummies) or B) use the cameras built in motion detection or C) use external motion sensors with ZMTrigger or some combination of the above.

Sizing Zones

My first thought is the threshold is too low. It happened to me when I 
first started with ZM. I figured out a little trick:

Draw a new zone a little smaller than you appear in the video. The zone 
will tell you the number of pixels or the percent of the whole frame. 
Compare that to the size you have setup to detect. If you are using 
percent try changing to pixels, that will not require the math to adjust 
the percent.

ref: http://forums.zoneminder.com/viewtopic.php?f=40&t=30570

Tips

• Zones should be as small as possible, and you should use as few zones per monitor, to lower CPU usage.
• Analysis FPS can be limited to 1-2 FPS to lower CPU usage. IMPORTANT (do not limit Max FPS, only analysis).
• If you see events with 1 or 2 alarm frames occurring, you can make a background filter to delete these or tune the zones.
• Aggressive Modect usage can run into issues with PurgeWhenFull, beware.
• Transitions from daylight to IR cause false alarms. The solution is to "Set a max alarmed area so it doesn't alarm if the whole area is changing".
• I prefer the usage of external hardware motion sensors via ZMTrigger over modect, when high reliability / low false alarms is required.
• JPEG saving, should be avoided on H264 streams when possible. Use H264 passthrough. Consider how decoding the H264 stream to JPEG uses CPU, while passthrough will avoid this conversion step.
• If you have more than 6 cameras you may want to setup multi-port as an alternative to firefox about:config edits. See: https://medium.com/zmninja/multi-port-storage-areas-and-more-d5836a336c93 Note: article written by zm dev. See also Multi_Port

Hardware Advice

When setting up the cameras, here is some advice.

• Use fuses on the PSU output to the cameras, if using passive POE adaptors.
• Use barrel plug splitters, and use one 12V PSU. (i.e. a barrel plug that is a 1 to 5 splitter). Cameras in my experience use around 200-400mA of current at 12V (400mA is when IR LEDs are on).
• If you purchase axis cameras, be aware that the cameras are 5V and the barrel plug is 4.0mm x 1.7mm. It's easiest to use POE on these.
• Installing areas where the temperature is high may cause early camera failure (especially for cheaper cameras). Even something as simple as a corner of an enclosed room where the sun shines all day may be enough heat.

Troubleshooting

• Watch logs.

• Use forum search.

• Use web search.

• Enable component logs and navigate to /var/log/zm/.

• # tail -F /var/log/syslog

• Beware of underlying hardware faults such as bad RAM.

• Disable logs after you are done.

Notes

• Some cams will have two video streams (e.g. Hikvision, Amcrest). The resolutions/video type may or may not be the same. For example, there may be a low resolution mjpeg stream, and a high resolution RTSP stream. Read the data sheet / user manual for cameras you intend to purchase. Multiple streams is desirable.

• I found it helpful to include monitor ID in camera names, as you run into monitor ID in logs often.

• Proprietary cameras are known to report to outside IPs. Don't give them internet access. Only the server should be wan-accessible. Make a separate network.

• Many cameras have default telnet passwords, in addition to the default web access passwords. Change these or keep cameras away from the wan. Cameras are common botnet targets.

• With server motherboard hardware, you will be able to have more cameras (servers are more powerful, and better servers will have better performance).

• I use ext4 filesystem for the HDDs. I had tried using ext2 filesystem for better performance, but the fsck time is prohibatively slow for ext2 (>24 hours for >2TB). Ext4 seems to work well. Older ext2, or ext3 fs can be upgraded to ext4.

• When viewing the cameras in Firefox, once you get more than 6 cameras from ZM on the browser Firefox will not display the seventh. This is due to a limit of Firefox and can be adjusted in about:config. See: ZM Forums: Problems when two people are watching live Network.http.max-persistent-connections-per-server. This max persistent connections per server must be > 6 in order to see > 6 camera streams.

• Adding "< /dev/null" to the ffmpeg path used by ZM might fix some issues. See ZM Forums: Truncated Video Export

• If you are going to use a BT878 based card, you can add a heatsink onto the top of all *878 chips. This has been mentioned in the forums in various spots, Use a ruler, and measure the dimensions in mm, then purchase one on digikey. A heatsink attached to the plastic of the IC, instead of the actual IC die is not ideal, but it will help. EDIT: I'm not sure if this is necessary, in hindsight. Also consider a video encoder instead of a BT878 card (e.g. search auction sites for 1 or 2 or 4 channel video encoder).

• Edit /etc/default/rcS (applies to devuan/trisquel) and make sure auto FSCK is enabled. Failure to set this, will require manual intervention when the server is repairing the filesystem, requiring you to press a key.

• Make sure the BIOS is set to power on after power fails.

• Set colourspace to 32-bit for a possible performance boost.

• Don't set a Max FPS limit on REMOTE or FFMPEG, or VLC cameras in Zoneminder. The FPS should only to be set at the IP camera itself. Max FPS limiting is for LOCAL cameras, only.

• With larger camera setups (one 10, one >20 cameras) I needed to change the watchdog timer (/usr/bin/zmwatch.pl) from the default of 10 seconds to 30 or 60 seconds in order to avoid periodic drop outs of individual cameras. The cameras would drop, and not return, unless i restarted zoneminder or disabled and enabled that camera. This setting is managed in options - system. If you see dropouts after that, review /usr/bin/zmwatch.pl and insert additional logging. You can also add a hack to the API so that if cameras drop out they are restarted. See documentation of ZM API. For my setups, they typically drop out once a day on specific cameras. Other cameras will never drop out. EDIT: This was because I had poorly supported cameras. Don't buy off brand cameras, or this might happen to you.

• Do NOT point cameras at bright light, such as facing a window, a garage door, or anything that generates glare. It will blur the image / potentially damage the sensor.

• Buy a set of adaptors such as these: to use with your normal 5.5 2.1mm barrel plug. Search multi type 23 or 28 dc power adapter.

• I made a script to watch cameras that drop out, and disable/reenable them for my 1.29 setup. See here. This also doubles as a notification in case the cameras somehow are powered off. You'll get emails telling you cameras are down. EDIT: See note about poorly supported cameras above. With good cameras, this does not occur.

See Also

• API

• Cron example

• Dedicated SBC Camera Monitor Guides for using a Beaglebone Black or Desktop as a client to watch the ZM Server.

• Docker

• Example Camera View HTML A quick html file you can deploy on clients to watch the server.

• Exporting Videos Hack (not recommended)

• Filters Examples

• Finding Camera Stream Paths

• ffmpeg Example usage, and notes.

• https://wiki.zoneminder.com/How_to_view_recorded_history_from_show_timeline

• MJPEG_vs_H264 For ZM < 1.31, use MJPEG for large deployments

• Multi_Port For streaming more than 6 cameras at once to a browser.

• MySQL can require some optimizing, and there are potential gotchas. Though newer releases of Zoneminder may have resolved some of the issues.

• OpenVPN tips

• PurgeWhenFull requires configuration on larger systems, or systems where events are created at a pace faster than PurgeWhenFull can keep up. Failure to do so, will result in all events being blank, and you will have to fix it.

• SMS Notifications or email.

• Zmodopipe Is a tool that can tie an analog DVR system to Zoneminder, although it is far from perfect. I have documented it there, and recommend purchasing a (some #) channel video encoder instead.

• ZMNinja - General usage, also Geoblocking w/apache.

• ZMTrigger is a tool that can be used to take outside information and overlay it onto the camera display. For example, you might take the temperature, or wind speed, and overlay it on a camera. It can also be used as external motion detection. Experience with electronics and microcontrollers such as AVRs, Pics, and the Arduino IDE are applicable here.

Other Users

• How to share an USB camera from a remote ZM server to another ZM Server

• General Notes

• https://forums.zoneminder.com/viewtopic.php?f=32&t=23815&hilit=i+run+this+script+every+night Backup DB script (Recommended)

• https://wiki.zoneminder.com/Ubuntu_Install_ZoneMinder_on_Ubuntu_Server Apache Hardening

• https://github.com/lbdc/zm_movie_bootstrap Create timelapse videos (adjust fps) or just export. Terminal or GUI. Good example of a basic ZM hack interfacing with db, and querying video files.