ZoneMinder is a free, open source Closed-circuit television software application developed for Linux which supports IP, USB and Analog cameras.
PHP Perl C++ C JavaScript CSS Other
Latest commit 0e64ff9 Jan 16, 2017 @connortechnology connortechnology committed on GitHub Merge pull request #1754 from pliablepixels/1716-doc-img-typo
1716 doc img typo
Permalink
Failed to load latest commit information.
.github Initial commit of github issue template. Dec 31, 2016
cmake Merge pull request #896 from knnniggett/pod2man Jul 3, 2015
db Add MonitorPreset for Qihan IP cameras via RTSP Jan 10, 2017
distros rpm specfile - el6 buildrequires epel-rpm-macros Jan 15, 2017
doc-pak Migrate svn to git Mar 16, 2013
docs added uncompressed xml Jan 16, 2017
misc Rremove Index from options to prevent directory listings Nov 8, 2016
onvif update gpl 2 mailing address Dec 26, 2016
scripts Merge pull request #1719 from knnniggett/hikvisionptz Jan 3, 2017
src packpack - change error code handling Jan 16, 2017
umutils Migrate svn to git Mar 16, 2013
utils packpack - change error code handling Jan 16, 2017
web fix conditional logic in controlcap.js Jan 10, 2017
.dockerignore Improve Docker build; reduce image size & layer count Jun 2, 2016
.gitignore add comment at top, suggesting how to keep sorting maintained Nov 17, 2016
.gitmodules Use the 3.0 branch of crud, compatible with cakephp 2.x Sep 29, 2015
.travis.yml use Travis builtin mysql service Dec 6, 2016
AUTHORS Updated AUTHORS to reflect recent changes to the project Sep 9, 2013
BUGS Point to the GitHub issues page for the list of current bugs Sep 9, 2013
CHANGELOG.md spelling fixes Dec 29, 2016
CMakeLists.txt rpm specfile consolidation Dec 23, 2016
CONTRIBUTING.md merge master Sep 24, 2015
COPYING update gpl 2 statement Dec 26, 2016
ChangeLog Pointed the ChangeLog to the commits url Sep 5, 2013
Dockerfile Run Docker db/apache setup once, not on every startup; kill mysql cle… Jun 2, 2016
INSTALL codespell: misc. spelling corrections Feb 8, 2016
LICENSE Copied COPYING to LICENSE Apr 12, 2013
NEWS Migrate svn to git Mar 16, 2013
README.md Correct spelling of 'Mageia' in readme Aug 30, 2016
TODO update link to README to be README.md Sep 6, 2013
cmakecacheimport.sh Remove importing of binary directory in cmakecacheimport.sh Nov 15, 2013
description-pak Doing my best to manually remove nextime's plugin architecture while … Aug 13, 2013
version db update script requires version bump to 1.30.1 Dec 13, 2016
zm.conf.in add comment/warning for ZM_SERVER_HOST Mar 1, 2016
zmconfgen.pl.in update gpl 2 mailing address in source files Dec 26, 2016
zmlinkcontent.sh.in Modified zmlinkconent.sh.in to chown and chmod content folder. Fixes #… Jul 8, 2014
zoneminder-config.cmake Check the Host OS, similar to configure.ac May 20, 2015

README.md

ZoneMinder

Build Status Bountysource

All documentation for ZoneMinder is now online at https://zoneminder.readthedocs.org

Overview

ZoneMinder is an integrated set of applications which provide a complete surveillance solution allowing capture, analysis, recording and monitoring of any CCTV or security cameras attached to a Linux based machine. It is designed to run on distributions which support the Video For Linux (V4L) interface and has been tested with video cameras attached to BTTV cards, various USB cameras and also supports most IP network cameras.

Contacting the Development Team

Before creating an issue in our github forum, please read our posting rules: https://github.com/ZoneMinder/ZoneMinder/wiki/Github-Posting-Rules

Installation Methods

Building from Source is Discouraged

Historically, installing ZoneMinder onto your system required building from source code by issuing the traditional configure, make, make install commands. To get ZoneMinder to build, all of its dependencies had to be determined and installed beforehand. Init and logrotate scripts had to be manually copied into place following the build. Optional packages such as jscalendar and Cambozola had to be manually installed. Uninstalls could leave stale files around, which could cause problems during an upgrade. Speaking of upgrades, when it comes time to upgrade all these manual steps must be repeated again.

Better methods exist today that do much of this for you. The current development team, along with other volunteers, have taken great strides in providing the resources necessary to avoid building from source.

Install from a Package Repository

This is the recommended method to install ZoneMinder onto your system. ZoneMinder packages are maintained for the following distros:

If a repository that hosts ZoneMinder packages is not available for your distro, then you are encouraged to build your own package, rather than build from source. While each distro is different in ways that set it apart from all the others, they are often similar enough to allow you to adapt another distro's package building instructions to your own.

Building a ZoneMinder Package

Building ZoneMinder into a package is not any harder than building from source. As a matter of fact, if you have successfully built ZoneMinder from source in the past, then you may find these steps to be easier.

When building a package, it is best to do this work in a separate environment, dedicated to development purposes. This could be as simple as creating a virtual machine, using Docker, or using mock. All it takes is one “Oops” to regret doing this work on your production server.

Lastly, if you desire to build a development snapshot from the master branch, it is recommended you first build your package using an official release of ZoneMinder. This will help identify whether any problems you may encounter are caused by the build process or is a new issue in the master branch.

Please visit our ReadtheDocs site for distro specific instructions.

Package Maintainers

Many of the ZoneMinder configration variable default values are not configurable at build time through autotools or cmake. A new tool called zmeditconfigdata.sh has been added to allow package maintainers to manipulate any variable stored in ConfigData.pm without patching the source.

For example, let's say I have created a new ZoneMinder package that contains the cambolzola javascript file. However, by default cambozola support is turned off. To fix that, add this to the pacakging script:

./utils/zmeditconfigdata.sh ZM_OPT_CAMBOZOLA yes

Note that zmeditconfigdata.sh is intended to be called, from the root build folder, prior to running cmake or configure.

Docker

Docker is a system to run applications inside isolated containers. ZoneMinder, and the ZM webserver, will run using the Dockerfile contained in this repository. However, there is still work needed to ensure that the main ZM features work properly and are documented.

Contribution Model and Development

Pull requests are very welcome! If you would like to contribute, please follow the following steps.

  1. Fork the repo
  2. Open an issue at our GitHub Issues Tracker. Describe the bug that you've found, or the feature which you're asking for. Jot down the issue number (e.g. 456)
  3. Create your feature branch (git checkout -b 456-my-new-feature)
  4. Commit your changes (git commit -am 'Added some feature') It is preferred that you 'commit early and often' instead of bunching all changes into a single commit.
  5. Push your branch to your fork on github (git push origin 456-my-new-feature)
  6. Create new Pull Request
  7. The team will then review, discuss and hopefully merge your changes.

Analytics