How hassangar/webguard works
Project type and purpose
• This is a full-stack, modular Django web application named “webguard.”
• Its feature set includes user authentication, dashboards, recon notes, scan engines, scanning orchestration, target management, and reporting—i.e., a platform to manage security scans, view results, and interact with external services (e.g., HackerOne, LLM toolkits).
File structure
• Top-level orchestration:
• Docker and compose files (Dockerfile, docker-compose.yml, docker-compose.dev.yml, docker-compose.setup.yml)
• Nginx config in config/nginx/webguard.conf
• Certificate management (certs/)
• Shell scripts (install.sh, update.sh, scripts/uninstall.sh)
• Core application under web/:
• Django project root: manage.py, webGuard/ (settings, celery config, wsgi, tasks, middleware, utilities)
• Apps: api, dashboard, login, recon_note, scanEngine, startScan, targetApp
• Global static assets and templates in web/static and web/templates
• Requirements pinned in web/requirements.txt
• Asynchronous tasks via Celery (webGuard/celery.py, webGuard/tasks.py, entrypoint scripts in web/).
Supplementary README insights
• Minimal README, but file names signal integration with external tools (HackerOne), background jobs (Celery), and a decoupled front-end (JS widgets, templates).
• Rounded rectangle for containers (Nginx, Django, Celery, DB)
• Interactions:
• “enqueue scan job,” “fetch scan results,” “render dashboard,” “call LLM API.”
Detail without over-fragmentation
• Infrastructure services separately but indicate the Docker network connecting them
• Volumes for persistent storage (certs, DB data, logs)