Add comments to docker-compose.yaml

This commit is contained in:
The-Dark-Mode
2025-07-10 18:29:26 +12:00
committed by GitHub
parent b7258c8776
commit 9c078e42b7

View File

@ -1,21 +1,21 @@
services: services:
frigate-smtp: frigate-smtp:
build: . build: . # Build image from local Dockerfile in current directory
container_name: frigate-smtp container_name: frigate-smtp # Set container name for easier management
image: frigate_smtp image: frigate-smtp # Name of the Docker image
restart: unless-stopped restart: unless-stopped # Automatically restart container unless manually stopped
environment: environment: # Environment variables to configure the service
SMTP_SERVER: smtp.example.com SMTP_SERVER: smtp.example.com # SMTP server address for sending emails
SMTP_PORT: 587 SMTP_PORT: 587 # SMTP server port (usually 587 for TLS)
SMTP_USERNAME: user@example.com SMTP_USERNAME: user@example.com # SMTP username for authentication
SMTP_PASSWORD: yourpassword SMTP_PASSWORD: yourpassword # SMTP password for authentication
EMAIL_FROM: user@example.com EMAIL_FROM: user@example.com # Sender email address
EMAIL_TO: you@example.com,friend@example.com EMAIL_TO: you@example.com,friend@example.com # Recipient email addresses (comma-separated)
HOMEASSISTANT_URL: https://ha.domain.com HOMEASSISTANT_URL: https://ha.domain.com # URL to Home Assistant instance (external)
HOMEASSISTANT_IP: http://ha-ip:8123 HOMEASSISTANT_IP: http://ha-ip:8123 # Home Assistant internal IP URL
MQTT_BROKER_IP: mqtt-ip MQTT_BROKER_IP: mqtt-ip # MQTT broker IP address
MQTT_PORT: 1883 MQTT_PORT: 1883 # MQTT broker port
MQTT_USERNAME: mqttuser MQTT_USERNAME: mqttuser # MQTT username for authentication
MQTT_PASSWORD: mqttpass MQTT_PASSWORD: mqttpass # MQTT password for authentication
ALLOWED_CAMERAS: camera1,camera2 ALLOWED_CAMERAS: camera1,camera2 # List of cameras to allow (comma-separated)
IGNORED_LABELS: label1,label2 # if none, anything is acceptable (e.g. "...") IGNORED_LABELS: label1,label2 # Labels to ignore - e.g. car, person, cat; if none, set to "..."