notkshitij/PiDetectify
notkshitij/PiDetectify
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

Made several changes to README file.

Browse Source 
- 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
This commit is contained in:
K 2024-11-19 23:22:15 +05:30
parent dd912bba95
commit a43b2ac81a
Signed by: notkshitij
GPG Key ID: C5B8BC7530F8F43F
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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: 1. Clone this repository:
```shell ```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: 2. Change current working directory:
```shell ```shell
cd ./iot-mini cd ./PiDetectify
``` ```
3. Run `setup.sh`: 3. Run `setup.sh`:
@ -30,7 +33,6 @@ cd ./iot-mini
./setup.sh ./setup.sh
``` ```
4. Setup firewall on Raspberry Pi: 4. Setup firewall on Raspberry Pi:
```shell ```shell
sudo apt install -y ufw sudo apt install -y ufw
@ -47,6 +49,7 @@ sudo systemctl enable ufw
``` ```
5. Setup Wireguard: 5. Setup Wireguard:
- Generate bcrypt password hash by running: - Generate bcrypt password hash by running:
```shell ```shell
docker run -it ghcr.io/wg-easy/wg-easy wgpw '<PASSWORD_HERE>' docker run -it ghcr.io/wg-easy/wg-easy wgpw '<PASSWORD_HERE>'
@ -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 # Get your public IP by using something like http://ip.me, and paste your public IP there
``` ```
8. Create and run the containers: 8. Create and run the containers:
```shell ```shell
docker compose up -d docker compose up -d
@ -90,3 +92,5 @@ python3 main.py
> [!NOTE] > [!NOTE]
> Make sure you're in the directory where you cloned this repo while running all these commands. > Make sure you're in the directory where you cloned this repo while running all these commands.
---