Skip to content

README.md

Latest commit

 

History

History
133 lines (100 loc) · 3.74 KB

README.md

File metadata and controls

133 lines (100 loc) · 3.74 KB

PentestGPT Website

Professional academic-style website for PentestGPT - an LLM-empowered automated penetration testing framework.

🚀 Quick Local Preview

# Navigate to the project directory
cd pentestgpt_website

# Using Python 3 (most common)
python3 -m http.server 8000

# Or using Python 2
python -m SimpleHTTPServer 8000

# Or using Node.js http-server (if installed)
npx http-server

# Or using PHP
php -S localhost:8000

Then open your browser and go to: http://localhost:8000

📁 Project Structure

pentestgpt_website/
├── index.html              # Landing page
├── paper.html              # USENIX 2024 paper details
├── team.html               # Team introduction
├── research.html           # Research foundation & agentic upgrade
├── waitlist.html           # Email waitlist signup
├── assets/
│   ├── css/
│   │   ├── style.css       # Main styles
│   │   └── terminal.css    # Terminal/hacker aesthetic
│   └── js/
│       └── main.js         # Interactions & animations
└── README.md               # This file

🌐 GitHub Pages Deployment

  1. Create GitHub Repository:

    • Create a new repository on GitHub
    • Name it as you prefer (e.g., pentestgpt-site or your-username.github.io for user page)

  2. Push Code:

    git init
git add .
git commit -m "Initial commit"
git remote add origin https://github.com/YOUR_USERNAME/YOUR_REPO.git
git push -u origin main

  3. Enable GitHub Pages:

    • Go to Settings → Pages
    • Source: Deploy from branch
    • Branch: main (or master)
    • Folder: / (root)
    • Click Save

  4. Custom Domain Setup (pentestgpt.com):

    In GitHub:

    • After enabling Pages, add custom domain: pentestgpt.com
    • This will create a CNAME file automatically

    In Your Domain Provider (DNS Settings):

    # For apex domain (pentestgpt.com)
A     @     185.199.108.153
A     @     185.199.109.153
A     @     185.199.110.153
A     @     185.199.111.153

# For www subdomain
CNAME www   YOUR_USERNAME.github.io.

  5. Wait for Propagation:

    • DNS changes may take up to 48 hours
    • GitHub Pages HTTPS certificate generation takes ~1 hour
    • Once ready, enforce HTTPS in Settings → Pages

🎨 Features

  • Terminal/Hacker Aesthetic: Monospace fonts, green-on-black terminal style
  • Responsive Design: Works on desktop and mobile devices
  • Interactive Elements: Typing animations, hover effects, form validation
  • No Dependencies: Pure HTML/CSS/JS for maximum performance
  • Privacy-Focused: No external tracking, local form storage for demo

📝 Customization

Update Content

  • Edit HTML files directly for content changes
  • Team member placeholders in team.html
  • Waitlist form stores in localStorage (for demo)

Modify Styles

  • style.css: Main styling and layout
  • terminal.css: Terminal-specific effects
  • CSS variables in :root for easy color changes

Add Features

  • main.js: Contains all interactive features
  • Matrix rain effect (subtle background)
  • Form validation and submission handling

🔧 Development Tips

  1. Test Locally First: Always preview changes locally before pushing
  2. Check Console: Open browser DevTools for any JavaScript errors
  3. Mobile Testing: Use browser's responsive design mode
  4. Performance: Keep images optimized (add to assets/img/)

📧 Contact

For questions about the website or PentestGPT project:

📄 License

This website template is provided for the PentestGPT project. Feel free to modify for your needs.

Built with ❤️ for the security research community