Move database and config from homeassistant /config to addon /config (#16337)

* Move database and config from homeassistant /config to addon /config

* Re-implement config migration for the add-on

* Align some terms

* Improve function name

* Use local variables

* Add model.path migration

* Fix homeassistant config path

* Ensure migration scripts run before go2rtc and frigate

* Migrate all files I know

* Add ffmpeg.path migration

* Update docker/main/rootfs/etc/s6-overlay/s6-rc.d/prepare/run

Co-authored-by: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>

* Improve some variable names and organization

* Update docs to reflect addon config dir

* Update live.md with /addon_configs

* Move addon config section to configuration doc

* Align several terminologies and improve text

* Fix webrtc example config title

* Capitalize Add-on in more places

* Improve specific add-on config dir docs

* Align bash and python scripts to prefer config.yml over config.yaml

* Support config.json in migration shell scripts

* Change docs to reflect config.yml is preferred over config.yaml

* If previous config was yaml, migrate to yaml

* Fix typo in edgetpu.md

* Fix formatting of Python files

* Remove HailoRT Beta add-on variant from docs

* Add migration for labelmap and certs

* Fix variable name

* Fix new_config_file var unset

* Fix addon config directories table

* Improve db migration to avoid migrating files like .db.bak

* Fix echo location

---------

Co-authored-by: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>

docker/main/rootfs/etc/s6-overlay/s6-rc.d/frigate/run

@@ -9,39 +9,6 @@ set -o errexit -o nounset -o pipefail
 # Tell S6-Overlay not to restart this service
 s6-svc -O .
 
-function migrate_db_path() {
-    # Find config file in yaml or yml, but prefer yaml
-    local config_file="${CONFIG_FILE:-"/config/config.yml"}"
-    local config_file_yaml="${config_file//.yml/.yaml}"
-    if [[ -f "${config_file_yaml}" ]]; then
-        config_file="${config_file_yaml}"
-    elif [[ ! -f "${config_file}" ]]; then
-        # Frigate will create the config file on startup
-        return 0
-    fi
-    unset config_file_yaml
-
-    # Use yq to check if database.path is set
-    local user_db_path
-    user_db_path=$(yq eval '.database.path' "${config_file}")
-
-    if [[ "${user_db_path}" == "null" ]]; then
-        local previous_db_path="/media/frigate/frigate.db"
-        local new_db_dir="/config"
-        if [[ -f "${previous_db_path}" ]]; then
-            if mountpoint --quiet "${new_db_dir}"; then
-                # /config is a mount point, move the db
-                echo "[INFO] Moving db from '${previous_db_path}' to the '${new_db_dir}' dir..."
-                # Move all files that starts with frigate.db to the new directory
-                mv -vf "${previous_db_path}"* "${new_db_dir}"
-            else
-                echo "[ERROR] Trying to migrate the db path from '${previous_db_path}' to the '${new_db_dir}' dir, but '${new_db_dir}' is not a mountpoint, please mount the '${new_db_dir}' dir"
-                return 1
-            fi
-        fi
-    fi
-}
-
 function set_libva_version() {
     local ffmpeg_path
     ffmpeg_path=$(python3 /usr/local/ffmpeg/get_ffmpeg_path.py)
@@ -50,8 +17,8 @@ function set_libva_version() {
 }
 
 echo "[INFO] Preparing Frigate..."
-migrate_db_path
 set_libva_version
+
 echo "[INFO] Starting Frigate..."
 
 cd /opt/frigate || echo "[ERROR] Failed to change working directory to /opt/frigate"

docker/main/rootfs/etc/s6-overlay/s6-rc.d/go2rtc/run

@@ -61,7 +61,7 @@ if [[ ! -f "/dev/shm/go2rtc.yaml" ]]; then
     echo "[INFO] Preparing new go2rtc config..."
 
     if [[ -n "${SUPERVISOR_TOKEN:-}" ]]; then
-        # Running as a Home Assistant add-on, infer the IP address and port
+        # Running as a Home Assistant Add-on, infer the IP address and port
         get_ip_and_port_from_supervisor
     fi
 

docker/main/rootfs/etc/s6-overlay/s6-rc.d/prepare/run

@@ -0,0 +1,142 @@
+#!/command/with-contenv bash
+# shellcheck shell=bash
+# Do preparation tasks before starting the main services
+
+set -o errexit -o nounset -o pipefail
+
+function migrate_addon_config_dir() {
+    local home_assistant_config_dir="/homeassistant"
+
+    if ! mountpoint --quiet "${home_assistant_config_dir}"; then
+        # Not running as a Home Assistant Add-on
+        return 0
+    fi
+
+    local config_dir="/config"
+    local new_config_file="${config_dir}/config.yml"
+    local new_config_file_yaml="${new_config_file//.yml/.yaml}"
+    if [[ -f "${new_config_file_yaml}" || -f "${new_config_file}" ]]; then
+        # Already migrated
+        return 0
+    fi
+
+    local old_config_file="${home_assistant_config_dir}/frigate.yml"
+    local old_config_file_yaml="${old_config_file//.yml/.yaml}"
+    if [[ -f "${old_config_file}" ]]; then
+        :
+    elif [[ -f "${old_config_file_yaml}" ]]; then
+        old_config_file="${old_config_file_yaml}"
+        new_config_file="${new_config_file_yaml}"
+    else
+        # Nothing to migrate
+        return 0
+    fi
+    unset old_config_file_yaml new_config_file_yaml
+
+    echo "[INFO] Starting migration from Home Assistant config dir to Add-on config dir..." >&2
+
+    local db_path
+    db_path=$(yq -r '.database.path' "${old_config_file}")
+    if [[ "${db_path}" == "null" ]]; then
+        db_path="${config_dir}/frigate.db"
+    fi
+    if [[ "${db_path}" == "${config_dir}/"* ]]; then
+        # replace /config/ prefix with /homeassistant/
+        local old_db_path="${home_assistant_config_dir}/${db_path:8}"
+
+        if [[ -f "${old_db_path}" ]]; then
+            local new_db_dir
+            new_db_dir="$(dirname "${db_path}")"
+            echo "[INFO] Migrating database from '${old_db_path}' to '${new_db_dir}' dir..." >&2
+            mkdir -vp "${new_db_dir}"
+            mv -vf "${old_db_path}" "${new_db_dir}"
+            local db_file
+            for db_file in "${old_db_path}"-shm "${old_db_path}"-wal; do
+                if [[ -f "${db_file}" ]]; then
+                    mv -vf "${db_file}" "${new_db_dir}"
+                fi
+            done
+            unset db_file
+        fi
+    fi
+
+    local config_entry
+    for config_entry in .model.path .model.labelmap_path .ffmpeg.path .mqtt.tls_ca_certs .mqtt.tls_client_cert .mqtt.tls_client_key; do
+        local config_entry_path
+        config_entry_path=$(yq -r "${config_entry}" "${old_config_file}")
+        if [[ "${config_entry_path}" == "${config_dir}/"* ]]; then
+            # replace /config/ prefix with /homeassistant/
+            local old_config_entry_path="${home_assistant_config_dir}/${config_entry_path:8}"
+
+            if [[ -f "${old_config_entry_path}" ]]; then
+                local new_config_entry_entry
+                new_config_entry_entry="$(dirname "${config_entry_path}")"
+                echo "[INFO] Migrating ${config_entry} from '${old_config_entry_path}' to '${config_entry_path}'..." >&2
+                mkdir -vp "${new_config_entry_entry}"
+                mv -vf "${old_config_entry_path}" "${config_entry_path}"
+            fi
+        fi
+    done
+
+    local old_model_cache_path="${home_assistant_config_dir}/model_cache"
+    if [[ -d "${old_model_cache_path}" ]]; then
+        echo "[INFO] Migrating '${old_model_cache_path}' to '${config_dir}'..." >&2
+        mv -f "${old_model_cache_path}" "${config_dir}"
+    fi
+
+    echo "[INFO] Migrating other files from '${home_assistant_config_dir}' to '${config_dir}'..." >&2
+    local file
+    for file in .exports .jwt_secret .timeline .vacuum go2rtc; do
+        file="${home_assistant_config_dir}/${file}"
+        if [[ -f "${file}" ]]; then
+            mv -vf "${file}" "${config_dir}"
+        fi
+    done
+
+    echo "[INFO] Migrating config file from '${old_config_file}' to '${new_config_file}'..." >&2
+    mv -vf "${old_config_file}" "${new_config_file}"
+
+    echo "[INFO] Migration from Home Assistant config dir to Add-on config dir completed." >&2
+}
+
+function migrate_db_from_media_to_config() {
+    # Find config file in yml or yaml, but prefer yml
+    local config_file="${CONFIG_FILE:-"/config/config.yml"}"
+    local config_file_yaml="${config_file//.yml/.yaml}"
+    if [[ -f "${config_file}" ]]; then
+        :
+    elif [[ -f "${config_file_yaml}" ]]; then
+        config_file="${config_file_yaml}"
+    else
+        # Frigate will create the config file on startup
+        return 0
+    fi
+    unset config_file_yaml
+
+    local user_db_path
+    user_db_path=$(yq -r '.database.path' "${config_file}")
+    if [[ "${user_db_path}" == "null" ]]; then
+        local old_db_path="/media/frigate/frigate.db"
+        local new_db_dir="/config"
+        if [[ -f "${old_db_path}" ]]; then
+            echo "[INFO] Migrating database from '${old_db_path}' to '${new_db_dir}' dir..." >&2
+            if mountpoint --quiet "${new_db_dir}"; then
+                # /config is a mount point, move the db
+                mv -vf "${old_db_path}" "${new_db_dir}"
+                local db_file
+                for db_file in "${old_db_path}"-shm "${old_db_path}"-wal; do
+                    if [[ -f "${db_file}" ]]; then
+                        mv -vf "${db_file}" "${new_db_dir}"
+                    fi
+                done
+                unset db_file
+            else
+                echo "[ERROR] Trying to migrate the database path from '${old_db_path}' to '${new_db_dir}' dir, but '${new_db_dir}' is not a mountpoint, please mount the '${new_db_dir}' dir" >&2
+                return 1
+            fi
+        fi
+    fi
+}
+
+migrate_addon_config_dir
+migrate_db_from_media_to_config

docker/main/rootfs/etc/s6-overlay/s6-rc.d/prepare/type

@@ -0,0 +1 @@
+oneshot

docker/main/rootfs/etc/s6-overlay/s6-rc.d/prepare/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/prepare/run

docker/main/rootfs/usr/local/ffmpeg/get_ffmpeg_path.py

@@ -1,5 +1,4 @@
 import json
-import os
 import sys
 
 from ruamel.yaml import YAML
@@ -9,17 +8,13 @@ from frigate.const import (
     DEFAULT_FFMPEG_VERSION,
     INCLUDED_FFMPEG_VERSIONS,
 )
+from frigate.util.config import find_config_file
 
 sys.path.remove("/opt/frigate")
 
 yaml = YAML()
 
-config_file = os.environ.get("CONFIG_FILE", "/config/config.yml")
-
-# Check if we can use .yaml instead of .yml
-config_file_yaml = config_file.replace(".yml", ".yaml")
-if os.path.isfile(config_file_yaml):
-    config_file = config_file_yaml
+config_file = find_config_file()
 
 try:
     with open(config_file) as f:

docker/main/rootfs/usr/local/go2rtc/create_config.py

@@ -15,6 +15,7 @@ from frigate.const import (
     LIBAVFORMAT_VERSION_MAJOR,
 )
 from frigate.ffmpeg_presets import parse_preset_hardware_acceleration_encode
+from frigate.util.config import find_config_file
 
 sys.path.remove("/opt/frigate")
 
@@ -29,12 +30,7 @@ if os.path.isdir("/run/secrets"):
                 Path(os.path.join("/run/secrets", secret_file)).read_text().strip()
             )
 
-config_file = os.environ.get("CONFIG_FILE", "/config/config.yml")
-
-# Check if we can use .yaml instead of .yml
-config_file_yaml = config_file.replace(".yml", ".yaml")
-if os.path.isfile(config_file_yaml):
-    config_file = config_file_yaml
+config_file = find_config_file()
 
 try:
     with open(config_file) as f:

docker/main/rootfs/usr/local/nginx/get_tls_settings.py

@@ -1,18 +1,18 @@
 """Prints the tls config as json to stdout."""
 
 import json
-import os
+import sys
 
 from ruamel.yaml import YAML
 
+sys.path.insert(0, "/opt/frigate")
+from frigate.util.config import find_config_file
+
+sys.path.remove("/opt/frigate")
+
 yaml = YAML()
 
-config_file = os.environ.get("CONFIG_FILE", "/config/config.yml")
-
-# Check if we can use .yaml instead of .yml
-config_file_yaml = config_file.replace(".yml", ".yaml")
-if os.path.isfile(config_file_yaml):
-    config_file = config_file_yaml
+config_file = find_config_file()
 
 try:
     with open(config_file) as f: