From 7fd2648ef1fb4bdeb2c83d1f7cc85a00f4af3db5 Mon Sep 17 00:00:00 2001 From: tubalainen Date: Tue, 5 Oct 2021 11:53:45 +0200 Subject: [PATCH 1/2] Some extra help for new users --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 04c0f215..32f7be12 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,35 @@ There's a lot of great open source software to perform facial recognition, but e - [Frigate](https://github.com/blakeblackshear/frigate) v0.8.0-0.9.0 +## Getting started +Double-Take utilizes MQTT and Frigate to get the images into it's ecosystem. Therefore Frigate and MQTT are required components. + +Double-Take does not include the "Integrations" below, it requires you to first setup then up and get them running. + +The following is required to get Double-Take to work: +- Working Frigate setup and working connection to the MQTT broker +- A detector installed and working (such as Deepstack) + +To get Double-Take up and running you do not need to setup any Double-Take configuration file prior to starting the docker container, you can do all configuration via en UI after the initial startup. + +Minimal configuration settings to get basic functionality in Double-Take + +```yaml +mqtt: + host: 192.168.1.20 # Change the IP to suit your setup +# username: username +# password: password + +frigate: + url: "http://192.168.1.22:5000" # Change the IP to suit your setup + +detectors: + deepstack: + url: "http://192.168.1.23:5000" # Change the IP to suit your setup +``` + +If you decide to go with Deepstack it will require you to enable two enviormental variable to support face detection `-e VISION-DETECTION=True -e VISION-FACE=True`. Please consult the Deepstack docker documentation for details. + ## Integrations ### [Frigate](https://github.com/blakeblackshear/frigate) From 7ae0af3965fea310cfdf06093ad2efd6738e32b5 Mon Sep 17 00:00:00 2001 From: tubalainen Date: Wed, 6 Oct 2021 10:29:55 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 32f7be12..e3630a3c 100644 --- a/README.md +++ b/README.md @@ -33,13 +33,14 @@ There's a lot of great open source software to perform facial recognition, but e - [Frigate](https://github.com/blakeblackshear/frigate) v0.8.0-0.9.0 ## Getting started -Double-Take utilizes MQTT and Frigate to get the images into it's ecosystem. Therefore Frigate and MQTT are required components. +For the "full experiance" Double-Take utilizes MQTT and Frigate to get the images into it's ecosystem. You can also upload images manually via the UI and fetch them via a URL. Double-Take does not include the "Integrations" below, it requires you to first setup then up and get them running. The following is required to get Double-Take to work: -- Working Frigate setup and working connection to the MQTT broker -- A detector installed and working (such as Deepstack) +- MQTT Broker +- One or more detector(s) installed, configured and working +- Frigate (optional) To get Double-Take up and running you do not need to setup any Double-Take configuration file prior to starting the docker container, you can do all configuration via en UI after the initial startup. @@ -51,7 +52,7 @@ mqtt: # username: username # password: password -frigate: +frigate: # optional url: "http://192.168.1.22:5000" # Change the IP to suit your setup detectors: