From a43b2ac81af9b614ccdc4e28110c1b1cc223b02b Mon Sep 17 00:00:00 2001 From: Kshitij Date: Tue, 19 Nov 2024 23:22:15 +0530 Subject: [PATCH] Made several changes to README file. - Changed project name to PiDetectify - Updated description - Added note in description about the project - Changed git clone link - Changed current working directory name - Consistent line spacing - Added horizontal line at the end --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a4f911a..6cb07ab 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ -# IoT Mini Project - 2024 +# PiDetectify -This mini project uses picamera to detect motion, upon detecting motion, it sends notification to devices subscribed to the channel using ntfy.sh +This project utilizes [Raspberry Pi](https://en.wikipedia.org/wiki/Raspberry_Pi) for processing and [Pi Camera](https://www.raspberrypi.com/documentation/accessories/camera.html) to detect motion. Upon detecting motion, it sends a notification to the user via [ntfy.sh](https://ntfy.sh). If the user is not on the same network as the Raspberry Pi, notifications are sent over a VPN using a [WireGuard tunnel](https://www.wireguard.com). Both ntfy and WireGuard run within their own separate [Docker](https://www.docker.com) containers, and everything runs locally. + +> [!NOTE] +> I created this for my college project. I do not plan on adding more features to it. If you encounter any bugs, feel free to create an [issue](https://git.kska.io/notkshitij/PiDetectify/issues/new) (I am more active on [KSKA Git](https://git.kska.io/notkshitij/PiDetectify) than [GitHub](https://github.com/kshitij-ka/PiDetectify).) --- @@ -17,12 +20,12 @@ This mini project uses picamera to detect motion, upon detecting motion, it send 1. Clone this repository: ```shell -git clone https://git.kska.io/notkshitij/iot-mini.git +git clone https://git.kska.io/notkshitij/PiDetectify.git ``` 2. Change current working directory: ```shell -cd ./iot-mini +cd ./PiDetectify ``` 3. Run `setup.sh`: @@ -30,7 +33,6 @@ cd ./iot-mini ./setup.sh ``` - 4. Setup firewall on Raspberry Pi: ```shell sudo apt install -y ufw @@ -47,6 +49,7 @@ sudo systemctl enable ufw ``` 5. Setup Wireguard: + - Generate bcrypt password hash by running: ```shell docker run -it ghcr.io/wg-easy/wg-easy wgpw '' @@ -65,7 +68,6 @@ sudo systemctl enable ufw # Get your public IP by using something like http://ip.me, and paste your public IP there ``` - 8. Create and run the containers: ```shell docker compose up -d @@ -90,3 +92,5 @@ python3 main.py > [!NOTE] > Make sure you're in the directory where you cloned this repo while running all these commands. + +---