https://github.com/shahradelahi/telegram-supasec-bot
A virus scanner bot for Telegram utilizing the VirusTotal API.
https://github.com/shahradelahi/telegram-supasec-bot
bot scanner telegram virustotal
Last synced: 3 months ago
JSON representation
A virus scanner bot for Telegram utilizing the VirusTotal API.
- Host: GitHub
- URL: https://github.com/shahradelahi/telegram-supasec-bot
- Owner: shahradelahi
- License: gpl-3.0
- Created: 2024-02-21T13:24:05.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-13T23:52:51.000Z (over 1 year ago)
- Last Synced: 2024-04-14T13:12:35.801Z (over 1 year ago)
- Topics: bot, scanner, telegram, virustotal
- Language: TypeScript
- Homepage: https://t.me/supasecbot
- Size: 634 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Supasec Bot
> Checkout the [Supasec Bot](https://t.me/supasecbot) on the Telegram.
This is a virus scanner bot for the Telegram. It uses the [VirusTotal API](https://www.virustotal.com/en/documentation/public-api/) to scan files for viruses.
## ⚙️ Build
This project uses Docker to build and start the app. Follow the instructions below to build the app and start it locally.
### Pre-requisites
- [Docker](https://docs.docker.com/engine/install/)
- [Make](https://www.gnu.org/software/make/)
### Build
```bash
$ make build
```
## 🚀 Start
### Database
The bot uses the `Postgres` database to store the user's data. You use the following command to get an instance on the Docker.
```bash
docker run -d \
--name supasec-db
-e POSTGRES_PASSWORD=super-secret-password \
-e POSTGRES_DB=supasec \
-p 5432:5432 \
postgres:alpine
```
### Bot
```bash
docker run -d \
--name supasec-bot \
-e TG_TOKEN=your-telegram-bot-token \
-e VT_API_KEY=your-virustotal-api-key \
-e DATABASE_URL="postgres://postgres:super-secret-password@localhost:5432/supasec?schema=private" \
shahradel/supasec:dev
```
### Environment Variables
Checkout [the `.env.example`](.env.example) file to see the environment variables that you need to set.
## License
[GPL-3.0](/LICENSE) © [Shahrad Elahi](https://github.com/shahradelahi)