From 398a3597784ac2df89e726e1b6b3fd22a92fe997 Mon Sep 17 00:00:00 2001 From: "Aaron D. Lee" Date: Mon, 12 Jan 2026 23:21:58 -0500 Subject: [PATCH] Add Windows Docker/WSL2 docs, update Python version to 3.11-3.14 - Windows: Add Docker Desktop and WSL2 options (recommended) - Windows: Keep native install as advanced option - Update Python badge and requirements tables Co-Authored-By: Claude Opus 4.5 --- INSTALL.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++-------- README.md | 2 +- 2 files changed, 56 insertions(+), 10 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 0ea832f..c7f2d7e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -20,22 +20,23 @@ Complete installation instructions for all platforms and deployment methods. ## Requirements -### ⚠️ Python Version Requirements +### Python Version Requirements | Python Version | Status | Notes | |----------------|--------|-------| -| 3.10 | ✅ Supported | | -| 3.11 | ✅ Supported | Recommended | +| 3.10 | ❌ Not Supported | Dropped in v4.2.1 | +| 3.11 | ✅ Supported | Minimum version | | 3.12 | ✅ Supported | Recommended | -| 3.13 | ❌ **Not Supported** | jpegio C extension incompatible | +| 3.13 | ✅ Supported | | +| 3.14 | ✅ Supported | Tested on Arch | -**Important:** Python 3.13 (released October 2024) is **not compatible** with jpegio due to C extension ABI changes. Use Python 3.12 or earlier. +**Note:** v4.2.1 switched from `jpegio` to `jpeglib` for DCT steganography, enabling Python 3.11-3.14 support. ### Minimum Requirements | Requirement | Value | |-------------|-------| -| Python | 3.10-3.12 | +| Python | 3.11-3.14 | | RAM | 512 MB minimum (256MB for Argon2) | | Disk | ~100 MB | @@ -423,16 +424,61 @@ pip install jpegio ### Windows -1. Install Python 3.12 from [python.org](https://python.org) (NOT 3.13!) -2. Install Visual Studio Build Tools +Windows users have three options, listed from easiest to most complex: + +#### Option 1: Docker Desktop (Recommended) + +The easiest way to run Stegasoo on Windows. No Python installation needed. + +1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) +2. Enable WSL2 backend when prompted +3. Clone and run: + +```powershell +git clone https://github.com/adlee-was-taken/stegasoo.git +cd stegasoo +docker-compose -f docker/docker-compose.yml up -d web +``` + +Access at http://localhost:5000 + +#### Option 2: WSL2 (Windows Subsystem for Linux) + +Run the Linux version natively on Windows. + +```powershell +# Install WSL2 with Ubuntu +wsl --install -d Ubuntu + +# Open Ubuntu terminal, then follow Linux instructions: +sudo apt-get update +sudo apt-get install -y python3.12 python3.12-venv libzbar0 libjpeg-dev +git clone https://github.com/adlee-was-taken/stegasoo.git +cd stegasoo +python3.12 -m venv venv +source venv/bin/activate +pip install -e ".[all]" +stegasoo --version +``` + +#### Option 3: Native Windows (Advanced) + +Native Windows installation requires Visual Studio Build Tools for compiling C extensions. + +1. Install Python 3.11 or 3.12 from [python.org](https://python.org) +2. Install [Visual Studio Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) with "Desktop development with C++" 3. Install from pip: ```powershell python -m venv venv .\venv\Scripts\activate -pip install stegasoo[all] +pip install stegasoo[cli] # CLI only (easiest) +# or +pip install stegasoo[all] # Full install (may require additional setup) ``` +**Note:** Native Windows installation may have issues with `jpegio` (DCT mode). Docker or WSL2 is recommended for full functionality. + ### Raspberry Pi Stegasoo works on Raspberry Pi 4/5 (4GB+ RAM recommended for Web UI). diff --git a/README.md b/README.md index a0d587d..c84fc65 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A secure steganography system for hiding encrypted messages in images using hybr [![Tests](https://github.com/adlee-was-taken/stegasoo/actions/workflows/test.yml/badge.svg)](https://github.com/adlee-was-taken/stegasoo/actions/workflows/test.yml) [![Lint](https://github.com/adlee-was-taken/stegasoo/actions/workflows/lint.yml/badge.svg)](https://github.com/adlee-was-taken/stegasoo/actions/workflows/lint.yml) -![Python](https://img.shields.io/badge/Python-3.10--3.12-blue) +![Python](https://img.shields.io/badge/Python-3.11--3.14-blue) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE) ![Security](https://img.shields.io/badge/Security-AES--256--GCM-red)