https://github.com/BeardedTek-com/fEVR
fEVR -frigate Event Video Recorder. Pronounced [fee-ver]
https://github.com/BeardedTek-com/fEVR
frigate home-assistant object-detection
Last synced: 27 days ago
JSON representation
fEVR -frigate Event Video Recorder. Pronounced [fee-ver]
- Host: GitHub
- URL: https://github.com/BeardedTek-com/fEVR
- Owner: BeardedTek-com
- License: agpl-3.0
- Created: 2022-01-27T10:03:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-16T22:22:59.000Z (over 1 year ago)
- Last Synced: 2024-11-06T03:42:50.014Z (6 months ago)
- Topics: frigate, home-assistant, object-detection
- Language: Python
- Homepage: https://fevr.video
- Size: 21.9 MB
- Stars: 73
- Watchers: 2
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fEVR - frigate Event Video Recorder
## Development has ceased on this project. Frigate has matured to a point where I feel this is no longer necessary.
[](https://github.com/BeardedTek-com/fevr/blob/0.1.0/LICENSE)
[](https://t.me/BeardedTekfEVR)
[](https://github.com/BeardedTek-com/fEVR/discussions)
[](https://github.com/BeardedTek-com/fEVR/releases)
[](https://drone.beardedtek.com/BeardedTek-com/fEVR)
[](https://hub.docker.com/r/beardedtek/fevr)
[](https://twitter.com/intent/tweet?url=https%3A%2F%2Ffevr.video&text=AI%20Object%20Detection%20with%20fEVR%20-%20frigate%20Event%20Video%20Recorder)
[](https://twitter.com/intent/user?screen_name=beardedtek)
[](http://pinterest.com/pin/create/button/?url=http%3A%2F%2Ffevr.video&media=&description=AI%20Object%20Detection%20with%20fEVR%20-%20frigate%20Event%20Video%20Recorder)
[](https://reddit.com/submit?url=https://fevr.video&title=AI%20Object%20Detection%20with%20fEVR%20-%20frigate%20Event%20Video%20Recorder)
[](http://www.linkedin.com/shareArticle?mini=true&url=http%3A%2F%2Ffevr.video&title=AI%20Object%20Detection%20with%20fEVR%20-%20frigate%20Event%20Video%20Recorder)
[](https://www.paypal.com/donate/?hosted_button_id=ZAHLQF24WAKES)
[](https://github.com/sponsors/BeardedTek-com)
[](https://tallyco.in/s/waqwip/)
fEVR works along side of [frigate](https://frigate.video) to collect video and snapshots of objects detected using your existing camera systems.
fEVR v0.6 Screenshots
# Own Your Home's Security
fEVR allows you to own your home's camera system. Instead of paying multiple cloud providers varying rates to perform object detection and recording, bring them all into fEVR in your very own open source self-hosted solution! Google, Wyze, Ring, and varying Tuya based cameras all use your data AND want to charge you to store it in the cloud.
Feature comparison to leading cloud event detection providers
---
# Requirements:
- Frigate fully setup and working
- MQTT Broker (if you have frigate running, you have this) listening to 0.0.0.0
- This caused me many headaches, hopefully it saves you some hair pulling.
It allows mqtt clients on different subnets to access the broker.
If setup within your local lan this does not alone open up external access, only to other subnets which already have access.
- Example mosquitto.conf listener section if using port 1883
```
listener 1883 0.0.0.0
```
## Optional but nice:
- Tailscale Account (for secure remote access)
---
# Documentation
A special thanks to @renarena for help with proofreading docs
## [Installation - docs/INSTALL.md](docs/INSTALL.md)
## [Setup - SETUP.md](docs/SETUP.md)
## [More Info on mqtt_client - MQTT_CLIENT.md](docs/MQTT_CLIENT.md)
## [Main API Calls](docs/API.md)
## [Tutorial Videos](https://beardedtek.net/c/tutorials/videos)
## [Notifications](docs/NOTIFICATIONS.md)
---
# Support
Please note, I will generally answer questions within 24 hours, and most times even faster unless I'm on vacation or going on adventures with the family.
## [Submit an Issue](https://github.com/BeardedTek-com/fEVR/issues)
This is the preferred method if you find an error in the code or something that crashes fEVR.
## [Start a discussion](https://github.com/BeardedTek-com/fEVR/discussions)
For discussing configuration issues or things that bug you (UI tweaks or process improvements)
## [Telegram Support Channel](https://t.me/BeardedTekfEVR)
## [Matrix Support Space](https://matrix.to/#/#fevrsupport:matrix.org)
For troubleshooting, a quick question, or you just want to say hi!
---
# Development
## Main Branch
The main branch is the current release branch. When I do a release on 0.6 it will be merged to here.
## 0.6 Branch
Each major version will have its own branch. This is the current gold standard for the newest release in 0.6
## 0.6-dev Branch
This is the development branch for v0.6 Any changes will be added here before being merged with the 0.6 Branch
## 0.7-dev Branch
This is the development branch for the next version. If it introduces breaking changes, it belongs here.
# Releases
## Docker
**docker compose** is the recommended method to deploy fEVR
#### GitHub Container Repository ghcr.io (preferred location)
ghcr.io/beardedtek-com/fevr
#### Docker Hub
beardedtek/fevr
The following tags are available:
- **RECOMMENDED**
- latest
- This contains the latest release in the current stable branch
- 0.6
- This contains the latest release in the 0.6 branch
- **NOT RECOMMENDED**
- 0.6-dev
- Latest development image in the 0.6 branch. This could potentially change a couple times a day when under heavy development.
- 0.7-dev **NOT RECOMMENDED**
- Bleeding Edge and almost guaranteed to contain **breaking changes**
## 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.