mirror of
https://github.com/ZoneMinder/zoneminder.git
synced 2025-12-23 22:37:53 -05:00
Rework Getting Started doc section
This commit is contained in:
efranzwa
@@ -1,172 +1,252 @@
|
||||
Getting Started
|
||||
===============
|
||||
|
||||
Having followed the :doc:`/installationguide/index` for your distribution you should now be able to load the ZoneMinder web frontend. By default this will be with the Classic skin, below is an example of the page you should now see.
|
||||
The intent of this section is to provide a simplified introduction to some of the basic configuration tasks that most ZoneMinder servers will require. This will include setting your Timezone, enabling Authentication, adding a Monitor (camera), adding a Zone and changing the web display Theme. Detailed explanations about each particular item can be found in their respective sections of the ZoneMinder documentation.
|
||||
|
||||
.. image:: ../installationguide/images/zm_first_screen_post_install.png
|
||||
Having followed the :doc:`/installationguide/index` for your distribution you should now be able to load the ZoneMinder web interface which can be found at ``http://hostname-or-ip/zm``. The image below shows an example of the ZoneMinder Console which is displayed after starting. The ZoneMinder Console is the central location from which all ZoneMinder configuration and functionality can be accessed.
|
||||
|
||||
.. figure:: images/getting-started-first-screen.png
|
||||
|
||||
ZoneMinder Console
|
||||
|
||||
.. note::
|
||||
|
||||
Please note that in this guide the notation of :guilabel:`Link` means that you click on the specified link on the web interface to perform the specified action.
|
||||
|
||||
.. _timezone_config:
|
||||
|
||||
Setting Timezone
|
||||
^^^^^^^^^^^^^^^^^
|
||||
Previous versions of ZoneMinder required the user to set up Timezone correctly in ``php.ini``. This is no longer the case. Starting 1.34, ZoneMinder allows you to specify the TimeZone in the UI. Please make sure it is set up correctly. The Timezone can be changed by selecting ``Options->System->Timezone``
|
||||
----------------
|
||||
|
||||
ZoneMinder allows you to specify the Timezone in the web interface. Please set up before moving forward so that your saved events, logfiles and timestamp overlays contain correct time information. The Timezone can be changed using the following steps.
|
||||
|
||||
* At the top of Console display click on the :guilabel:`Options` menu link.
|
||||
* The Options window opens. Locate and click the :guilabel:`System` tab link.
|
||||
* Locate the **TIMEZONE** parameter and use the pulldown menu to locate your Timezone.
|
||||
|
||||
.. image:: images/getting-started-timezone.png
|
||||
|
||||
Enabling Authentication
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
We strongly recommend enabling authentication right away. There are some situations where certain users don't enable authentication, such as instances where the server is in a LAN not directly exposed to the Internet, and is only accessible via VPN etc., but in most cases, authentication should be enabled. So let's do that right away.
|
||||
-----------------------
|
||||
|
||||
* Click on the Options link on the top bar of the web interface
|
||||
* You will now be presented with a sidebar full of options. Click on the "System" link
|
||||
|
||||
.. image:: images/getting-started-enable-auth.png
|
||||
We strongly recommend enabling authentication during initial setup of ZoneMinder. There are some situations where certain users don't enable authentication, such as instances where the server is in a LAN not directly exposed to the Internet. In most cases authentication should be enabled. Follow the steps below.
|
||||
|
||||
* The relevant portions to change are marked in red above
|
||||
* Enable OPT_USE_AUTH - this automatically switches to authentication mode with a default user (more on that later)
|
||||
* Select a random string for AUTH_HASH_SECRET - this is used to make the authentication logic more secure, so
|
||||
please generate your own string and make sure it is sufficiently randomized and long. Note that if you plan to use APIs with ZoneMinder (needed by zmNinja/other apps), it is mandatory that you have this field populated
|
||||
* The other options highlighted above should already be set, but if not, please make sure they are
|
||||
* Note that if you are planning to use zmNinja and plan to use ZM authentication, you must also:
|
||||
* Click on the :guilabel:`Options` link in the top bar of the web interface.
|
||||
* You will now be presented with a sidebar full of Option tabs. Click on the :guilabel:`System` tab and scroll down to the section containing authentication parameters.
|
||||
|
||||
* set ``AUTH_RELAY`` to hashed
|
||||
* Enable ``AUTH_HASH_LOGINS``
|
||||
|
||||
.. figure:: images/getting-started-enable-auth-1.png
|
||||
|
||||
* Click on Save at the bottom and that's it! The next time you refresh that page, you will now be presented with a login screen. Job well done!
|
||||
Authentication Parameters in System Tab
|
||||
|
||||
* **OPT_USE_AUTH:** Enable by checking the box. This enables user authentication.
|
||||
* **AUTH_HASH_SECRET:** Enter a random string. This makes authentication logic more secure.
|
||||
* Remaining items should be left as default.
|
||||
* Click on :guilabel:`Save` at the top of list and that's it! The next time you refresh that page, you will now be presented with a login screen as shown below. Job well done!
|
||||
|
||||
.. image:: images/getting-started-login.png
|
||||
|
||||
.. note:: The default login/password is "admin/admin"
|
||||
|
||||
|
||||
Understanding the Web Console
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Before we proceed, lets spend a few minutes understanding the key functions of the web console.
|
||||
For the sake of illustration, we are going to use a populated zoneminder configuration with several monitors and events.
|
||||
|
||||
.. image:: images/getting-started-understand-console.png
|
||||
|
||||
This screen is called the "console" screen in ZoneMinder and shows a summary of your monitors, associated events and more information.
|
||||
|
||||
* **A**: The options menu lets you configure many aspects of ZoneMinder. Refer to :doc:`options`.
|
||||
* **B**: This brings up a color coded log window that shows various system and component level logs. This window is useful if you are trying to diagnose issues. Refer to :doc:`logging`.
|
||||
* **C**: ZoneMinder allows you to group monitors for logical separation. This option lets you create new groups, associate monitors to them and edit/delete existing groups.
|
||||
* **D**: Filters are a powerful mechanism to perform actions when certain conditions are met. ZoneMinder comes with some preset filters that keep a tab of disk space and others. Many users create their own filters for more advanced actions like sending emails when certain events occur and more. Refer to :doc:`filterevents`.
|
||||
* **E**: The Cycle option allows you to rotate between live views of each configured monitor.
|
||||
* **F**: The Montage option shows a collage of your monitors. You can customize them including moving them around.
|
||||
* **G**: Montage Review allows you to simultaneously view past events for different monitors. Note that this is a very resource intensive page and its performance will vary based on your system capabilities.
|
||||
* **H**: Audit Events Report is more of a power user feature. This option looks for recording gaps in events and recording issues in mp4 files.
|
||||
* **I**: This is the user you are currently logged in as.
|
||||
* **J**: ZoneMinder allows you to maintain "run states". If you click on the "Running" text, ZoneMinder brings up a popup that allows you to define additional "states" (referred to as runstates). A runstate is essentially a snapshot that records the state of each monitor and you can switch between states easily. For example, you might have a run state defined that switches all monitors to "monitor" mode in which they are not recording anything while another state that sets some of the monitors to "modect". Why would you want this? A great example is to disable recording when you are at home and enable when you are away, based on time of day or other triggers. You can switch states by selecting an appropriate state manually, or do it automatically via cron jobs, for example. An example of using cron to automatically switch is provided in the :ref:`FAQ <runstate_cron_example>`. More esoteric examples of switching run states based on phone location can be found `here <https://forums.zoneminder.com/viewtopic.php?f=9&t=23026>`__.
|
||||
|
||||
|
||||
Here is an example of multiple run states that I've defined. Each one of these runstates changes the mode of specific monitors depending on time of day and other conditions. Use your imagination to decide which conditions require state changes.
|
||||
|
||||
.. image:: images/runstates.png
|
||||
|
||||
* **K**: This line shows you system health information
|
||||
* **L**: This defines how Zoneminder will record events. There are various modes. In brief Modect == record if a motion is detected,Record = always record 24x7, Mocord = always record PLUS detect motion, Monitor = just provide a live view but don't record anytime, Nodect = Don't record till an external entity via zmtrigger tells Zoneminder to (this is advanced usage).
|
||||
* **M**: This is the "source" column that tells you the type of the camera - if its an IP camera, a USB camera or more. In this example, they are all IP cameras. Green means the monitor is running. Red means there is something wrong with that camera.
|
||||
* **N**: This is the core of ZoneMinder - recording events. It gives you a count of how many events were recorded over the hour, day, week, month.
|
||||
* **O**: These are the "Zones". Zones are areas within the camera that you mark as 'hotspots' for motion detection. Simply put, when you first configure your monitors (cameras), by default Zoneminder uses the entire field of view of the camera to detect motion. You may not want this. You may want to create "zones" specifically for detecting motion and ignore others. For example, lets consider a room with a fan that spins. You surely don't want to consider the fan moving continuously a reason for triggering a record? Probably not - in that case, you'd leave the fan out while making your zones.
|
||||
* **P**: This is a "visual filter" which lets you 'filter' the console display based on text you enter. While this may not be particularly useful for small systems, ZoneMinder is also used in mega-installations will well over 200+ cameras and this visual filter helps reduce the monitors you are seeing at one time.
|
||||
|
||||
Adding Monitors
|
||||
^^^^^^^^^^^^^^^
|
||||
Now that we have a basic understanding of the web console, lets go about adding a new camera (monitor). For this example, lets assume we have an IP camera that streams RTSP at LAN IP address 192.168.1.33.
|
||||
:width: 350px
|
||||
:class: no-scaled-link
|
||||
|
||||
.. sidebar:: Note
|
||||
|
||||
|
||||
For initial login authentication the default username is **admin** and default password is **admin**.
|
||||
|
||||
Establish Login Password
|
||||
------------------------
|
||||
|
||||
ZoneMinder defines a default user with username of **admin** and password of **admin**. Use these credentials to login to ZoneMinder for the first time. This is not very secure for a server so let's change this before continuing setting up ZoneMinder. The password for the admin user can be changed by following the steps below.
|
||||
|
||||
* Click on the :guilabel:`Options` link in the top bar of the web interface.
|
||||
* Locate and click on the :guilabel:`Users` tab link.
|
||||
* Select and click on user :guilabel:`admin` to open the edit window.
|
||||
|
||||
.. figure:: images/getting-started-change-password.png
|
||||
|
||||
Changing Password in Users Tab
|
||||
|
||||
* Enter new password in :guilabel:`New Password` and :guilabel:`Confirm Password` boxes.
|
||||
* Click :guilabel:`Save` to update password.
|
||||
* Additional users can be created with flexible levels of access. Refer to :doc:`/userguide/options/options_users`.
|
||||
|
||||
Understanding the Web Console
|
||||
-----------------------------
|
||||
|
||||
Before we proceed, let's spend a few minutes understanding the key functions of the web Console. At any time you can return to the Console by clicking the :guilabel:`Console` link. For the sake of illustration, we are going to use an existing ZoneMinder server already configured with several Monitors and showing recorded events.
|
||||
|
||||
.. figure:: images/getting-started-understand-console.png
|
||||
|
||||
ZoneMinder Console for Existing Configured Server
|
||||
|
||||
This is the Console window in ZoneMinder and shows a summary of your Monitors, associated events, Zones, server status and links to other available functionality. A brief description of many of these items is given below. Each section has a much more detailed description contained in the ZoneMinder documentation.
|
||||
|
||||
[A] Options
|
||||
The Options menu lets you configure many aspects of ZoneMinder. Refer to :doc:`options`.
|
||||
[B] Log
|
||||
This brings up a color coded log window that shows various system and component level logs. This window is useful if you are trying to diagnose issues. Refer to :doc:`logging`.
|
||||
[C] Groups
|
||||
ZoneMinder allows you to group Monitors for logical separation. This option lets you create new groups, associate Monitors to them and edit/delete existing groups.
|
||||
[D] Filters
|
||||
Filters are a powerful mechanism to perform actions when certain conditions are met. ZoneMinder comes with some preset filters that keep a tab of disk space and others. Many users create their own filters for more advanced actions like sending emails when certain events occur and more. Refer to :doc:`filterevents`.
|
||||
[E] Cycle
|
||||
The Cycle option allows you to rotate between live views of each configured Monitor.
|
||||
[F] Montage
|
||||
The Montage option shows a collage of your Monitors. You can customize the placement size and location on the web interface.
|
||||
[G] Montage Review
|
||||
Allows you to simultaneously view past events for different Monitors. Note that this is a very resource intensive page and its performance will vary based on your system capabilities.
|
||||
[H] Audit Events Report
|
||||
This is more of a power user feature. This option looks for recording gaps in events and recording issues in mp4 files.
|
||||
[I] Current User
|
||||
This shows the currently logged in user.
|
||||
[J] Run State
|
||||
ZoneMinder allows you to maintain 'Run States'. A Run State is essentially a snapshot that records the state of each Monitor and you can switch between states easily. For example, you might have a Run State defined that switches all monitors the 'None' Record mode while another state that sets some of the monitors to the 'On Motion' Record mode. Why would you want this? A great example is to disable recording when you are at home and enable when you are away, based on time of day or other triggers. You can switch states by selecting an appropriate state manually, or do it automatically via cron jobs, for example. An example of using a cron job to automatically switch is provided in the :ref:`FAQ <runstate_cron_example>`. If you click on the :guilabel:`RUNNING` link, ZoneMinder displays a popup that allows you to select or define additional Run States. ZoneMinder provides a few pre-defined Run States and you can also add your own Run States here.
|
||||
|
||||
.. image:: images/getting-started-runstates.png
|
||||
:width: 350px
|
||||
:align: left
|
||||
:class: no-scaled-link
|
||||
|
||||
.. sidebar:: Run States
|
||||
|
||||
ZoneMinder Run States window allows selection of pre-defined Run States or entry of new Run States. ZoneMinder comes with pre-defined Run States of default, Stop and Restart.
|
||||
|
||||
[K] System Info
|
||||
This section shows information about the ZoneMinder server hardware.
|
||||
[L] Function
|
||||
This shows how ZoneMinder deals with Monitor stream capture, analysis and recording. The current state of each Monitor capture, analysis and recording settings is summarized here.
|
||||
[M] Source
|
||||
This is the Source column that tells you the type of the camera - if its an IP camera, a USB camera or more. In this example, they are all IP cameras. Green means the monitor is running. Red means there is something wrong with that camera.
|
||||
[N] Events
|
||||
This is the core of ZoneMinder - recording events. It gives you a count of how many events were recorded over the hour, day, week, month.
|
||||
[O] Zones
|
||||
This indicates number of Zones defined. Click in this link to define Zones for your monitor. Zones are areas within the camera that you mark as 'hotspots' for motion detection. Simply put, when you first configure your Monitors (cameras), by default ZoneMinder uses the entire field of view of the camera to detect motion. You may not want this. You may want to create Zones specifically for detecting motion and ignore others. For example, lets consider a room with a fan that spins. You surely don't want to consider the fan moving continuously a reason for triggering a record? Probably not - in that case, you'd leave the fan out while making your zones. Refer to :doc:`definezone`.
|
||||
[P] Console Filter
|
||||
This is a visual filter which lets you filter the console display based on text you enter. While this may not be particularly useful for small systems, ZoneMinder is also used in larger installations with well over 200+ cameras and this visual filter helps reduce the monitors you are viewing at one time.
|
||||
|
||||
Adding Monitors
|
||||
---------------
|
||||
|
||||
Now that we have a basic understanding of the Console web interface, lets go about adding a new Monitor. In ZoneMinder the source of a video stream is called a Monitor and this can come from many types of sources, most commonly from an IP camera.
|
||||
|
||||
.. sidebar:: Note
|
||||
|
||||
This is meant to be a simple example. For a more detailed explanation of other options available when creating a monitor, please see :doc:`/userguide/definemonitor`
|
||||
|
||||
The first thing we will need to know is how to access that camera's video feed. You will need to consult your camera's manual or check their forum. Zoneminder community users also have a frequently updated list right `here <https://wiki.zoneminder.com/index.php/Hardware_Compatibility_List>`__ that lists information about many cameras. If you don't find your list there and can't seem to find it elsewhere, feel free to register and ask in the `user forums <https://forums.zoneminder.com/>`__.
|
||||
Prior to adding Monitors in ZoneMinder you will need the following information at minimum: URL to access the video stream, authentication user/password, IP address, video resolution in pixels, frames per second (FPS) and the video stream protocol.
|
||||
|
||||
The camera we are using as an example here is a Foscam 9831W which is a 1280x960 RTSP camera, and the URL to access it's feed is *username:password@IPADDRESS:PORT/videoMain*
|
||||
The generic camera we are using as an example here has the following characteristics: URL of ``rtsp://username:password@ipaddress:port/videoMain``, resolution of 1280x960 pixels, 5 frames per second (FPS), RTSP protocol using TCP and an h.264 encoded stream. The specific information for your cameras will be different, of course.
|
||||
|
||||
Let's get started:
|
||||
Determining camera characteristics is one of the challenging aspects of ZoneMinder configuration. There are several ways to find camera information. The primary way would be the camera user manual or manufacturer product support website. The ZoneMinder community also has a frequently updated list `here <https://wiki.zoneminder.com/index.php/Hardware_Compatibility_List>`__ that lists information about many cameras. If you don't find your camera there and can't seem to find it elsewhere, feel free to register and ask in the `user forums <https://forums.zoneminder.com/>`__.
|
||||
|
||||
Click on the "Add" button below:
|
||||
* Click on the :guilabel:`+ADD` button in Console window as shown below:
|
||||
|
||||
.. image:: images/getting-started-modern-look.png
|
||||
:width: 600px
|
||||
.. image:: images/getting-started-add-monitor.png
|
||||
|
||||
This brings up the new monitor window:
|
||||
* This brings up an empty Monitor entry window starting on the General tab:
|
||||
|
||||
.. image:: images/getting-started-add-monitor-general.png
|
||||
:width: 600px
|
||||
.. figure:: images/getting-started-add-monitor-general-1.png
|
||||
|
||||
* We've given it a name of 'Garage', because, well, its better than Monitor-1 and this is my Garage camera.
|
||||
Configuring Monitor - General Tab
|
||||
|
||||
* There are various source types. As a brief introduction you'd want to use 'Local' if your camera is physically attached to your ZM server (like a USB camera, for example), and one of 'Remote', 'FFMpeg', 'Libvlc' or 'cURL' for a remote camera (not necessarily, but usually). For this example, let's go with 'FFMpeg'.
|
||||
* **Name**: Anything can be entered here but a description of location or area is generally useful. This camera is located in a garage so let's call this 'Garage'.
|
||||
* **Source Type:** FFmpeg is the recommended source type for most modern IP cameras and also the default value in ZoneMinder. For this example, FFmpeg is the appropriate choice. There are many choices for Source Type in ZoneMinder. For a detailed description of them please see :doc:`definemonitor`.
|
||||
* We are done with the General tab. Move to the next tab by clicking on :guilabel:`Source`.
|
||||
|
||||
.. note::
|
||||
As a thumb rule, if you have a camera accessible via IP and it does HTTP or RTSP,
|
||||
start with FFMpeg first and libvlc if it doesn't work (:doc:`/userguide/definemonitor`
|
||||
covers other modes in more details). If you are wondering what 'File' does, well, ZoneMinder was
|
||||
built with compatibility in mind. Take a look at `this post
|
||||
<https://wiki.zoneminder.com/index.php/How_to_use_ZoneMinder_with_cameras_it_may_not_directly_support>`__ to see how file can be used for leisure reading.
|
||||
.. figure:: images/getting-started-add-monitor-source-1.png
|
||||
|
||||
* In this example, the Function is 'Modect', which means it will start recording if motion is detected on that camera feed. The parameters for what constitutes motion detected is specific in :doc:`definezone`
|
||||
Configuring Monitor - Source Tab
|
||||
|
||||
* In Analysis FPS, we've put in 5FPS here. Note that you should not put an FPS that is greater than the camera FPS. In my case, 5FPS is sufficient for my needs
|
||||
* **Source Path**: Enter the URL for the camera stream you identified earlier. Note that if your URL contains camera authentication these may be automatically populated into the Username and Password fields.
|
||||
* **Capture Resolution:** Enter the resolution of the camera stream you are using. This example uses 1280x960 pixel resolution. The pulldown menu for this contains many commonly used camera resolutions or you can enter the horizontal and vertical resolution manually.
|
||||
* Other options can be left as the default settings.
|
||||
* We are done with the Source tab. Move to the next tab by clicking on :guilabel:`Recording` tab link.
|
||||
|
||||
.. note::
|
||||
Leave Maximum FPS and Alarm Maximum FPS **empty** if you are configuring an IP camera. In older versions of ZoneMinder, you were encouraged to put a value here, but that is no longer recommended. In fact, if you see your feed going much slower than the feed is supposed to go, or you get a lot of buffering/display issues, make sure this is empty. If you need to control camera FPS, please do it directly on the camera (via its own web interface, for example)
|
||||
.. figure:: images/getting-started-add-monitor-recording.png
|
||||
|
||||
Configuring Monitor - Recording Tab
|
||||
|
||||
* We are done for the General tab. Let's move to the next tab
|
||||
* **Recording:** For this example we want to only record events when motion is detected. Select :guilabel:`On Motion / Trigger / etc` from the dropdown menu.
|
||||
* **Storage Area:** Select :guilabel:`Default`.
|
||||
* This completes a very simplified Monitor setup. Click on :guilabel:`Save`. As one can see there are a substantial number of configuration options available. Some additional configuration parameters beyond this simple Getting Started may be needed for your specific camera and hardware setup. Many of these options are discussed in detail later in the Documentation.
|
||||
* You now have a configured monitor as seen below in the Console. To see if everything works, click on the :guilabel:`Garage` monitor you just added and you should be able to see the live feed. If you don't, inspect your ZoneMinder logs to debug.
|
||||
|
||||
.. image:: images/getting-started-add-monitor-source.png
|
||||
:width: 800px
|
||||
.. figure:: images/getting-started-add-monitor-ready.png
|
||||
|
||||
* Let's select a protocol of RTSP and a remote method of RTP/RTSP (this is an RTSP camera)
|
||||
* Note that starting ZM 1.34, GPUs are supported. In my case, I have an NVIDIA GeForce GTX1050i. These ``cuda`` and ``cuvid`` parameters are what my system supports to use the NVIDIA hardware decoder and GPU resources. If you don't have a GPU, or don't know how to configure your ffmpeg to support it, leave it empty for now. In future, we will add a section on how to set up a GPU
|
||||
Console with Configured Monitor
|
||||
|
||||
**NOTE**: It is entirely possible that ``cuda`` and ``cuvid`` don't work for you and you need different values. Isaac uses ``cuda`` in ``DecoderHWAccelName`` and leaves ``DecoderHWAccelDevice`` empty. Try that too.
|
||||
Adding Zones
|
||||
------------
|
||||
|
||||
.. todo::
|
||||
add GPU docs
|
||||
After adding a Monitor the next step is to define Zones which will be used for image analysis. By default each added Monitor has one zone defined which covers the full area captured by the camera. In most cases this is not very useful, especially if you intend to capture specific events such as a door opening or an object entering a specific area. Let's define a new Zone appropriate for this Monitor. This new Zone will help to reduce the number of events captured and space required on your storage system.
|
||||
|
||||
That's pretty much it. Click on Save. We are not going to explore the other tabs in this simple guide.
|
||||
* Referring to the Console image above, click on the :guilabel:`1` on the right side of the Garage Monitor row. This brings up the Zones window for the Garage Monitor shown below.
|
||||
|
||||
You now have a configured monitor:
|
||||
.. figure:: images/getting-started-zones.png
|
||||
|
||||
.. image:: images/getting-started-add-monitor-modect-ready.png
|
||||
Configuring Zones - Zone List
|
||||
|
||||
* Click on :guilabel:`+ADD NEW ZONE` to define a new Zone for this Monitor.
|
||||
|
||||
And then, finally, to see if everything works, if you click on the garage monitor you just added, you should be able to see its live feed. If you don't, inspect your webserver logs and your ZoneMinder logs to see what is going on.
|
||||
.. figure:: images/getting-started-zones-new.png
|
||||
|
||||
Configuring Zones - Defining Zone Analysis and Zone Area
|
||||
|
||||
Switching to another theme
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
* **Name:** Enter a descriptive name for this specific Zone. In this example we want to limit the analysis to the driveway so let's use that as its name. Having well defined Zone names can be helpful when filtering events or reviewing logfiles.
|
||||
* **Preset:** For new users of ZoneMinder it is best to start with the available Presets and make changes from there. Zone definition and proper setting of the available parameters to optimize each unique camera stream takes some time to learn. From the Preset pulldown menu, select :guilabel:`Best, High Sensitivity` for this Zone example.
|
||||
* **Points:** You can either drag the corner vertex points as required or enter the X and Y coordinates directly in the table. Additional points can be added by clicking the :guilabel:`+` on any existing point.
|
||||
* Click :guilabel:`Save` to complete the definition for the Driveway Zone.
|
||||
|
||||
.. todo::
|
||||
Fix theme text after I clearly understand that System->CSS is doing
|
||||
.. figure:: images/getting-started-zones-delete.png
|
||||
|
||||
When you first install ZoneMinder, you see is what is called a "classic" skin. Zoneminder has a host of configuration options that you can customize over time. This guide is meant to get you started the easiest possible way, so we will not go into all the details. However, it is worthwhile to note that Zoneminder also has a 'flat' theme that depending on your preferences may look more modern. So let's use that as an example of introducing you to the Options menu
|
||||
Configuring Zones - Deleting the Default All Zone
|
||||
|
||||
* Click on the Options link on the top right of the web interface in the image above
|
||||
* This will bring you to the options window as shown below. Click on the "System" tab and then select the
|
||||
"flat" option for CSS_DEFAULT as shown below
|
||||
* Delete the initial default 'All' Zone by selecting the :guilabel:`Mark` checkbox in the 'All' Zone row. Click :guilabel:`Delete` to remove the Zone.
|
||||
* Congratulations! You have now defined a Monitor and appropriate Zone for a typical use case.
|
||||
|
||||
.. image:: images/getting-started-flat-css.png
|
||||
.. figure:: images/getting-started-zones-final.png
|
||||
|
||||
* Click Save at the bottom
|
||||
A Fully Configured Zone
|
||||
|
||||
Now, switch to the "Display" tab and also select "Flat" there like so:
|
||||
Selecting Themes
|
||||
----------------
|
||||
|
||||
.. image:: images/getting-started-flat-css-2.png
|
||||
When you first install ZoneMinder, the web interface uses what is called the Base theme. It is worthwhile to note that ZoneMinder has Base, Classic and Dark themes available. These themes are controlled by the Skin and CSS settings found in the Options menu.
|
||||
|
||||
Your screen will now look like this:
|
||||
* Click on the :guilabel:`Options` link on the top of the web interface Console.
|
||||
* This will bring you to the Options window as shown below. Click on the :guilabel:`System` tab to access the available CSS themes. Changes applied here will remain after you end the session. Note that the theme for the current session will not change, see the next steps to change the theme immediately for the current session.
|
||||
|
||||
.. image:: images/getting-started-options-system.png
|
||||
:width: 500px
|
||||
:align: center
|
||||
:class: no-scaled-link
|
||||
|
||||
Congratulations! You now have a modern looking interface.
|
||||
|
|
||||
|
||||
.. image:: images/getting-started-modern-look.png
|
||||
* Click :guilabel:`Save` at the bottom if you decide to change the default theme.
|
||||
|
||||
* Now, switch to the :guilabel:`Display` tab. Changes applied here will only remain until you end the current session. This allows you to try out the different CSS themes available.
|
||||
|
||||
.. image:: images/getting-started-options-display.png
|
||||
:width: 500px
|
||||
:align: center
|
||||
:class: no-scaled-link
|
||||
|
||||
|
|
||||
|
||||
* Click :guilabel:`Save` at the bottom if you decide to change the session theme.
|
||||
|
||||
.. figure:: images/getting-started-theme-base.png
|
||||
|
||||
Example of Base Theme Console
|
||||
|
||||
.. figure:: images/getting-started-theme-dark.png
|
||||
|
||||
Example of Dark Theme Console
|
||||
|
||||
.. figure:: images/getting-started-theme-classic.png
|
||||
|
||||
Example of Classic Theme Console
|
||||
|
||||
Conclusion
|
||||
^^^^^^^^^^
|
||||
This was a quick 'Getting Started' guide where you were introduced to the very basics of how to add a monitor (camera). We've skipped many details to keep this concise. Please refer to :doc:`/userguide/definemonitor` for many other customization details.
|
||||
----------
|
||||
|
||||
This was a quick Getting Started guide where you were introduced to the very basics of how to set your Timezone, setup Authentication, add a Monitor (camera), define a Zone and change the ZoneMinder display Theme. We've skipped many details to keep this concise. Please refer to :doc:`options` for details about setting the various Options, :doc:`definemonitor` for details about setting up Monitors and finally :doc:`definezone` for details about setting up Zones.
|
||||
|
||||
Reference in New Issue
Block a user