Documentation Updates (#94)

* rebase on main (#90)

* Update README.md

* mqtt credentials fix

Thanks to @renarena for identifying this bug in #88 and via the matrix support channel.  Much thanks!

* mqtt_client logging improvements

Was not logging config file import status.
Now outputs config file import status to stderr

* Update .drone.yml

* Documentation Updates

* Documentation Updates

Author: BeardedTek

README.md

@@ -53,7 +53,7 @@ Feature comparison to leading cloud event detection providers
 ---
 
 # Documentation
-
+A special thanks to @renarena for help with proofreading docs
 
 ## [Installation - docs/INSTALL.md](docs/INSTALL.md)
 ## [Setup - SETUP.md](docs/SETUP.md)
@@ -63,6 +63,8 @@ Feature comparison to leading cloud event detection providers
 
 ## [Tutorial Videos](https://beardedtek.net/c/tutorials/videos)
 
+## [Notifications](docs/NOTIFICATIONS.md)
+
 ---
 
 # Support
@@ -119,105 +121,3 @@ The following tags are available:
 ## PyPi
 ### **NOT RECOMMENDED**
 I'm starting to release some code on pypi as I break a few things apart for the 0.7 branch.  Use at your own risk.  It may or may not work as intended for now and breaking changes are certainly coming before this is an official release channel.
-
-
----
-
-# Notifications
-
-## More coming in 0.7
-I have started experimenting with ntfy.sh and apprise for notifications.
-
-## Home Asisstant
-As of right now it's a bit complicated. For each notification type you want for each camera, a helper entity must be added.
-For example, I have notifications setup for my driveway camera for person, animal, and vehicle, so I have the following helpers:
-- fevrDrivewayAnimal
-- fevrDrivewayCar
-- fevrDrivewayPerson
-
-The automation uses this helper entity for 2 purposes.
-- As a motion sensor
-  - If the helper is on, that means a notification is active
-- As a pause for notifications
-  - If the helper is on, it does not allow further notifications until it is turned off.
-  - In the automation, this time can be adjusted to your liking
-
-Here is the automation I'm currently using:
-As displayed when:
-- editing the automation via the UI
-- click on overflow menu (3 dots)
-- click Edit in YAML
-
-NOTES:
-- ***CAMERA*** is the camera name
-- ***HELPER ENTITY*** is the entity you created for this notification
-- ***YOUR FEVR URL*** is the url to your fevr instance
-
-```
-alias: fEVR <<CAMERA>> Person Alert
-description: fEVR Object Detection Alerts
-trigger:
-  - platform: mqtt
-    topic: frigate/events
-condition:
-  - condition: template
-    value_template: '{{ trigger.payload_json["type"] == "end" }}'
-  - condition: template
-    value_template: |-
-      {{
-      trigger.payload_json["after"]["label"] == "person"
-      }}
-  - condition: template
-    value_template: |-
-      {{
-      trigger.payload_json["after"]["top_score"] > 0.76
-      }}
-  - condition: template
-    value_template: |-
-      {{
-      trigger.payload_json["after"]["camera"] == "<<CAMERA>>"
-      }}
-action:
-  - choose:
-      - conditions:
-          - condition: state
-            state: 'off'
-            entity_id: input_boolean.fevrbackyardperson
-        sequence:
-          - service: notify.mobile_app_sg20plus
-            data:
-              message: '{{ trigger.payload_json["after"]["label"] | title }} Detected'
-              data:
-                notification_icon: mdi:cctv
-                ttl: 0
-                priority: high
-                sticky: true
-                actions:
-                  - action: URI
-                    title: Clip
-                    uri: >-
-                      <<YOUR FEVR URL>>/event/{{trigger.payload_json['after']['id']}}/snap
-                  - action: URI
-                    title: Snapshot
-                    uri: >-
-                      <<YOUR FEVR URL>>/event/{{trigger.payload_json['after']['id']}}/snap
-                image: >-
-                  <<YOUR FEVR URL>>/static/events/{{trigger.payload_json['after']['id']}}/snapshot.jpg
-                tag: '{{trigger.payload_json["after"]["id"]}}'
-                alert_once: true
-          - service: input_boolean.turn_on
-            data: {}
-            target:
-              entity_id: input_boolean.<<HELPER ENTITY>>
-          - delay:
-              hours: 0
-              minutes: 1
-              seconds: 0
-              milliseconds: 0
-          - service: input_boolean.turn_off
-            data: {}
-            target:
-              entity_id: input_boolean.<<HELPER ENTITY>>
-    default: []
-mode: single
-```

docs/INSTALL.md

@@ -2,35 +2,23 @@
 
 ## Docker Compose:
 docker-compose is the preferred installation method
+## Create directory structure
+```
+mkdir fevr
+cd fevr
+mkdir data
+mkdir events
+```
 
-### Environment Variables **NOT RECOMMENDED**
-The following environment variables can be used to configure fEVR:
-If not set, configuration can be done via the Web UI.
-
-- FEVR_TRANSPORT
-  - http or https
-- FEVR_URL
-  - defaults to 'fevr'
-- FEVR_PORT
-  - defaults to 5090
-- FEVR_DEVELOPMENT
-  - If set to true, it will use the builtin flask server in development/debug mode
-  - If set to false or unset, it will use uwsgi server.
-- TAILSCALE_ENABLE
-  - Enable or disable tailscale functionality
-  - [Sign up for tailscale](https://login.tailscale.com/start) prior to use.
-- TAILSCALE_TAGS
-  - Use tailscale tags
-  - To use tags, you must [set them up](https://login.tailscale.com/admin/acls) first.
-- TAILSCALE_HOSTNAME
-  - Set hostname for tailscale
--TAILSCALE_AUTHKEY
-  - You must [generate an auth key](https://login.tailscale.com/admin/settings/keys) first.
-
-### Edit .env file
-Copy template.env to .env and adjust as necessary:
+### Create .env file
+A template .env file is available [on GitHub](https://raw.githubusercontent.com/BeardedTek-com/fEVR/main/template.env) and down below:
 NOTE: The IP addresses in the .env file are for internal bridge networking and SHOULD NOT be on the same subnet as your home network.
 The default values should serve you well.
+
+```
+curl -o .env https://raw.githubusercontent.com/BeardedTek-com/fEVR/main/template.env
+nano .env
+```
 ```
 ### fEVR Setup ######################################################
 
@@ -48,11 +36,17 @@ TAILSCALE_ENABLE=true
 TAILSCALE_TAGS=tag:fevr
 TAILSCALE_HOSTNAME=fevr
 
-
 # Obtain Auth Key from https://login.tailscale.com/admin/authkeys
 TAILSCALE_AUTHKEY=tskey-XXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXXX
 ```
+### Edit docker-compose.yml
+A template docker.compose.yml file is provided [on GitHub](https://raw.githubusercontent.com/BeardedTek-com/fEVR/main/docker-compose.yml) and down below:
 
+```
+cd ..
+curl -o docker-compose.yml https://raw.githubusercontent.com/BeardedTek-com/fEVR/main/docker-compose.yml
+nano docker-compose.yml
+```
 ```
 version: '2.4'
 services:
@@ -79,10 +73,16 @@ services:
 This config.yml is separate from fEVR as mqtt_client can run separately from fEVR.
 In most use cases, running inside the docker container will be sufficient.
 At least 1 mqtt_client instance needs to be running either in the docker container or on a separate host as long as it can communicate with the main fEVR instance.
+**config.yml should be placed in the defined volume for `data` listed in the docker-compose.yml file provided.**
 
-More Information on mqtt_client is available in [docs/MQTT_CLIENT.md](MQTT_CLIENT)
+More Information on mqtt_client is available [here](https://ghost.fevr.video/mqtt-client)
 
-An example config.yml is provided [config.yml.template](../config.yml.template) and below
+An example config.yml is provided [on GitHub](https://raw.githubusercontent.com/BeardedTek-com/fEVR/main/config.yml.template) and below
+```
+cd data
+wget -o config.yml https://raw.githubusercontent.com/BeardedTek-com/fEVR/main/config.yml.template
+nano config.yml
+```
 ```
 fevr_host: localhost
 fevr_port: 5090
@@ -98,7 +98,9 @@ mqtt_topics:
 mqtt_apikey: 128-bit-apikey-from-fevr
 verbose: true
 ```
-config.yml should be placed in the defined volume for `data` listed in the docker-compose.yml file provided.
+```
+cd ..
+```
 
 ## Bring the system up:
 ```

docs/NOTIFICATIONS.md

@@ -0,0 +1,106 @@
+# Notifications
+
+## More coming in 0.7
+In the next major version, I am introducing notifications through [ntfy.sh](https://ntfy.sh) and [apprise](https://github.com/caronc/apprise-api).
+
+Apprise has the capability to send notifications on over 80 different platforms including Home Assistant.
+
+## Home Asisstant 
+### ***Depricated***
+### While this was a usable procedure when originally written, I don't plan on providing support, help, or developing this further
+As noted above, notifications are coming in 0.7 using ntfy.sh and apprise.  Home Assistant is changing way too fast to keep up with all the cool new ways to do things.  Feel free to try this method, but no guarantees.
+
+---
+
+Honestly, this is a bit of a pain in the rear. For each notification type you want for each camera, a helper entity must be added.
+For example, I have notifications setup for my driveway camera for person, animal, and vehicle, so I have the following helpers:
+- fevrDrivewayAnimal
+- fevrDrivewayCar
+- fevrDrivewayPerson
+
+The automation uses this helper entity for 2 purposes.
+- As a motion sensor
+  - If the helper is on, that means a notification is active
+- As a pause for notifications
+  - If the helper is on, it does not allow further notifications until it is turned off.
+  - In the automation, this time can be adjusted to your liking
+
+Here is the automation I'm currently using:
+As displayed when:
+- editing the automation via the UI
+- click on overflow menu (3 dots)
+- click Edit in YAML
+
+NOTES:
+`<<CAMERA>>` is the camera name
+`<<HELPER ENTITY>>` is the entity you created for this notification
+`<<YOUR FEVR URL>>` is the url to your fevr instance
+
+```
+alias: fEVR <<CAMERA>> Person Alert
+description: fEVR Object Detection Alerts
+trigger:
+  - platform: mqtt
+    topic: frigate/events
+condition:
+  - condition: template
+    value_template: '{{ trigger.payload_json["type"] == "end" }}'
+  - condition: template
+    value_template: |-
+      {{
+      trigger.payload_json["after"]["label"] == "person"
+      }}
+  - condition: template
+    value_template: |-
+      {{
+      trigger.payload_json["after"]["top_score"] > 0.76
+      }}
+  - condition: template
+    value_template: |-
+      {{
+      trigger.payload_json["after"]["camera"] == "<<CAMERA>>"
+      }}
+action:
+  - choose:
+      - conditions:
+          - condition: state
+            state: 'off'
+            entity_id: input_boolean.fevrbackyardperson
+        sequence:
+          - service: notify.mobile_app_sg20plus
+            data:
+              message: '{{ trigger.payload_json["after"]["label"] | title }} Detected'
+              data:
+                notification_icon: mdi:cctv
+                ttl: 0
+                priority: high
+                sticky: true
+                actions:
+                  - action: URI
+                    title: Clip
+                    uri: >-
+                      <<YOUR FEVR URL>>/event/{{trigger.payload_json['after']['id']}}/snap
+                  - action: URI
+                    title: Snapshot
+                    uri: >-
+                      <<YOUR FEVR URL>>/event/{{trigger.payload_json['after']['id']}}/snap
+                image: >-
+                  <<YOUR FEVR URL>>/static/events/{{trigger.payload_json['after']['id']}}/snapshot.jpg
+                tag: '{{trigger.payload_json["after"]["id"]}}'
+                alert_once: true
+          - service: input_boolean.turn_on
+            data: {}
+            target:
+              entity_id: input_boolean.<<HELPER ENTITY>>
+          - delay:
+              hours: 0
+              minutes: 1
+              seconds: 0
+              milliseconds: 0
+          - service: input_boolean.turn_off
+            data: {}
+            target:
+              entity_id: input_boolean.<<HELPER ENTITY>>
+    default: []
+mode: single
+```