nahakubuilder/catchall-webbrowsing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
ghostersk
2024-03-29 13:02:59 +00:00
committed by GitHub
parent 58d6218bc2
commit 334a3e533d
1 changed files with 29 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -1,2 +1,31 @@
# catchall-webbrowsing
Flask app for catching web requests and recording them
I have created this app to redirect all blocked DNS queries from Adguard Home, to the ip of docker container.
The app will record what website was used, and it will also return information the website was blocked.
- default Adguard Home behaviour is to return non existent response, if you do not pay attention, you may miss that it was your DNS filter.
It will listen on port 80 and 443, 443 port need certificate, i have added script to create certificate with CA signing.
If you need, you can add the CA certificate to trusted certificates for easier use ( will work only on the IP, unless you make it for all hostnames)
The application is started by using `startup.sh`
```
#!/bin/bash
pip install -r requirements.txt
export FLASK_RUN_EXTRA_FILES="startup.sh"
export FLASK_DEBUG=True
export FLASK_RUN_HOST="0.0.0.0"
export FLASK_RUN_PORT=80
flask run & python app.py
```
This will first run the app on port 80 and all interfaces and last command it will run on the port 443 as per the `app.py` code
This app is using [Interactive Bootstrap 5 DataTables](https://www.datatables.net/) for easier data lookup.
![Screenshot_20240329_125226](https://github.com/ghostersk/catchall-webbrowsing/assets/68815071/c7fdccff-c270-4662-9ae5-106693729cf4)
## List all blocked attempts
![Screenshot_20240329_125250](https://github.com/ghostersk/catchall-webbrowsing/assets/68815071/9e9d7987-0e80-48cf-a9f3-8d134c70d904)
You can deploy it with docker-compose, as per the docker-compose.yml example
I am using static IP address of the catchall container to send all blocked queries there from [Adguard Home in DNS Settings](https://adguard.com/kb/adguard-for-ios/solving-problems/low-level-settings/#:~:text=Blocking%20mode%E2%80%8B,REFUSED%20%E2%80%94%20respond%20with%20REFUSED%20code):
![Screenshot_20240329_125519](https://github.com/ghostersk/catchall-webbrowsing/assets/68815071/8a291a09-9f7c-4bdb-8b23-374c51e320d7)