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

Update README to link to docs & minor docs adjustment #22

Merged
merged 1 commit into from
Dec 13, 2023
Merged
Show file tree
Hide file tree
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
51 changes: 17 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# Frigate-notify

<div align="center">

![Static Badge](https://img.shields.io/badge/Project-Documentation-blue?link=https://frigate-notify.0x2142.com) ![GitHub Repo stars](https://img.shields.io/github/stars/0x2142/frigate-notify) ![GitHub release (with filter)](https://img.shields.io/github/v/release/0x2142/frigate-notify)

</div>

## About

This project is designed to generate notifications based on [Frigate](https://github.com/blakeblackshear/frigate) NVR events.

Currently Frigate only supports notifications through Home Assistant, which I don't use. So I set out to build a simple notification app that would work with a standalone Frigate server.
Currently Frigate only supports notifications through Home Assistant, which I'm not using right now. So I set out to build a simple notification app that would work with a standalone Frigate server.

## Features

Expand All @@ -20,43 +26,16 @@ Currently Frigate only supports notifications through Home Assistant, which I do
**Other**
- Aliveness monitor via HTTP GET (for use with tools like [HealthChecks](https://github.com/healthchecks/healthchecks) or [Uptime Kuma](https://github.com/louislam/uptime-kuma))

## Setup

### Configuration

An example config file has been provided (`example-config.yml`). Please copy this & edit to fit your needs.

The example config file contains additional details about how to configure the app. A few important notes:
- Only one event polling method can be configured - Either MQTT or API.
- Regardless of polling method, app needs access to Frigate API to pull screenshots
- Any combination of notification services can be enabled

By default, this app will look for a configuration file in the local directory named `config.yml`.
- This can be changed via `-c` flag (example: `./frigate-notify -c newconfig.yml`)
- or specifying a location via environment variable: `FN_CONFIGFILE`
## Installation

See [Install / Setup](https://frigate-notify.0x2142.com/install/).

### Run
## Configuration

Run locally with
```bash
$ ./frigate-notify
```

Or as a container:
```bash
$ docker run -v /path/to/config.yml:/app/config.yml ghcr.io/0x2142/frigate-notify:latest
```

A docker-compose file has also been provided. Please modify the config path before using.

## Future

Just a quick list of things I may add later:
- Dampening time between notifications
- Additional alerting methods
An example config file has been provided (`example-config.yml`). Please copy this & edit to fit your needs.

> If you use this code & have any specific feature requests - please feel free to open an issue with the details of what you would like to see added
The sample config contains inline descriptions for each field. For additional details on the available config options & the defaults, see the [Config](https://frigate-notify.0x2142.com/config/) docs.

## Screenshots

Expand All @@ -66,4 +45,8 @@ Just a quick list of things I may add later:

**Gotify**

![Gotify](/screenshots/gotify.png)
![Gotify](/screenshots/gotify.png)

## Changelog

Additional details on each release are in the [Changelog](https://frigate-notify.0x2142.com/changelog/)
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,6 @@ Currently Frigate only supports notifications through Home Assistant, which I'm

Thanks again for being here! 😊

<script async defer src="https://buttons.github.io/buttons.js"></script>
<script async defer src="https://buttons.github.io/buttons.js"></script>

<br/>
10 changes: 8 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,17 @@ repo_url: https://github.com/0x2142/frigate-notify
theme:
name: material
palette:
- scheme: slate
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
- scheme: default
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
Expand Down
Loading