docs, MQTT, GH Actions

jokob-sk · Feb 28, 2025 · 4b0c7f2 · 4b0c7f2
1 parent bf3d497
commit 4b0c7f2
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 16 deletions.
diff --git a/.github/workflows/docker_dev.yml b/.github/workflows/docker_dev.yml
@@ -47,9 +47,7 @@ jobs:
         with:
           images: |
             ghcr.io/jokob-sk/netalertx-dev
-            ghcr.io/jokob-sk/pi.alert-dev
             jokobsk/netalertx-dev
-            jokobsk/pi.alert-dev     
           tags: |
             type=raw,value=latest
             type=ref,event=branch

diff --git a/.github/workflows/docker_prod.yml b/.github/workflows/docker_prod.yml
@@ -49,9 +49,7 @@ jobs:
           # list of Docker images to use as base name for tags
           images: |
             ghcr.io/jokob-sk/netalertx
-            ghcr.io/jokob-sk/pi.alert
-            jokobsk/netalertx
-            jokobsk/pi.alert       
+            jokobsk/netalertx  
           # generate Docker tags based on the following events/attributes
           tags: |
             type=semver,pattern={{version}},value=${{ inputs.version }}

diff --git a/docs/DEBUG_TIPS.md b/docs/DEBUG_TIPS.md
@@ -28,7 +28,7 @@ docker run --rm --network=host \
 
 If possible, check if your issue got fixed in the `_dev` image before opening a new issue. The container is:
 
-`jokobsk/netalertx-dev:latest`
+`ghcr.io/jokob-sk/netalertx-dev:latest`
 
 > ⚠ Please backup your DB and config beforehand!
 

diff --git a/docs/DOCKER_COMPOSE.md b/docs/DOCKER_COMPOSE.md
@@ -7,7 +7,7 @@ services:
   netalertx:
     container_name: netalertx
     # use the below line if you want to test the latest dev image
-    # image: "jokobsk/netalertx-dev:latest" 
+    # image: "ghcr.io/jokob-sk/netalertx-dev:latest" 
     image: "jokobsk/netalertx:latest"      
     network_mode: "host"        
     restart: unless-stopped
@@ -39,7 +39,7 @@ services:
     hostname: NetAlertX
     privileged: true
     # use the below line if you want to test the latest dev image
-    # image: "jokobsk/netalertx-dev:latest" 
+    # image: "ghcr.io/jokob-sk/netalertx-dev:latest" 
     image: jokobsk/netalertx:latest
     environment:
       - TZ=Europe/Bratislava
@@ -61,7 +61,7 @@ services:
   netalertx:
     container_name: netalertx
     # use the below line if you want to test the latest dev image
-    # image: "jokobsk/netalertx-dev:latest" 
+    # image: "ghcr.io/jokob-sk/netalertx-dev:latest" 
     image: "jokobsk/netalertx:latest"      
     network_mode: "host"        
     restart: unless-stopped

diff --git a/docs/MIGRATION.md b/docs/MIGRATION.md
@@ -55,7 +55,7 @@ services:
   pialert:
     container_name: pialert
     # use the below line if you want to test the latest dev image
-    # image: "jokobsk/netalertx-dev:latest" 
+    # image: "ghcr.io/jokob-sk/netalertx-dev:latest" 
     image: "jokobsk/pialert:latest"      
     network_mode: "host"        
     restart: unless-stopped
@@ -77,7 +77,7 @@ services:
   netalertx:                                  # ⚠  This has changed (🟡optional) 
     container_name: netalertx                 # ⚠  This has changed (🟡optional) 
     # use the below line if you want to test the latest dev image
-    # image: "jokobsk/netalertx-dev:latest" 
+    # image: "ghcr.io/jokob-sk/netalertx-dev:latest" 
     image: "jokobsk/netalertx:latest"         # ⚠  This has changed (🟡optional/🔺required in future) 
     network_mode: "host"        
     restart: unless-stopped
@@ -105,7 +105,7 @@ services:
   pialert:
     container_name: pialert
     # use the below line if you want to test the latest dev image
-    # image: "jokobsk/netalertx-dev:latest" 
+    # image: "ghcr.io/jokob-sk/netalertx-dev:latest" 
     image: "jokobsk/pialert:latest"      
     network_mode: "host"        
     restart: unless-stopped
@@ -127,7 +127,7 @@ services:
   netalertx:                                  # ⚠  This has changed (🟡optional) 
     container_name: netalertx                 # ⚠  This has changed (🟡optional) 
     # use the below line if you want to test the latest dev image
-    # image: "jokobsk/netalertx-dev:latest" 
+    # image: "ghcr.io/jokob-sk/netalertx-dev:latest" 
     image: "jokobsk/netalertx:latest"         # ⚠  This has changed (🟡optional/🔺required in future) 
     network_mode: "host"        
     restart: unless-stopped

diff --git a/docs/PERFORMANCE.md b/docs/PERFORMANCE.md
@@ -75,7 +75,7 @@ services:
   netalertx:
     container_name: netalertx
     # Uncomment the line below to test the latest dev image
-    # image: "jokobsk/netalertx-dev:latest"
+    # image: "ghcr.io/jokob-sk/netalertx-dev:latest"
     image: "jokobsk/netalertx:latest"      
     network_mode: "host"        
     restart: unless-stopped

diff --git a/docs/PLUGINS_DEV.md b/docs/PLUGINS_DEV.md
@@ -1,4 +1,4 @@
-## 🌟 Create a custom plugin: Overview
+# Creating a custom plugin
 
 NetAlertX comes with a plugin system to feed events from third-party scripts into the UI and then send notifications, if desired. The highlighted core functionality this plugin system supports, is:
 

diff --git a/docs/SYNOLOGY_GUIDE.md b/docs/SYNOLOGY_GUIDE.md
@@ -35,7 +35,7 @@ services:
   netalertx:
     container_name: netalertx
     # use the below line if you want to test the latest dev image
-    # image: "jokobsk/netalertx-dev:latest" 
+    # image: "ghcr.io/jokob-sk/netalertx-dev:latest" 
     image: "jokobsk/netalertx:latest"      
     network_mode: "host"        
     restart: unless-stopped