Hugging Face's logo

Spaces:
S-Dreamer
/
CyberForge
Running

App Files Community
CyberForge / README.md
S-Dreamer's picture
S-Dreamer
Update README.md
980e40c verified
preview code
|
raw
history blame contribute delete
2.96 kB
metadata
title: CyberForge
emoji: 🐢
colorFrom: purple
colorTo: indigo
sdk: streamlit
sdk_version: 1.44.1
app_file: app.py
pinned: false
license: apache-2.0

CyberForge Dashboard

A comprehensive dark web intelligence platform for monitoring, analyzing, and visualizing potential threats and data breaches.

Features

Core Functionality

  • Dark web content monitoring and scraping
  • Threat intelligence dashboard with visualization
  • Indicator of compromise (IOC) tracking
  • Alerting system for detected threats
  • Reporting and analytics

Enhanced Security Features

  • OSINT Integration: Correlates dark web data with intelligence from VirusTotal and AlienVault OTX
  • API Security: JWT tokens, API keys, rate limiting, and role-based access controls
  • Data Privacy: PII detection and masking to protect sensitive information

Technical Stack

  • Backend: FastAPI, SQLAlchemy, Async PostgreSQL
  • Frontend: Streamlit
  • Database: PostgreSQL
  • Integration: Support for external OSINT feeds and Tor proxying
  • Security: JWT authentication, API key management, data masking

Getting Started

Prerequisites

  • Python 3.9+
  • PostgreSQL

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/cyberforge-dashboard.git
cd cyberforge-dashboard
  1. Install dependencies:
pip install -r requirements_hf.txt
  1. Set up environment variables:
DATABASE_URL=postgresql://user:password@localhost/cyberforge
JWT_SECRET_KEY=your_secret_key
  1. Run the application:
streamlit run app.py

Deployment to Hugging Face Spaces

This project is configured for automatic deployment to Hugging Face Spaces using GitHub Actions.

Setup Instructions:

  1. Create a new Hugging Face Space:

    • Go to Hugging Face Spaces
    • Click "Create Space"
    • Select "Streamlit" as the SDK
    • Fill in the space name and other details

  2. Add the following secrets to your GitHub repository:

    • HF_TOKEN: Your Hugging Face API token (from Hugging Face settings)
    • HF_USERNAME: Your Hugging Face username
    • HF_SPACE_NAME: The name of your Hugging Face Space

  3. Push to your GitHub repository's main branch, and the GitHub Actions workflow will automatically deploy to your Hugging Face Space.

The deployment process copies the necessary files (with Hugging Face-specific configurations) to your Space, ensuring the application runs in demo mode on Hugging Face.

API Documentation

The API provides endpoints for:

  • Authentication and user management
  • Threat intelligence submission and retrieval
  • Dark web content scraping and analysis
  • Alerts and notifications

API documentation is available at /docs when running the API server.

License

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

Built with ❤️ by [Canstralian]