Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some extra help for new users #117

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,36 @@ 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
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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling error: experiance should be "experience".


Double-Take does not include the "Integrations" below, it requires you to first setup then up and get them running.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

first setup then up -> first set them up


The following is required to get Double-Take to work:
- 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.

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: # optional
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)
Expand Down