From 42aa89971d8bfa93799857c04bdf598aab7ed896 Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Sun, 2 Apr 2023 12:31:24 +1000 Subject: [PATCH] Update README --- dockerfiles/README.md | 6 +++--- docs/NETWORK_TREE.md | 15 +++++++++++++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/dockerfiles/README.md b/dockerfiles/README.md index e199701b..daf03607 100755 --- a/dockerfiles/README.md +++ b/dockerfiles/README.md @@ -53,8 +53,8 @@ docker run -d --rm --network=host \ ### Config (`pialert.conf`) -- If unavailable, the app generates a default `pialert.conf` and `pialert.db` file om teh first run. -- The preferred way is to manage the configuration via Settings in the UI. +- If unavailable, the app generates a default `pialert.conf` and `pialert.db` file on the first run. +- The preferred way is to manage the configuration via the Settings section in the UI. - You can modify [pialert.conf](https://github.com/jokob-sk/Pi.Alert/tree/main/config) directly, if needed. #### Important settings @@ -76,7 +76,7 @@ These are the most important settings to get at least some output in your Device * `PIHOLE_ACTIVE`: You need to map `:/etc/pihole/pihole-FTL.db in the docker-compose.yml` file if you enable this setting. * `DHCP_ACTIVE` : You need to map `:/etc/pihole/dhcp.leases in the docker-compose.yml` file if you enable this setting. -### 🛑 **Common issues** +### **Common issues** 💡 Before creating a new issue, please check if a similar issue was [already resolved](https://github.com/jokob-sk/Pi.Alert/issues?q=is%3Aissue+is%3Aclosed). diff --git a/docs/NETWORK_TREE.md b/docs/NETWORK_TREE.md index d760b2f4..0d23d49c 100755 --- a/docs/NETWORK_TREE.md +++ b/docs/NETWORK_TREE.md @@ -1,8 +1,19 @@ ## How to setup your Network page -Make sure you have a root device with the MAC `Internet` (No other MAC addresses are currently support as root) +Make sure you have a root device with the MAC `Internet` (No other MAC addresses are currently supported as the root node). -To setup a device named `rapberrypi` as a `Switch` in our network. +## ⚡Quick setup: + +* Go to Devices > Device Details. +* Find the device(s) you want to use as network devices (network nodes). +* Set the Type of such a device to one of the following: AP, Firewall, Gateway, PLC, Powerline, Router, Switch, USB LAN Adapter, USB WIFI Adapter and WLAN. +* Save and go to Network where the devices you've marked as network devices (by selecting the Type as mentioned above) will show up as tabs. +* You can now assign the Unassigend devices to the correct network node. + + +## 🔍Detailed example: + +In this example you will setup a device named `rapberrypi` as a `Switch` in our network. ### 1) Device details page