Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 2.67 KB

NetAlertX-install.md

File metadata and controls

68 lines (48 loc) · 2.67 KB
Raw

NetAlertX is a really cool network monitoring tool. The Homepage widget can notify you of any new devices that just joined your network or of important devices that have gone offline.

{B17D286D-559B-4625-85BB-DAC17573AC31}

Create Datasets

Create a dataset called NetAlertX_Stuff, and create three child datasets called NX_Config, NX_DB, and NX_Log.

{7230D7B7-8C9C-4F0E-8B4A-4B7E5A4F2364}

Select the NetAlertX_Stuff folder and edit the permissions. Under Owner select the User dropdown, search for and select www-data. Do the same for the Group dropdown. Check the boxes for Apply User Apply group Apply permissions recursively and Apply permissions to child datasets. On the right side of the menu check all the boxes.

image

Now hit Save

Install App

Go to the Apps, click Discover Apps, then click the three dots menu next to the Custom App button, then click Install via YAML.

In the Name field enter NetAlertX.

Then paste the following code into the Custom Config box.

version: "3"
services:
  netalertx:
    container_name: netalertx
    image: "jokobsk/netalertx:latest"      
    network_mode: "host"        
    restart: unless-stopped
    volumes:
      - /mnt/your-pool-name/NetAlertX/NX_Config:/app/config
      - /mnt/your-pool-name/NetAlertX/NX_DB:/app/db      
      - /mnt/your-pool-name/NetAlertX/NX_Log:/app/front/log
    environment:
      - TZ=Country/City      
      - PORT=20211

{0F7BAD42-D529-4F2E-ABC9-DE94ADEC93A1}

Ensure you replace /your-pool-name/ and Country/City with the correct information.

Now click Save

The app should deploy. Once it is running enter http://your-server-ip:20211 into your browser.

Other Notes

Now it's time to learn how to configure NetAlertX! I found this YouTube video very helpful for the initial basic configuration.

https://youtu.be/umh1c_40HW8?feature=shared&t=164

And don't forget to read the official documentation!

https://github.com/jokob-sk/NetAlertX/blob/main/docs/README.md

And this is the code I have in my services.yaml for my NetAlertX widget you saw at the top of this page.

    - NetAlertX:
        icon: netalertx.png
        href: http://server-ip-address:20211
        siteMonitor: http://server-ip-address:20211
        statusStyle: dot
        widget:
          type: netalertx
          url: http://server-ip-address:20211