diff --git a/docs/UNINSTALL.md b/docs/UNINSTALL.md new file mode 100644 index 00000000..5eb0769c --- /dev/null +++ b/docs/UNINSTALL.md @@ -0,0 +1,60 @@ +# Pi.Alert Uninstallation Guide + +Estimated time: 5' + + +## One-step Automated Uninstall: + +`curl -sSL https://github.com/pucherot/Pi.Alert/raw/main/install/pialert_uninstall.sh | bash` + +## Uninstallation process (step by step) + + +1.1 - Remove Pi.Alert files + ``` + sudo rm -r "~/pialert" + ``` + +1.2 - Remove Pi.Alert web front + ``` + sudo rm "/var/www/html/pialert" + ``` + +1.3 - Remove lighttpd Pi.Alert config + ``` + sudo rm "/etc/lighttpd/conf-available/pialert_front.conf" + sudo rm "/etc/lighttpd/conf-enabled/pialert_front.conf" + ``` + +1.4 - Remove lighttpd Pi.Alert cache + ``` + sudo rm -r /var/cache/lighttpd/compress/pialert + ``` + +1.5 - Remove Pi.Alert DNS entry + ``` + sudo sed -i '/pi.alert/d' /etc/pihole/custom.list + sudo pihole restartdns + ``` + +1.6 - Remove Pi.Alert crontab jobs + ``` + crontab -l 2>/dev/null | sed ':a;N;$!ba;s/#-------------------------------------------------------------------------------\n# Pi.Alert\n# Open Source Network Guard \/ WIFI & LAN intrusion detector \n#\n# pialert.cron - Back module. Crontab jobs\n#-------------------------------------------------------------------------------\n# Puche 2021 pi.alert.application@gmail.com GNU GPLv3\n#-------------------------------------------------------------------------------//g' | crontab - + crontab -l 2>/dev/null | sed '/pialert.py/d' | crontab - + + +### Notes + + - If you installed Pi-hole during the Pi.Alert installation process + Pi-hole will still be available after uninstalling Pi.Alert + + - lighttpd, PHP, arp-scan & Python have not been uninstalled + They may be required by other software + You can uninstall them manually with command 'apt-get remove XX' + +### License + GPL 3.0 + [Read more here](../LICENSE.txt) + +### Contact + pi.alert.application@gmail.com