Merge pull request #429 from roflcoopter/dev

docs: add example configuration

docs/docs/documentation.md

@@ -10,17 +10,19 @@ The goal is ease of use while also leveraging hardware acceleration for minimal
 Viserons features include, but not limited to the following:
 
 - Object detection via:
-  - YOLOv3/4 Darknet using OpenCV
+  - YOLOv3, YOLOv4 and YOLOv7 Darknet using OpenCV
   - Tensorflow via Google Coral EdgeTPU
   - [DeepStack](https://docs.deepstack.cc/)
 - Motion detection
 - Face recognition via:
   - dlib
   - [DeepStack](https://docs.deepstack.cc/)
+  - [CompreFace](https://github.com/exadel-inc/CompreFace)
+- Image classification
 - Responsive, mobile friendly Web UI written in TypeScript React
 - MQTT support
 - [Home Assistant](https://home-assistant.io) MQTT Discovery
-- Lookback, buffers frames to record before the event actually happened
+- Lookback, record before an event actually happens
 - Supports hardware acceleration on different platforms
   - CUDA for systems with a supported GPU
   - OpenCL
@@ -40,16 +42,21 @@ Viserons features include, but not limited to the following:
 ## Screenshots
 
 <p align="center">
-  <img src="/img/screenshots/Viseron-screenshot-cameras.png" alt-text="Camera view"/>
   Camera view
+  <img src="/img/screenshots/Viseron-screenshot-cameras.png" alt-text="Camera view"/>
 </p>
 
 <p align="center">
-  <img src="/img/screenshots/Viseron-screenshot-recordings.png" alt-text="Recordings view"/>
   Recordings view
+  <img src="/img/screenshots/Viseron-screenshot-recordings.png" alt-text="Recordings view"/>
+</p>
+
+<p align="center">
+  Entities view
+  <img src="/img/screenshots/Viseron-screenshot-entities.png" alt-text="Entities view"/>
 </p>
 
 <p align="center">
-  <img src="/img/screenshots/Viseron-screenshot-configuration.png" alt-text="Configuration Editor"/>
   Configuration Editor
+  <img src="/img/screenshots/Viseron-screenshot-configuration.png" alt-text="Configuration Editor"/>
 </p>

docs/docs/documentation/configuration.md

@@ -26,6 +26,116 @@ The built in Configuration Editor has syntax highlighting, making your YAML ende
 
 :::
 
+## Example configuration
+
+Below is an example configuration with publicly available cameras.
+
+:::warning
+
+This configuration serves as an example only.<br />
+The cameras are not hosted by Viseron, and are not guaranteed to be online at all times.
+
+Keep reading so you get a better understanding of how to configure Viseron for your own cameras.
+
+:::
+
+<details><summary>Example configuration</summary>
+
+```yaml title="/config/config.yaml"
+ffmpeg:
+  camera:
+    viseron_camera:
+      name: Camera 1
+      host: 195.196.36.242
+      path: /mjpg/video.mjpg
+      port: 80
+      stream_format: mjpeg
+      fps: 6
+      recorder:
+        idle_timeout: 1
+        codec: h264
+    viseron_camera2:
+      name: Camera 2
+      host: storatorg.halmstad.se
+      path: /mjpg/video.mjpg
+      stream_format: mjpeg
+      port: 443
+      fps: 2
+      protocol: https
+      recorder:
+        idle_timeout: 1
+        codec: h264
+    viseron_camera3:
+      name: Camera 3
+      host: 195.196.36.242
+      path: /mjpg/video.mjpg
+      port: 80
+      stream_format: mjpeg
+      fps: 6
+      recorder:
+        idle_timeout: 1
+        codec: h264
+
+mog2:
+  motion_detector:
+    cameras:
+      viseron_camera:
+        fps: 1
+      viseron_camera2:
+        fps: 1
+
+background_subtractor:
+  motion_detector:
+    cameras:
+      viseron_camera3:
+        fps: 1
+        mask:
+          - coordinates:
+              - x: 400
+                y: 200
+              - x: 1000
+                y: 200
+              - x: 1000
+                y: 750
+              - x: 400
+                y: 750
+
+darknet:
+  object_detector:
+    cameras:
+      viseron_camera:
+        fps: 1
+        scan_on_motion_only: false
+        labels:
+          - label: person
+            confidence: 0.8
+            trigger_recorder: true
+      viseron_camera2:
+        fps: 1
+        labels:
+          - label: person
+            confidence: 0.8
+            trigger_recorder: true
+      viseron_camera3:
+        fps: 1
+        labels:
+          - label: person
+            confidence: 0.8
+            trigger_recorder: true
+
+nvr:
+  viseron_camera:
+  viseron_camera2:
+  viseron_camera3:
+
+webserver:
+
+logger:
+  default_level: debug
+```
+
+</details>
+
 ## Components
 
 Viserons config consists of [components](/components-explorer).<br />

docs/docs/documentation/installation.mdx

@@ -37,6 +37,12 @@ The images available are:
 Below are a few examples on how to run Viseron. <br />
 Both `docker` and `docker-compose` examples are given.
 
+:::caution IMPORTANT
+
+You have to change the values between the brackets `{}` to match your setup.
+
+:::
+
 <details><summary>64-bit Linux machine</summary>
 
 <Tabs groupId="docker-type">