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 📚

Browse Source
This commit is contained in:
Jokob-sk
2024-02-13 07:43:47 +11:00
parent e99d26b044
commit daa03e106b
3 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
dockerfiles/README.md
View File

@@ -46,14 +46,15 @@ docker run -d --rm --network=host \
### Docker paths ### Docker paths
| Required | Path | Description | | Required | Path | Description |
| :------------- | :------------- |:-------------| | :------------- | :------------- | :-------------|
| ✅ | `:/home/pi/pialert/config` | Folder which will contain the `pialert.conf` file (see below for details) | | ✅ | `:/home/pi/pialert/config` | Folder which will contain the `pialert.conf` file (see below for details) |
| ✅ | `:/home/pi/pialert/db` | Folder which will contain the `pialert.db` file | | ✅ | `:/home/pi/pialert/db` | Folder which will contain the `pialert.db` file |
| | `:/home/pi/pialert/front/log` | Logs folder useful for debugging if you have issues setting up the container | | | `:/home/pi/pialert/front/log` | Logs folder useful for debugging if you have issues setting up the container |
| | `:/etc/pihole/pihole-FTL.db` | PiHole's `pihole-FTL.db` database file. Required if you want to use PiHole | | | `:/etc/pihole/pihole-FTL.db` | PiHole's `pihole-FTL.db` database file. Required if you want to use PiHole |
| | `:/etc/pihole/dhcp.leases` | PiHole's `dhcp.leases` file. Required if you want to use PiHole `dhcp.leases` file. This has to be matched with a corresponding `DHCPLSS_paths_to_check` setting entry. (the path in the container must contain `pihole`)| | | `:/etc/pihole/dhcp.leases` | PiHole's `dhcp.leases` file. Required if you want to use PiHole `dhcp.leases` file. This has to be matched with a corresponding `DHCPLSS_paths_to_check` setting entry (the path in the container must contain `pihole`)|
| | `:/home/pi/pialert/front/api` | A simple [API endpoint](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/API.md) containing static (but regularly updated) json and other files. | | | `:/home/pi/pialert/front/api` | A simple [API endpoint](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/API.md) containing static (but regularly updated) json and other files. |
| | `:/home/pi/pialert/front/plugins/<plugin>/ignore_plugin` | Map a file `ignore_plugin` to ignore a plugin. Plugins can be soft-disabled via settings. More in the [Plugin docs](/front/plugins/README.md). | | | `:/home/pi/pialert/front/plugins/<plugin>/ignore_plugin` | Map a file `ignore_plugin` to ignore a plugin. Plugins can be soft-disabled via settings. More in the [Plugin docs](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/README.md). |
| | `:/etc/resolv.conf` | Use a custom `resolv.conf` file for [better name resolution](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/REVERSE_DNS.md). |
### Modify the config (`pialert.conf`) only if UI is not available ### Modify the config (`pialert.conf`) only if UI is not available

2
dockerfiles/start.sh
View File

@@ -148,7 +148,7 @@ fi
# Activate the virtual python environment # Activate the virtual python environment
source myenv/bin/activate source myenv/bin/activate
echo "[INSTALL] 🚀 Starting app - navigate to your <server IP>:$LISTEN_ADDR" echo "[INSTALL] 🚀 Starting app - navigate to your <server IP>:$PORT"
# Start the PiAlert python script # Start the PiAlert python script
python $INSTALL_DIR/pialert/pialert/ python $INSTALL_DIR/pialert/pialert/

2
docs/REVERSE_DNS.md
View File

@@ -28,7 +28,7 @@ If you are running a DNS server, such as AdGuard, set up **Private reverse DNS s
### Using a custom resolv.conf file ### Using a custom resolv.conf file
You can configure a custom /etc/resolv.conf file in the docker-compose.yml and set the DNS server of your LAN DNS server (e.g.: Pi-Hole) as the nameserver. You can configure a custom **/etc/resolv.conf** file in **docker-compose.yml** and set the nameserver to your LAN DNS server (e.g.: Pi-Hole).
#### docker-compose.yml: #### docker-compose.yml: