docs/DEPLOYMENT.md

🚀 Deployment Guide - Sentinel Scam Honeypot

Option 1: Hugging Face Spaces (Recommended for GUVI)

This method gives you a Live URL to share with judges.

1. Create New Space:

   • Go to huggingface.co/spaces
   • Click "Create new Space"
   • Name: sentinel-honeypot
   • SDK: Docker (Select "Blank" template)
   • Public/Private: Public

2. Upload Code:

   • Upload the entire project folder to the Space.
   • Ensure Dockerfile is in the root.

3. Set Secrets (Environment Variables):

   • Go to Settings > Variables and secrets
   • Add OPENAI_API_KEY: sk-...
   • Add GUVI_API_KEY: GUVI_HACKATHON_V2 (or your chosen key)

4. Wait for Build:

   • The space will build (takes ~3 mins).
   • Once "Running", your API is live at https://huggingface.co/spaces/YOUR_USERNAME/sentinel-honeypot

---

Option 2: Local Docker

Run completely offline or for testing.

# Build Image
docker build -t sentinel-honeypot .

# Run Container (Port 7860 for HF compatibility)
docker run -p 7860:7860 \
  -e OPENAI_API_KEY="sk-..." \
  sentinel-honeypot

---

Option 3: Manual Run (Dev Mode)

# Install Deps
pip install -r requirements.txt

# Run API
uvicorn app.main:app --reload --port 8000

# Run Dashboard (Separate Terminal)
streamlit run dashboard.py