diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index eacb8cb1f..26f089695 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -39,6 +39,8 @@ It is not recommended to copy this full configuration file. Only specify values ```yaml mqtt: + # Optional: Enable mqtt server (default: shown below) + enabled: True # Required: host name host: mqtt.server.com # Optional: port (default: shown below) diff --git a/docs/docs/guides/getting_started.md b/docs/docs/guides/getting_started.md index 5fe51cb00..57936fdcd 100644 --- a/docs/docs/guides/getting_started.md +++ b/docs/docs/guides/getting_started.md @@ -5,15 +5,22 @@ title: Creating a config file This guide walks through the steps to build a configuration file for Frigate. It assumes that you already have an environment setup as described in [Installation](/installation). You should also configure your cameras according to the [camera setup guide](/guides/camera_setup) -### Step 1: Configure the MQTT server +### Step 1: Configure the MQTT server (Optional) -Frigate requires a functioning MQTT server. Start by adding the mqtt section at the top level in your config: +Use of a functioning MQTT server is optional for frigate, but required for the home assistant integration. Start by adding the mqtt section at the top level in your config: +If using mqtt: ```yaml mqtt: host: ``` +If not using mqtt: +```yaml +mqtt: + enabled: False +``` + If using the Mosquitto Addon in Home Assistant, a username and password is required. For example: ```yaml diff --git a/docs/docs/installation.md b/docs/docs/installation.md index 5fe8e59fd..7935f82f8 100644 --- a/docs/docs/installation.md +++ b/docs/docs/installation.md @@ -7,7 +7,7 @@ Frigate is a Docker container that can be run on any Docker host including as a ## Dependencies -**MQTT broker** - Frigate requires an MQTT broker. 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. ## Preparing your hardware diff --git a/frigate/config.py b/frigate/config.py index e52a81d35..a2f7f3e63 100644 --- a/frigate/config.py +++ b/frigate/config.py @@ -60,6 +60,7 @@ class UIConfig(FrigateBaseModel): class MqttConfig(FrigateBaseModel): + enabled: bool = Field(title="Enable MQTT Communication.", default=True) host: str = Field(title="MQTT Host") port: int = Field(default=1883, title="MQTT Port") topic_prefix: str = Field(default="frigate", title="MQTT Topic Prefix")