ZoneMinder
/
zoneminder
mirror of https://github.com/ZoneMinder/zoneminder.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

consistent naming of ES -> Event Notification Server

pull/2743/head
Pliable Pixels 2019-10-27 10:47:09 -04:00
parent b3bdec4f02
commit b3943e0c49
No known key found for this signature in database
GPG Key ID: 58DAFD814CE7A36F
7 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/faq.rst
View File

@ -745,6 +745,6 @@ Can I use ZoneMinder as part of my commercial product?
The GPL license allows you produce systems based on GPL software provided your systems also adhere to that license and any modifications you make are also released under the same terms. The GPL does not permit you to include ZoneMinder in proprietary systems (see https://www.gnu.org/licenses/gpl-faq.html#GPLInProprietarySystem for details). If you wish to include ZoneMinder in this kind of system then you will need to license ZoneMinder under different terms. This is sometimes possible and you will need to contact me for further details in these circumstances.
I am having issues with zmNinja and/or EventServer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
zmNinja and the EventServer are 3rd party solutions. The developer maintains exhaustive `documentation and FAQs <https://zmninja.readthedocs.io/en/latest/>`__. Please direct your questions there.
I am having issues with zmNinja and/or Event Notification Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
zmNinja and the Event Notification Server are 3rd party solutions. The developer maintains exhaustive `documentation and FAQs <https://zmninja.readthedocs.io/en/latest/>`__. Please direct your questions there.

2
docs/index.rst
View File

@ -28,7 +28,7 @@ Welcome to ZoneMinder's documentation, the following resources are available
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 Server and Machine Learning for Object/People/Face detection.
Documentation for the 3rd party Event Notification Server and Machine Learning for Object/People/Face detection.

2
docs/installationguide/easydocker.rst
View File

@ -1,6 +1,6 @@
An Easy To Use Docker Image
===========================
If you are interested in trying out ZoneMinder quickly, user Dan Landon maintains an easy to use docker image for ZoneMinder. With a few simple configuration changes, it also provides complete Event Server and Machine Learning hook support. Please follow instructions in his repostory. He maintains two repositories:
If you are interested in trying out ZoneMinder quickly, user Dan Landon maintains an easy to use docker image for ZoneMinder. With a few simple configuration changes, it also provides complete Event Notification Server and Machine Learning hook support. Please follow instructions in his repostory. He maintains two repositories:
* If you want to run the latest stable release, please use his `zoneminder repository <https://github.com/dlandon/zoneminder>`__.
* If you want to run the latest zoneminder master, please use his `zoneminder master repository <https://github.com/dlandon/zoneminder.master-docker>`__.

2
docs/userguide/components.rst
View File

@ -73,7 +73,7 @@ Finally some perl scripts in the scripts directory. These scripts all have some
This is the (optional) ZoneMinder init script, see below for details.
**zmeventnotification.pl**
This is an optional 3rd party real time event notification server that also provides push notifications for zmNinja as well as machine learning powered object/face-detection. Please see `Event Server Documentation <https://zmeventnotification.readthedocs.io/en/latest/index.html>`__ for more details (Note that the machine learning components are optional, and are developed in Python3)
This is an optional 3rd party real time event notification server that also provides push notifications for zmNinja as well as machine learning powered object/face-detection. Please see `Event Notification Server Documentation <https://zmeventnotification.readthedocs.io/en/latest/index.html>`__ for more details (Note that the machine learning components are optional, and are developed in Python3)
Finally, there are also a number of ZoneMinder perl modules included. These are used by the scripts above, but can also be used by your own or 3rd party scripts. Full documentation for most modules is available in ‘pod’ form via ‘perldoc’ but the general purpose of each module is as follows.

4
docs/userguide/configfiles.rst
View File

@ -27,8 +27,8 @@ Here is an example of the file hierarchy:
The roles of the files are as follows:
* ``zm.conf`` contains various base configuration entries. You should not edit this file as it may be overwritten on an upgrade.
* ``zmeventnotification.ini`` is only present if you have installed the ZoneMinder Event Server.
* ``objectconfig.ini`` is only present if you have installed the machine learning hooks for the Event Server.
* ``zmeventnotification.ini`` is only present if you have installed the ZoneMinder Event Notification Server.
* ``objectconfig.ini`` is only present if you have installed the machine learning hooks for the Event Notification Server.
* ``conf.d`` contains additional configuration items as follows:
* ``01-system-paths.conf`` contains all the paths that were once part of ``Options->Paths`` in the Web UI. You should not edit this file as it may be overwritten on an upgrade

4
docs/userguide/options/options_email.rst
View File

@ -53,8 +53,8 @@ EMAIL_BODY - This option is used to define the content of the email that is sent
+--------+--------------------------------------------------------+
| %EIM% | Attach (first) event image with the highest score |
+--------+--------------------------------------------------------+
| %EIMOD%| Attach image of object detected. Requires event server |
| | setup and machine learning hooks |
| %EIMOD%| Attach image of object detected. Requires event notfn. |
| | server setup and machine learning hooks |
+--------+--------------------------------------------------------+
| %EV% | Attach event mpeg video |
+--------+--------------------------------------------------------+

2
docs/userguide/options/options_system.rst
View File

@ -34,7 +34,7 @@ OPT_USE_API - A global setting to enable/disable ZoneMinder APIs. If you are usi
OPT_USE_LEGACY_AUTH - Starting version 1.34.0, ZoneMinder uses a more secure Authentication mechanism using JWT tokens. Older versions used a less secure MD5 based auth hash. It is recommended you turn this off after you are sure you don't need it. If you are using a 3rd party app that relies on the older API auth mechanisms, you will have to update that app if you turn this off. Note that zmNinja 1.3.057 onwards supports the new token system.
OPT_USE_EVENT_NOTIFICATION - zmeventnotification is a 3rd party event notification server that is used to get notifications for alarms detected by ZoneMinder in real time. zmNinja requires this server for push notifications to mobile phones. This option only enables the server if its already installed. Please visit the `zmeventserver project site <https://github.com/pliablepixels/zmeventserver>`__ for installation instructions.
OPT_USE_EVENT_NOTIFICATION - zmeventnotification is a 3rd party event notification server that is used to get notifications for alarms detected by ZoneMinder in real time. zmNinja requires this server for push notifications to mobile phones. This option only enables the server if its already installed. Please visit the `Event Notification Server project site <https://github.com/pliablepixels/zmeventserver>`__ for installation instructions.
OPT_USE_GOOG_RECAPTCHA - This option allows you to include a google reCaptcha validation at login. This means in addition to providing a valid usernane and password, you will also have to pass the reCaptcha test. Please note that enabling this option results in the zoneminder login page reach out to google servers for captcha validation. Also please note that enabling this option may break 3rd party clients if they rely on web based logins (Note that zmNinja now uses the API based token method and will not be affected if reCAPTCHA is enabled). If you enable this, you also need to specify your site and secret key (please refer to context help in the ZoneMinder system screen)