Skip to content

Home

Jump to bottom
Lucky edited this page Dec 26, 2025 · 1 revision

📘 WebFox Wiki

Welcome to the WebFox Documentation Wiki. This wiki explains installation, usage, CLI, GUI, reports, and best practices for WebFox.

🦊 About WebFox

WebFox is an automated web reconnaissance and scanning framework designed for:

Ethical Hackers

Bug Bounty Hunters

Penetration Testers

Cybersecurity Students

It supports both:

CLI (Command Line Interface)

GUI (Graphical User Interface)

WebFox helps in scanning target domains, collecting information, generating reports, and saving snapshots.

📦 Requirements

Before installing WebFox, ensure the following:

Python 3.8+

Git

Linux / Kali / Ubuntu / Termux

Internet connection

🛠️ Installation Guide

Follow the steps one by one.

Step 1: Clone Repository

git clone https://github.com/lucky-om/WebFox.git

Step 2: Enter Directory

cd WebFox

Step 3: Give Permissions

chmod +x *

Step 4: Install Dependencies

./install.sh

✔ All required packages will be installed automatically.

▶️ CLI Usage

Start Scan

python3 test.py example.com -scan

🔁 Replace example.com with your target domain.

What CLI Does

Starts domain scan

Collects useful data

Saves output automatically

Generates reports

🖥️ GUI Usage (Streamlit)

WebFox also provides a Graphical Interface for easy usage.

Launch GUI

streamlit run gui.py

Then open the URL shown in terminal (usually http://localhost:8501).

GUI Features

Simple input field

One‑click scanning

Visual output

Beginner‑friendly design

📂 Reports & Output

After scan completion, results are stored in:

WebFox/report/

Report Folder Contains

Scan output files

Domain data

Screenshots / snapshots

Organized scan reports

📸 Screenshots

CLI Screenshot

screenshots/cli.png

GUI Screenshot

screenshots/gui.png

Recommended structure:

WebFox/ ├── screenshots/ │ ├── cli.png │ └── gui.png

⚠️ Disclaimer

WebFox is intended only for educational and authorized security testing.

❌ Do NOT scan domains without permission

❌ Unauthorized use is illegal

✅ Use only on assets you own or are authorized to test

The developer is not responsible for misuse.

🧠 Best Practices

Always get written permission

Use WebFox in legal environments

Combine with manual analysis

Keep tool updated

❓ FAQ

Q: Is WebFox free?

✅ Yes, it is open‑source.

Q: Can I use it on any website?

❌ No. Only on authorized domains.

Q: Does it work on Termux?

✅ Yes, with Python installed.

🤝 Contributing

Want to contribute?

  1. Fork the repository

  2. Create a new branch

  3. Commit your changes

  4. Submit a Pull Request

👤 Author

Lucky Patel GitHub: https://github.com/lucky-om

📜 License

WebFox is licensed under the MIT License.

🧩 Recommended Wiki Pages (Create Separately)

You can split this into pages like:

Home

Installation

CLI Usage

GUI Usage

Reports

Screenshots

Disclaimer

FAQ

Clone this wiki locally