Restructured Documentation

2026-09-05 14:08:43 -06:00
parent c4bd235eba
commit 289769a601
281 changed files with 5403 additions and 3563 deletions
@@ -0,0 +1,61 @@
+---
+tags:
+  - Frigate
+  - IoT
+  - Docker
+---
+
+## Purpose
+A complete and local NVR designed for Home Assistant with AI object detection.  Uses OpenCV and Tensorflow to perform realtime object detection locally for IP cameras.
+
+```yaml title="docker-compose.yml"
+version: "3.9"
+services:
+  frigate:
+    container_name: frigate
+    privileged: true # this may not be necessary for all setups
+    restart: unless-stopped
+    image: blakeblackshear/frigate:stable
+    shm_size: "256mb" # update for your cameras based on calculation above
+#    devices:
+#      - /dev/bus/usb:/dev/bus/usb # passes the USB Coral, needs to be modified for other versions
+#      - /dev/apex_0:/dev/apex_0 # passes a PCIe Coral, follow driver instructions here https://coral.ai/docs/m2/get-started/#2a-on-linux
+#      - /dev/dri/renderD128 # for intel hwaccel, needs to be updated for your hardware
+    volumes:
+      - /etc/localtime:/etc/localtime:ro
+      - /mnt/1TB_STORAGE/frigate/config.yml:/config/config.yml:ro
+      - /mnt/1TB_STORAGE/frigate/media:/media/frigate
+      - type: tmpfs # Optional: 1GB of memory, reduces SSD/SD Card wear
+        target: /tmp/cache
+        tmpfs:
+          size: 4000000000
+    ports:
+      - "5000:5000"
+      - "1935:1935" # RTMP feeds
+    environment:
+      FRIGATE_RTSP_PASSWORD: ${FRIGATE_RTSP_PASSWORD}
+    networks:
+        docker_network:
+          ipv4_address: 192.168.5.201
+
+  mqtt:
+    container_name: mqtt
+    image: eclipse-mosquitto:1.6
+    ports:
+      - "1883:1883"
+    networks:
+        docker_network:
+          ipv4_address: 192.168.5.202
+
+networks:
+  docker_network:
+    external: true
+```
+
+```yaml title=".env"
+FRIGATE_RTSP_PASSWORD=SomethingSecure101
+```
+
+## Related Documentation
+- [Docker Network Prerequisite](<../../Containers/Docker/Create the Docker Network.md>) — The configuration references the external `docker_network`; prepare it on the intended Docker host.
+- [Related Applications Documentation](<../../../reference/Applications/index.md>) — Find the connected deployments, procedures, and references for this subject.
@@ -0,0 +1,52 @@
+---
+tags:
+  - Home Assistant
+  - IoT
+  - Docker
+---
+
+## Purpose
+Open source home automation that puts local control and privacy first.  Powered by a worldwide community of tinkerers and DIY enthusiasts.
+
+```yaml title="docker-compose.yml"
+version: '3'
+services:
+  homeassistant:
+    container_name: homeassistant
+    image: "ghcr.io/home-assistant/home-assistant:stable"
+    environment:
+      - TZ=America/Denver
+    volumes:
+      - /srv/containers/Home-Assistant-Core:/config
+      - /etc/localtime:/etc/localtime:ro
+    restart: always
+    privileged: true
+    ports:
+      - 8123:8123
+    networks:
+        docker_network:
+          ipv4_address: 192.168.5.252
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.routers.homeassistant.rule=Host(`automation.cyberstrawberry.net`)"
+      - "traefik.http.routers.homeassistant.entrypoints=websecure"
+      - "traefik.http.routers.homeassistant.tls.certresolver=myresolver"
+      - "traefik.http.services.homeassistant.loadbalancer.server.port=8123"
+networks:
+  default:
+    external:
+      name: docker_network
+  docker_network:
+    external: true
+```
+
+```yaml title=".env"
+Not Applicable
+```
+
+## Related Documentation
+- [Docker Network Prerequisite](<../../Containers/Docker/Create the Docker Network.md>) — The configuration references the external `docker_network`; prepare it on the intended Docker host.
+- [Docker Macvlan Subinterface](<../../../workflows/Containers/Docker/Create a Macvlan Subinterface.md>) — Review the network setup documented for the home-automation environment.
+- [Tuya Device Integration](<../../../workflows/Applications/Home Automation/Connect Tuya Smart Lights.md>) — Find the device reservations and local integration notes.
+- [Frigate](<Frigate.md>) — Find the separately documented camera service.
+- [Related Applications Documentation](<../../../reference/Applications/index.md>) — Find the connected deployments, procedures, and references for this subject.