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

Update INSTALL.md

Browse Source
This commit is contained in:
pucherot
2021-01-09 02:55:52 +01:00
committed by GitHub
parent c2e9f33b2a
commit 92b6ef97f8
1 changed files with 38 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
doc/INSTALL.md
View File

@@ -19,19 +19,23 @@ Linux distributions.
<!--- --------------------------------------------------------------------- ---> <!--- --------------------------------------------------------------------- --->
1 - Install 'Raspberry Pi OS' 1 - Install 'Raspberry Pi OS'
- Instructions https://www.raspberrypi.org/documentation/installation/installing-images/ - Instructions https://www.raspberrypi.org/documentation/installation/installing-images/
- Lite version (without Descktop) is enough for Pi.Alert - *Lite version (without Descktop) is enough for Pi.Alert*
2 -Activate ssh 2 - Activate ssh
- Create a empty 'ssh' file in the boot partition of the SD - Create a empty file with name 'ssh' in the boot partition of the SD
3 - Start the raspberry 3 - Start the raspberry
4 - Login to the system with pi user 4 - Login to the system with pi user
- user: pi ```
- password: raspberry user: pi
password: raspberry
```
5 - Change de default password 5 - Change de default password of pi user
- passwd ```
passwd
```
6 - Setup the basic configuration 6 - Setup the basic configuration
``` ```
@@ -60,8 +64,8 @@ Linux distributions.
``` ```
curl -sSL https://install.pi-hole.net | bash curl -sSL https://install.pi-hole.net | bash
``` ```
- Select "Install web admin interface" - Mark "Install web admin interface"
- Select "Install web server lighttpd" - Mark "Install web server lighttpd"
4 - Configure Pi-hole admin password 4 - Configure Pi-hole admin password
``` ```
@@ -70,7 +74,7 @@ Linux distributions.
5 - Connect to web admin panel 5 - Connect to web admin panel
- http://192.168.1.x/admin/ - http://192.168.1.x/admin/
- (replace the 192.168.1.x with your Raspberry IP) - (*replace the 192.168.1.x with your Raspberry IP*)
6 - Activate DHCP server 6 - Activate DHCP server
- Pi-hole -> Settings -> DHCP -> Mark "DHCP server enabled" - Pi-hole -> Settings -> DHCP -> Mark "DHCP server enabled"
@@ -78,12 +82,11 @@ Linux distributions.
7 - Add pi.alert DNS Record 7 - Add pi.alert DNS Record
- Pi-hole -> Local DNS -> DNS Records -> Add new domain /IP - Pi-hole -> Local DNS -> DNS Records -> Add new domain /IP
- pi.alert 192.168.1.x - pi.alert 192.168.1.x
- (replace the 192.168.1.x with your Raspberry IP) - (*replace the 192.168.1.x with your Raspberry IP*)
8 - Deactivate your current DHCP Server 8 - Deactivate your current DHCP Server (*Normaly at your router or AP*)
- Normaly at your router or AP
9 - Renew your computer IP to unsure you are using new DHCP Server and DNS 9 - Renew your computer IP to unsure you are using the new DHCP and DNS server
- Windows: cmd -> ipconfig /renew - Windows: cmd -> ipconfig /renew
- Linux: shell -> sudo dhclient -r; sudo dhclient - Linux: shell -> sudo dhclient -r; sudo dhclient
- Mac: Apple menu -> System Preferences -> Network -> select the network -> Advanced -> TCP/IP -> Renew DHCP Lease - Mac: Apple menu -> System Preferences -> Network -> select the network -> Advanced -> TCP/IP -> Renew DHCP Lease
@@ -111,20 +114,20 @@ Linux distributions.
<!--- --------------------------------------------------------------------- ---> <!--- --------------------------------------------------------------------- --->
1- Download Pi.Alert and uncmompress 1- Download Pi.Alert and uncmompress
``` ```
curl -LO https://github.com/pucherot/Pi.Alert/raw/main/install/pialert_latest.tar curl -LO https://github.com/pucherot/Pi.Alert/raw/main/install/pialert_latest.tar
tar xvf pialert_latest.tar tar xvf pialert_latest.tar
rm pialert_latest.tar rm pialert_latest.tar
``` ```
2 - Public the front portal 2 - Public the front portal
``` ```
sudo ln -s /home/pi/pialert/front /var/www/html/pialert sudo ln -s /home/pi/pialert/front /var/www/html/pialert
``` ```
3 - Update lighttp config 3 - Update lighttp config
``` ```
sudo sh -c "printf '\n\n\$HTTP[\"host\"] == \"pi.alert\" {\n server.document-root = \"/var/www/html/pialert/\"\n}\n' >> /etc/lighttpd/external.conf" sudo sh -c "printf '\n\n\$HTTP[\"host\"] == \"pi.alert\" {\n server.document-root = \"/var/www/html/pialert/\"\n}\n' >> /etc/lighttpd/external.conf"
sudo /etc/init.d/lighttpd restart sudo /etc/init.d/lighttpd restart
``` ```
4 - If you want to use email reporting with gmail 4 - If you want to use email reporting with gmail
@@ -135,29 +138,29 @@ Linux distributions.
5 - Config Pialert parameters 5 - Config Pialert parameters
``` ```
nano ~/pialert/back/pialert.conf nano ~/pialert/back/pialert.conf
``` ```
- if you want to use email reporting, configure this parameters - if you want to use email reporting, configure this parameters
``` ```
REPORT_MAIL = True REPORT_MAIL = True
SMTP_USER = 'user@gmail.com' SMTP_USER = 'user@gmail.com'
SMTP_PASS = 'password' SMTP_PASS = 'password'
REPORT_TO = 'user@gmail.com' REPORT_TO = 'user@gmail.com'
``` ```
- if you want to update yout Dynamic DNS, configure this parameters - if you want to update yout Dynamic DNS, configure this parameters
``` ```
DDNS_ACTIVE = True DDNS_ACTIVE = True
DDNS_DOMAIN = 'your_domain.freeddns.org' DDNS_DOMAIN = 'your_domain.freeddns.org'
DDNS_USER = 'dynu_user' DDNS_USER = 'dynu_user'
DDNS_PASSWORD = 'A0000000B0000000C0000000D0000000' DDNS_PASSWORD = 'A0000000B0000000C0000000D0000000'
DDNS_UPDATE_URL = 'https://api.dynu.com/nic/update?' DDNS_UPDATE_URL = 'https://api.dynu.com/nic/update?'
``` ```
- if you have installed Pi.hole and DHCP, activate this parameters - if you have installed Pi.hole and DHCP, activate this parameters
``` ```
PIHOLE_ACTIVE = True PIHOLE_ACTIVE = True
DHCP_ACTIVE = True DHCP_ACTIVE = True
``` ```
6 - Update vendors DB 6 - Update vendors DB
@@ -176,6 +179,9 @@ Linux distributions.
(crontab -l 2>/dev/null; cat ~/pialert/back/pialert.cron) | crontab - (crontab -l 2>/dev/null; cat ~/pialert/back/pialert.cron) | crontab -
``` ```
9 - Use admin panel to configure the devices
- http://pi.akert/
### License ### License
GPL 3.0 GPL 3.0
[Read more here](LICENSE.txt) [Read more here](LICENSE.txt)