From 0bd3be94ec35c657062fe234f75c949d9d088162 Mon Sep 17 00:00:00 2001 From: Lindsay Ward Date: Sat, 23 Oct 2021 15:15:44 +1000 Subject: [PATCH] Clarify environment variables Based on issue #1976 - specify explicitly that these fields can include environment variables to avoid interpretation that environment variables could be used anywhere. I am participating in #hacktoberfest, so I would appreciate if you could add the 'hacktoberfest-accepted' label (or add #hacktoberfest topic to your repo). Thanks! --- docs/docs/configuration/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index f0a111ecd..71404ed9a 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -48,8 +48,8 @@ mqtt: # Optional: user user: mqtt_user # Optional: password - # NOTE: Environment variables that begin with 'FRIGATE_' may be referenced in {}. - # eg. password: '{FRIGATE_MQTT_PASSWORD}' + # NOTE: MQTT password can be specified with an environment variables that must begin with 'FRIGATE_'. + # e.g. password: '{FRIGATE_MQTT_PASSWORD}' password: password # Optional: tls_ca_certs for enabling TLS using self-signed certs (default: None) tls_ca_certs: /path/to/ca.crt @@ -319,7 +319,7 @@ cameras: # Required: A list of input streams for the camera. See documentation for more information. inputs: # Required: the path to the stream - # NOTE: Environment variables that begin with 'FRIGATE_' may be referenced in {} + # NOTE: path may include environment variables, which must begin with 'FRIGATE_' and be referenced in {} - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2 # Required: list of roles for this stream. valid values are: detect,record,rtmp # NOTICE: In addition to assigning the record, and rtmp roles,