Configuration

⚙️ Configuration

This page describes how to configure the VirusTotal File Scanner for your specific use case using the config.py file or .env variables.

---

🔑 API Key Setup

To use the VirusTotal API, an API key is required. You can obtain a free key by registering at VirusTotal.

Option 1 – Use .env file

Create a .env file in the project root:

VT_API_KEY=your-api-key-here

Option 2 – Use config.py

Edit the following section in config.py:

VT_API_KEY = "your-api-key-here"

---

🌍 Language Settings

The GUI supports multiple languages. Set your language in config.py:

LANGUAGE = "en"  # or "de"

Supported values:

• en – English
• de – German

---

🔐 Security Settings

Enable or disable hash-only mode (no file upload to VirusTotal):

HASH_ONLY_MODE = True

If set to True, only the hash of the file will be submitted. The actual file will not be uploaded.

---

🧾 Export Configuration

Define how and where exported results should be saved:

EXPORT_FORMAT = "json"  # or "csv"
EXPORT_DIRECTORY = "./exports"

---

📜 Logging Options

Control whether scan logs are saved:

ENABLE_LOGGING = True
LOG_FILE = "scanner.log"

If enabled, all scan events will be logged with timestamps.

---

🎨 UI Preferences

Define theme (if supported by GUI library):

THEME = "dark"  # or "light", "high_contrast"

---

💡 Example config.py

VT_API_KEY = "abc123"
LANGUAGE = "en"
HASH_ONLY_MODE = True
EXPORT_FORMAT = "csv"
EXPORT_DIRECTORY = "./exports"
ENABLE_LOGGING = True
LOG_FILE = "scanner.log"
THEME = "dark"

---

🛠 Notes

• Any invalid or missing settings will fall back to defaults
• If both .env and config.py are present, config.py takes precedence
• Avoid committing real API keys to GitHub