From 4a6b9617b643b7cf4eb7489acd6e4360b05050e5 Mon Sep 17 00:00:00 2001 From: Evie Date: Wed, 20 May 2026 22:35:25 -0400 Subject: [PATCH] Consolidate and polish documentation --- GEMINI.md | 37 ++++--------------------------------- README.md | 39 +++++++++++++++++++++++++-------------- 2 files changed, 29 insertions(+), 47 deletions(-) diff --git a/GEMINI.md b/GEMINI.md index 6dc3fc2..d19206e 100644 --- a/GEMINI.md +++ b/GEMINI.md @@ -1,40 +1,11 @@ # Retro-Proxy-Stack -A collection of Docker configurations designed to bridge the gap between modern internet services (email, web) and legacy clients (Outlook Express 6, IE 5/6 on Windows 9x/XP). +This file serves as internal project context for Gemini CLI agents working on the Retro-Proxy-Stack repository. -**Note:** This project is an orchestration layer. All core functionality is provided by the following upstream projects: +## Project Purpose +A simple dockerized orchestration layer for connecting legacy clients (Outlook Express 6, IE 5/6) on Windows 9x/XP to modern SMTP/IMAP servers and the web. -## Architecture & Credits -- **[Stunnel](https://www.stunnel.org/):** Used for SMTP/POP3/IMAP protocol/TLS translation. -- **[WebOne](https://github.com/atauenis/webone):** Modern-to-legacy HTTP proxy for browsing. -- **[WRP (Web Rendering Proxy)](https://github.com/tenox7/wrp):** Visual-rendering proxy that converts modern web pages into clickable image maps. - -## Features -- **Legacy Mail Proxy:** Uses `Stunnel` to translate non-SSL legacy client connections into secure TLS 1.3 tunnels for modern servers. *Note: Best used with your own private mail server (like Synology MailPlus) that supports standard basic authentication (PLAIN/LOGIN).* -- **WebOne Proxy:** An HTTP proxy that strips modern security requirements and complex scripts, allowing vintage browsers to access the modern web. -- **WRP (Web Rendering Proxy):** A visual proxy that renders modern webpages as clickable image maps for hardware that cannot handle modern web standards. - -## Services -| Service | Role | Host Port | Purpose | -| :--- | :--- | :--- | :--- | -| **Stunnel** | Mail Proxy | 25, 110, 143 | Bridges legacy mail clients to modern TLS-enabled servers. | -| **WebOne** | HTTP Proxy | 8081 | Allows retro browsers to access the modern web (strips TLS/scripts). | -| **WRP** | Visual Proxy | 8082 | Renders modern sites as image maps for very limited hardware. | - -## Quick Start -1. **Start Services:** - `docker compose up -d` - -2. **Mail Client Configuration:** - - Configure your client (Outlook Express 6) to use the server's IP address for SMTP/POP/IMAP. - - **Crucial:** Disable "Secure Password Authentication" (SPA) in the client's account settings. - - Set connection security to "None" (the proxy handles the encryption). - -3. **Retro Browsing:** - - **For WebOne:** Set your browser's proxy settings to `:8081`. - - **For WRP:** Navigate to `http://:8082` in your legacy browser. - -## Configuration +## Development Guidelines - All infrastructure and service mappings are defined in `compose.yml`. - Mail proxy settings are defined in `stunnel.conf`. - When adding or modifying services, ensure they maintain compatibility with older security standards required by Windows 9x/XP clients. diff --git a/README.md b/README.md index a464f8d..848ecb4 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,36 @@ # Retro-Proxy-Stack -A Docker Compose orchestration layer that bundles existing proxy tools to help legacy Windows 9x/XP clients (Outlook Express 6, IE 5/6) connect to modern services. +A collection of Docker configurations designed to bridge the gap between modern internet services (email, web) and legacy clients (Outlook Express 6, IE 5/6 on Windows 9x/XP). -**Note:** This project is purely a configuration layer. All core functionality is provided by the respective upstream projects. +**Note:** This project is an orchestration layer. All core functionality is provided by the following upstream projects: + +## Architecture & Credits +- **[Stunnel](https://www.stunnel.org/):** Used for SMTP/POP3/IMAP protocol/TLS translation. +- **[WebOne](https://github.com/atauenis/webone):** Modern-to-legacy HTTP proxy for browsing. +- **[WRP (Web Rendering Proxy)](https://github.com/tenox7/wrp):** Visual-rendering proxy that converts modern web pages into clickable image maps. ## Features - **Legacy Mail Proxy:** Uses `Stunnel` to translate non-SSL legacy client connections into secure TLS 1.3 tunnels for modern servers. *Note: Best used with your own private mail server (like Synology MailPlus) that supports standard basic authentication (PLAIN/LOGIN).* - **WebOne Proxy:** An HTTP proxy that strips modern security requirements and complex scripts, allowing vintage browsers to access the modern web. - **WRP (Web Rendering Proxy):** A visual proxy that renders modern webpages as clickable image maps for hardware that cannot handle modern web standards. -## Included Tools -- **[Stunnel](https://www.stunnel.org/):** Handles secure TLS translation for legacy mail clients. -- **[WebOne](https://github.com/atauenis/webone):** An HTTP proxy that strips modern security requirements, enabling vintage browsers to access the modern web. -- **[WRP (Web Rendering Proxy)](https://github.com/tenox7/wrp):** A visual proxy that renders modern webpages as clickable image maps. +## Services +| Service | Role | Host Port | Purpose | +| :--- | :--- | :--- | :--- | +| **Stunnel** | Mail Proxy | 25, 110, 143 | Bridges legacy mail clients to modern TLS-enabled servers. | +| **WebOne** | HTTP Proxy | 8081 | Allows retro browsers to access the modern web (strips TLS/scripts). | +| **WRP** | Visual Proxy | 8082 | Renders modern sites as image maps for very limited hardware. | -## Setup -1. **Configure:** Update `stunnel.conf` with your upstream mail server details. -2. **Launch:** Run `docker compose up -d` to start all services. -3. **Configure Clients:** - - **Mail:** Set up accounts in your legacy client (Outlook Express 6) using the host's IP. Disable "Secure Password Authentication" (SPA) and use no encryption (the proxy handles it). - - **Web:** Set your browser's proxy settings to `host-ip:8081` (WebOne) or visit `http://host-ip:8082` (WRP). +## Quick Start +1. **Launch:** Run `docker compose up -d` to start all services. +2. **Mail Client Configuration:** + - Configure your client (Outlook Express 6) to use the host's IP address for SMTP/POP/IMAP. + - **Crucial:** Disable "Secure Password Authentication" (SPA) in the client's account settings. + - Set connection security to "None" (the proxy handles the encryption). +3. **Retro Browsing:** + - **For WebOne:** Set your browser's proxy settings to `host-ip:8081`. + - **For WRP:** Navigate to `http://host-ip:8082` in your legacy browser. -## Documentation -For full details on architecture, service mappings, and configuration, see [GEMINI.md](./GEMINI.md). +## Configuration +- All infrastructure and service mappings are defined in `compose.yml`. +- Mail proxy settings are defined in `stunnel.conf`.