Skip to content

A goto tool for Threat Analysts watching over domain information for finding patterns

License

Notifications You must be signed in to change notification settings

thebitdoodler/DomainSentry

Repository files navigation

DomainSentry Logo

DomainSentry - The Ultimate WHOIS Extractor

Python Versions GitHub release (latest by date) License GitHub issues GitHub stars Code style: black Contributions welcome

DomainSentry is a powerful and flexible tool designed to perform WHOIS lookups on a list of domains or URLs. It supports both a command-line interface (CLI) for system-level operation and a web-based interface using Streamlit, which can be easily deployed using Docker.

🚀 Features

  • 🔍 Extract domains from URLs
  • 📊 Perform bulk WHOIS lookups
  • 📁 Output results to terminal or CSV
  • 🖥️ CLI for system-level operation
  • 🐳 Docker support for easy deployment of the web interface
  • 🌐 Web interface using Streamlit

📋 Table of Contents

🔧 Installation

Using pip (for CLI)

pip install domainsentry

Using Docker (for Streamlit web interface)

docker pull thebitdoodler/domainsentry

🖥️ Usage

CLI Usage

The CLI version runs directly on your system:

# Output to terminal
domainsentry input_file.txt

# Output to CSV
domainsentry input_file.txt -o csv -f output.csv

Streamlit Web Interface

Running Locally

If you want to run the Streamlit interface locally without Docker:

streamlit run domainsentry/streamlit_app.py

Using Docker

To run the Streamlit interface using Docker:

docker run -p 8501:8501 thebitdoodler/domainsentry

Then open your web browser and navigate to http://localhost:8501.

Development

  1. Clone the repository:

    git clone https://github.com/thebitdoodler/domainsentry.git
    cd domainsentry
  2. Create a virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
  3. Install dependencies:

    pip install -r requirements.txt
  4. Run tests:

    pytest tests/

Contributing

We welcome contributions to DomainSentry! Please see our Contributing Guide for more details on how to get started.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

📞 Contact

For questions and support, please open an issue on the GitHub repository.

About

A goto tool for Threat Analysts watching over domain information for finding patterns

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published