mirror of
https://github.com/blakeblackshear/frigate.git
synced 2024-11-21 19:07:46 +01:00
Installation and getting started docs improvements (#12395)
* Add tip banner for quick links * Add link to getting started guide from installation * Remove dummy config * Move tip * Clarify installation docs Co-authored-by: Blake Blackshear <blake@frigate.video> * Update docs/docs/guides/getting_started.md Co-authored-by: Blake Blackshear <blake@frigate.video> --------- Co-authored-by: Blake Blackshear <blake@frigate.video>
This commit is contained in:
parent
da913d8d31
commit
2637541c6c
@ -5,6 +5,12 @@ title: Installation
|
|||||||
|
|
||||||
Frigate is a Docker container that can be run on any Docker host including as a [HassOS Addon](https://www.home-assistant.io/addons/). Note that a Home Assistant Addon is **not** the same thing as the integration. The [integration](/integrations/home-assistant) is required to integrate Frigate into Home Assistant.
|
Frigate is a Docker container that can be run on any Docker host including as a [HassOS Addon](https://www.home-assistant.io/addons/). Note that a Home Assistant Addon is **not** the same thing as the integration. The [integration](/integrations/home-assistant) is required to integrate Frigate into Home Assistant.
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
If you already have Frigate installed as a Home Assistant addon, check out the [getting started guide](../guides/getting_started#configuring-frigate) to configure Frigate.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
**MQTT broker (optional)** - An MQTT broker is optional with Frigate, but is required for the Home Assistant integration. If using Home Assistant, Frigate and Home Assistant must be connected to the same MQTT broker.
|
**MQTT broker (optional)** - An MQTT broker is optional with Frigate, but is required for the Home Assistant integration. If using Home Assistant, Frigate and Home Assistant must be connected to the same MQTT broker.
|
||||||
|
@ -5,9 +5,17 @@ title: Getting started
|
|||||||
|
|
||||||
# Getting Started
|
# Getting Started
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
If you already have an environment with Linux and Docker installed, you can continue to [Installing Frigate](#installing-frigate) below.
|
||||||
|
|
||||||
|
If you already have Frigate installed in Docker or as a Home Assistant addon, you can continue to [Configuring Frigate](#configuring-frigate) below.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
## Setting up hardware
|
## Setting up hardware
|
||||||
|
|
||||||
This section guides you through setting up a server with Debian Bookworm and Docker. If you already have an environment with Linux and Docker installed, you can continue to [Installing Frigate](#installing-frigate) below.
|
This section guides you through setting up a server with Debian Bookworm and Docker.
|
||||||
|
|
||||||
### Install Debian 12 (Bookworm)
|
### Install Debian 12 (Bookworm)
|
||||||
|
|
||||||
@ -77,20 +85,19 @@ This section shows how to create a minimal directory structure for a Docker inst
|
|||||||
|
|
||||||
### Setup directories
|
### Setup directories
|
||||||
|
|
||||||
Frigate requires a valid config file to start. The following directory structure is the bare minimum to get started. Once Frigate is running, you can use the built-in config editor which supports config validation.
|
Frigate will create a config file if one does not exist on the initial startup. The following directory structure is the bare minimum to get started. Once Frigate is running, you can use the built-in config editor which supports config validation.
|
||||||
|
|
||||||
```
|
```
|
||||||
.
|
.
|
||||||
├── docker-compose.yml
|
├── docker-compose.yml
|
||||||
├── config/
|
├── config/
|
||||||
│ └── config.yml
|
|
||||||
└── storage/
|
└── storage/
|
||||||
```
|
```
|
||||||
|
|
||||||
This will create the above structure:
|
This will create the above structure:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mkdir storage config && touch docker-compose.yml config/config.yml
|
mkdir storage config && touch docker-compose.yml
|
||||||
```
|
```
|
||||||
|
|
||||||
If you are setting up Frigate on a Linux device via SSH, you can use [nano](https://itsfoss.com/nano-editor-guide/) to edit the following files. If you prefer to edit remote files with a full editor instead of a terminal, I recommend using [Visual Studio Code](https://code.visualstudio.com/) with the [Remote SSH extension](https://code.visualstudio.com/docs/remote/ssh-tutorial).
|
If you are setting up Frigate on a Linux device via SSH, you can use [nano](https://itsfoss.com/nano-editor-guide/) to edit the following files. If you prefer to edit remote files with a full editor instead of a terminal, I recommend using [Visual Studio Code](https://code.visualstudio.com/) with the [Remote SSH extension](https://code.visualstudio.com/docs/remote/ssh-tutorial).
|
||||||
@ -121,22 +128,6 @@ services:
|
|||||||
- "8554:8554" # RTSP feeds
|
- "8554:8554" # RTSP feeds
|
||||||
```
|
```
|
||||||
|
|
||||||
`config.yml`
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
mqtt:
|
|
||||||
enabled: False
|
|
||||||
|
|
||||||
cameras:
|
|
||||||
dummy_camera: # <--- this will be changed to your actual camera later
|
|
||||||
enabled: False
|
|
||||||
ffmpeg:
|
|
||||||
inputs:
|
|
||||||
- path: rtsp://127.0.0.1:554/rtsp
|
|
||||||
roles:
|
|
||||||
- detect
|
|
||||||
```
|
|
||||||
|
|
||||||
Now you should be able to start Frigate by running `docker compose up -d` from within the folder containing `docker-compose.yml`. On startup, an admin user and password will be created and outputted in the logs. You can see this by running `docker logs frigate`. Frigate should now be accessible at `https://server_ip:8971` where you can login with the `admin` user and finish the configuration using the built-in configuration editor.
|
Now you should be able to start Frigate by running `docker compose up -d` from within the folder containing `docker-compose.yml`. On startup, an admin user and password will be created and outputted in the logs. You can see this by running `docker logs frigate`. Frigate should now be accessible at `https://server_ip:8971` where you can login with the `admin` user and finish the configuration using the built-in configuration editor.
|
||||||
|
|
||||||
## Configuring Frigate
|
## Configuring Frigate
|
||||||
|
Loading…
Reference in New Issue
Block a user