fEVR icon indicating copy to clipboard operation
fEVR copied to clipboard

fEVR -frigate Event Video Recorder. Pronounced [fee-ver]

fEVR - frigate Event Video Recorder

license telegram Discussions commits since last release Build Status Image Size Twitter URL twitter-follow

Pinterest Reddit LinkedIn Donate - Paypal Donate - GitHub Donate - Tallyco.in

fEVR works along side of frigate to collect video and snapshots of objects detected using your existing camera systems.

fEVR v0.6 Screenshots

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

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

Setup - SETUP.md

More Info on mqtt_client - MQTT_CLIENT.md

Main API Calls

Tutorial Videos

Notifications


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

This is the preferred method if you find an error in the code or something that crashes fEVR.

Start a discussion

For discussing configuration issues or things that bug you (UI tweaks or process improvements)

Telegram Support Channel

Matrix Support Space

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.