Merge pull request #50 from freefd/main

Minor docs updates

docker-compose.yml

@@ -5,5 +5,5 @@ services:
     environment:
       - TZ=Etc/UTC
     volumes:
-      - /path/to/config:/app/config
+      - /path/to/config.yml:/app/config.yml
     restart: unless-stopped

docs/config.md

@@ -15,7 +15,7 @@ Configuration snippets will be provided throughout this page. Feel free to copy
 
 ```yaml title="Config File Snippet"
 frigate:
-  server: nvr.your.domain.local
+  server: nvr.your.domain.tld
   ignoressl: true
 ```
 
@@ -66,7 +66,7 @@ frigate:
 frigate:
   mqtt: 
     enabled: true
-    server: mqtt.your.domain.local
+    server: mqtt.your.domain.tld
     port: 1883
     clientid: frigate-notify
     username: mqtt-user
@@ -202,7 +202,7 @@ alerts:
 alerts:  
   gotify:
     enabled: false
-    server: gotify.your.domain.local
+    server: gotify.your.domain.tld
     token: ABCDEF
     ignoressl: true
 ```
@@ -233,12 +233,12 @@ alerts:
 alerts:  
   smtp:
     enabled: false
-    server: smtp.your.domain.local
+    server: smtp.your.domain.tld
     port: 587
     tls: true
-    user: test_user@your.domain.local
+    user: test_user@your.domain.tld
     password: test_pass
-    recipient: nvr_group@your.domain.local, someone_else@your.domain.local
+    recipient: nvr_group@your.domain.tld, someone_else@your.domain.tld
 ```
 
 ### Telegram

docs/install.md

@@ -1,6 +1,6 @@
 # Install / Setup 
 
-Both methods below will require a [configuration](config.md) file to be provided. A template can be found [here](config.md#sample-config)
+Both methods below will require a [configuration](config.md) file to be provided. A configuration template can be found [here](config.md#sample-config)
 
 ## Docker (Recommended)
 
@@ -16,16 +16,28 @@ services:
     environment:
       - TZ=Etc/UTC
     volumes:
-      - /path/to/config:/app/config
+      - /path/to/config.yml:/app/config.yml
     restart: unless-stopped
-
 ```
 
 Update `volumes` in the compose file to the location of the `config.yml` file. By default the app will check the `/app/config` directory for this file.
 
-The file name & path can also be modified by specifying a path via the `FN_CONFIGFILE` environment variable.
+The file name & path can also be modified by specifying a path via the `FN_CONFIGFILE` environment variable:
+
+```yaml
+version: "3.0"
+services:
+  frigate-notify:
+    image: ghcr.io/0x2142/frigate-notify:latest
+    environment:
+      FN_CONFIGFILE: /app/config/config.yml
+      TZ: Etc/UTC
+    volumes:
+      - /path/to/config_directory:/app/config
+    restart: unless-stopped
+```
 
-Or optionally, run without docker compose:
+Optionally, you can run without compose:
 
 ```bash
 docker run -v /path/to/config.yml:/app/config.yml ghcr.io/0x2142/frigate-notify:latest

example-config.yml

@@ -4,7 +4,7 @@
 ## Event Collection Methods
 # Note: Only enable one - webapi OR mqtt
 frigate:
-  # Frigate host URL (ex. https://frigate.yourdomain.local)
+  # Frigate host URL (ex. https://frigate.yourdomain.tld)
   # This is required for both collection methods
   server: 
   # Set to true if using SSL & a self-signed certificate
@@ -76,7 +76,7 @@ alerts:
   gotify:
     # Set to true to enable alerting via a Gotify push notification server
     enabled: false
-    # Server URL (ex. https://push.yourdomain.local)
+    # Server URL (ex. https://push.yourdomain.tld)
     server:
     # Application token generated by Gotify
     token: