mirror of
https://github.com/blakeblackshear/frigate.git
synced 2024-11-21 19:07:46 +01:00
Update docs to reflect HA addon storage feature (#6681)
* Clean up docs given HA addon storage support * Add guide for using HA network storage * Add to sidebar * Specify that media type needs to be used * Link to storage guide from install docs * Instruct users to store DB in /config * Update ha_network_storage.md * Recommend that data is moved or deleted
This commit is contained in:
parent
730416418d
commit
8cb8a030be
@ -159,12 +159,13 @@ docker run -d \
|
||||
ghcr.io/blakeblackshear/frigate:stable
|
||||
```
|
||||
|
||||
## Home Assistant Operating System (HassOS)
|
||||
## Home Assistant Addon
|
||||
|
||||
:::caution
|
||||
|
||||
As of HomeAssistant OS 10.2 and Core 2023.6 defining separate storage for media is supported.
|
||||
|
||||
There are important limitations in Home Assistant Operating System to be aware of:
|
||||
- Utilizing external storage for recordings or snapshots requires [modifying udev rules manually](https://community.home-assistant.io/t/solved-mount-usb-drive-in-hassio-to-be-used-on-the-media-folder-with-udev-customization/258406/46).
|
||||
- AMD GPUs are not supported because HA OS does not include the mesa driver.
|
||||
- Nvidia GPUs are not supported because addons do not support the nvidia runtime.
|
||||
|
||||
@ -172,7 +173,7 @@ There are important limitations in Home Assistant Operating System to be aware o
|
||||
|
||||
:::tip
|
||||
|
||||
If possible, it is recommended to run Frigate standalone in Docker and use [Frigate's Proxy Addon](https://github.com/blakeblackshear/frigate-hass-addons/blob/main/frigate_proxy/README.md).
|
||||
See [the network storage guide](/guides/ha_network_storage.md) for instructions to setup network storage for frigate.
|
||||
|
||||
:::
|
||||
|
||||
@ -195,32 +196,6 @@ There are several versions of the addon available:
|
||||
| Frigate NVR Beta | Beta release with protection mode on |
|
||||
| Frigate NVR Beta (Full Access) | Beta release with the option to disable protection mode |
|
||||
|
||||
## Home Assistant Supervised
|
||||
|
||||
:::caution
|
||||
|
||||
There are important limitations in Home Assistant Supervised to be aware of:
|
||||
- Nvidia GPUs are not supported because addons do not support the nvidia runtime.
|
||||
|
||||
:::
|
||||
|
||||
:::tip
|
||||
|
||||
If possible, it is recommended to run Frigate standalone in Docker and use [Frigate's Proxy Addon](https://github.com/blakeblackshear/frigate-hass-addons/blob/main/frigate_proxy/README.md).
|
||||
|
||||
:::
|
||||
|
||||
When running Home Assistant with the [Supervised install method](https://github.com/home-assistant/supervised-installer), you can get the benefit of running the Addon along with the ability to customize the storage used by Frigate.
|
||||
|
||||
In order to customize the storage location for Frigate, simply use `fstab` to mount the drive you want at `/usr/share/hassio/media`. Here is an example fstab entry:
|
||||
|
||||
```shell
|
||||
UUID=1a65fec6-c25f-404a-b3d2-1f2fcf6095c8 /media/data ext4 defaults 0 0
|
||||
/media/data/homeassistant/media /usr/share/hassio/media none bind 0 0
|
||||
```
|
||||
|
||||
Then follow the instructions listed for [Home Assistant Operating System](#home-assistant-operating-system-hassos).
|
||||
|
||||
## Kubernetes
|
||||
|
||||
Use the [helm chart](https://github.com/blakeblackshear/blakeshome-charts/tree/master/charts/frigate).
|
||||
|
45
docs/docs/guides/ha_network_storage.md
Normal file
45
docs/docs/guides/ha_network_storage.md
Normal file
@ -0,0 +1,45 @@
|
||||
---
|
||||
id: ha_network_storage
|
||||
title: HA Network Storage
|
||||
---
|
||||
|
||||
As of HomeAsisstant Core 2023.6, Network Mounted Storage is supported for addons.
|
||||
|
||||
## Setting Up Remote Storage For Frigate
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- HA Core 2023.6 or newer is installed
|
||||
- Running HA OS 10.2 or newer OR Running Supervised with latest os-agent installed (this is required for superivsed install)
|
||||
|
||||
### Initial Setup
|
||||
|
||||
1. Stop the Frigate addon
|
||||
2. Update your config so the DB is stored in the /config directory by adding:
|
||||
```yaml
|
||||
database:
|
||||
path: /config/frigate.db
|
||||
```
|
||||
|
||||
### Move current data
|
||||
|
||||
Keeping the current data is optional, but the data will need to be moved regardless so the share can be created successfully.
|
||||
|
||||
#### If you want to keep the current data
|
||||
|
||||
1. Move the frigate.db, frigate.db-shm, frigate.db-wal files to the /config directory
|
||||
2. Rename the /media/frigate folder to /media/frigate_tmp
|
||||
|
||||
#### If you don't want to keep the current data
|
||||
|
||||
1. Delete the /media/frigate folder and all of its contents
|
||||
|
||||
### Create the media share
|
||||
|
||||
1. Go to **Settings -> System -> Storage -> Add Network Storage**
|
||||
2. Name the share `frigate` (this is required)
|
||||
3. Choose type `media`
|
||||
4. Fill out the additional required info for your particular NAS
|
||||
5. Connect
|
||||
6. Move files from `/media/frigate_tmp` to `/media/frigate` if they were kept in previous step
|
||||
7. Start the Frigate addon
|
@ -11,6 +11,7 @@ module.exports = {
|
||||
"guides/configuring_go2rtc",
|
||||
"guides/false_positives",
|
||||
"guides/ha_notifications",
|
||||
"guides/ha_network_storage",
|
||||
"guides/stationary_objects",
|
||||
"guides/reverse_proxy",
|
||||
],
|
||||
|
Loading…
Reference in New Issue
Block a user