vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 01:26:11 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs, MQTT, GH Actions

Browse Source
This commit is contained in:
jokob-sk
2025-03-01 10:06:32 +11:00
parent bf3d497d26
commit 4b0c7f2c01
8 changed files with 12 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/DEBUG_TIPS.md
View File

@@ -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!

6
docs/DOCKER_COMPOSE.md
View File

@@ -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

8
docs/MIGRATION.md
View File

@@ -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

2
docs/PERFORMANCE.md
View File

@@ -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

2
docs/PLUGINS_DEV.md
View File

@@ -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:

2
docs/SYNOLOGY_GUIDE.md
View File

@@ -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