https://github.com/sigseg5/nometa-tg
This is a Python Telegram bot that provides an opportunity to automatically delete all metadata from photo and apply Fawkes tool to hide you face from face recognition apps in social networks etc.
https://github.com/sigseg5/nometa-tg
face-recognition metadata-remove privacy-enhancing-technologies privacy-protection python-telegram-bot
Last synced: 6 months ago
JSON representation
This is a Python Telegram bot that provides an opportunity to automatically delete all metadata from photo and apply Fawkes tool to hide you face from face recognition apps in social networks etc.
- Host: GitHub
- URL: https://github.com/sigseg5/nometa-tg
- Owner: sigseg5
- License: mit
- Created: 2020-11-13T08:56:54.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-12-31T12:40:42.000Z (almost 2 years ago)
- Last Synced: 2025-04-11T17:19:53.995Z (6 months ago)
- Topics: face-recognition, metadata-remove, privacy-enhancing-technologies, privacy-protection, python-telegram-bot
- Language: Python
- Homepage:
- Size: 102 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# nometa-tg
This is a Python Telegram bot that provides an opportunity to automatically delete all metadata from photo and apply [Fawkes](https://github.com/Shawn-Shan/fawkes) tool to hide you face from face recognition apps in social networks etc.
## Info
By default, this bot automatically remove all metadata from photos and apply Fawkes at a minimal mode. You can specify Fawkes settings (`FAWKES_MODE`) in `.env` file.
At this release you can send a photo as photo or document.You will get message if tool can't find any faces.
In future release will be implemented settings manager, and may be video processing.
However, you can find full information about Fawkes tool at [GitHub](https://github.com/Shawn-Shan/fawkes), and [this](https://www.shawnshan.com/files/publication/fawkes.pdf) academic paper
## Requirements
* Telegram account
* (Recommended) Installed [Docker](https://www.docker.com/)
## Usage
### Choosing `FAWKES_MODE`
FAWKES_MODE the tradeoff between privacy and perturbation size. Select from `low`, `mid`, `high`. The higher the mode is, the more perturbation will add to the image and provide stronger protection.
Feel free to play with mods and choose that mostly suits you
In the image below you can see an example of how the Fawkes tool works (photo from the Fawkes GitHub page, deprecated).
### Run in Docker
* Add TOKEN to .env file. You can get token from [BotFather](https://www.t.me/BotFather) at Telegram
* Run `docker build --tag nometa-tg .` for build image
* Run `docker run --env-file .env nometa-tg` to start or `sudo docker run -d --restart unless-stopped --env-file .env nometa-tg` if you want automatically starts container after server reboot
Note: Maybe you should add `sudo` before all Docker-assigned commands
### Run locally
Theoretically should work with Python 3.7, can't test it yet.
I can't guaranty that this will be works, please use Docker
* Create `images` and `documents` folder in project folder
* Add `TOKEN` and `FAWKES_MODE` environment variables to your IDE config e.g. PyCharm. You can get token from [BotFather](https://www.t.me/BotFather) at Telegram. For first run you can set `FAWKES_MODE=min`
E.g. ENV_VAR: `PYTHONUNBUFFERED=1;TOKEN=1234567890:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx;FAWKES_MODE=min`
* Run `pip install -r requirements.txt` to install dependencies
* Run `bot.py` to start
## Docker control
### Stop container
* Run `docker stats` to view all running containers
* Run `docker kill `
### Remove image
* Run `docker images` to view list of all images
* Run `docker rmi -f `
## Contribute
Any ideas or trouble? Please open [issue](https://github.com/sigseg5/nometa-tg/issues)
or [pull request](https://github.com/sigseg5/nometa-tg/pulls)
## Communicate
Feel free to write me at [Telegram](https://t.me/kirill_nk)