Features Overview ================= WifiX offers a comprehensive set of features for seamless LAN file sharing. Core Features ------------- File Sharing ~~~~~~~~~~~~ ✅ **Unlimited File Types** - Documents (PDF, DOCX, XLSX, PPTX) - Images (JPG, PNG, GIF, SVG) - Videos (MP4, AVI, MKV) - Archives (ZIP, RAR, 7Z) - Code files and any other format ✅ **Configurable File Size** - Default: 100 MB per file - Configurable up to available disk space - Supports large files (1 GB+) ✅ **Multiple Files** - Upload multiple files simultaneously - No limit on number of files - Organize by upload session Real-Time Communication ~~~~~~~~~~~~~~~~~~~~~~~ ✅ **WebSocket Updates** - Instant file list updates - Live upload notifications - Real-time download progress - Client connection events ✅ **Live Monitoring** - See connected clients - Track active downloads - Monitor server activity - View client IP addresses Network Discovery ~~~~~~~~~~~~~~~~~ ✅ **Automatic Discovery** - mDNS/Bonjour support - Zero-configuration networking - .local domain access - No manual IP entry needed ✅ **Room Codes** - 6-character memorable codes - Easy to share verbally - QR code support (planned) - Auto-generated on startup Security Features ----------------- Authentication ~~~~~~~~~~~~~~ ✅ **Global Room PIN** - Required to enter room - Customizable - Session-based - Prevents unauthorized access ✅ **Per-File PIN** - Optional extra protection - Independent from room PIN - For sensitive files - Easy to manage Access Control ~~~~~~~~~~~~~~ ✅ **Session Management** - Secure session cookies - Configurable expiration - Auto-logout on inactivity - Host-only upload permissions ✅ **Rate Limiting** - Prevents abuse - Configurable limits - Per-IP tracking - Automatic blocking User Interface -------------- Host Interface ~~~~~~~~~~~~~~ ✅ **Dashboard** - Connection information display - Room code prominent - Client counter - Activity feed ✅ **File Management** - Drag-and-drop upload - Click to browse - Delete files individually - Clear all option ✅ **Monitoring** - Connected clients list - Download activity - Real-time notifications - Server statistics Client Interface ~~~~~~~~~~~~~~~~ ✅ **Simple Join** - Room code entry - PIN authentication - Instant access - No installation needed ✅ **File Browser** - Clear file list - File metadata - Download buttons - Protected file indicators ✅ **Download Management** - Progress tracking - Speed indicator - Time remaining - Queue management Cross-Platform Support ---------------------- Server Platforms ~~~~~~~~~~~~~~~~ ✅ **Windows** - Windows 10, 11 - PowerShell scripts - Service installation - Firewall integration ✅ **macOS** - macOS 10.15+ - Bonjour built-in - Launch Agent support - Native integration ✅ **Linux** - Ubuntu, Debian, Fedora - Systemd service - Avahi mDNS - Container support Client Devices ~~~~~~~~~~~~~~ ✅ **Desktop Browsers** - Chrome/Chromium - Firefox - Safari - Edge - Opera ✅ **Mobile Browsers** - iOS Safari - Android Chrome - Samsung Internet - Firefox Mobile Technical Features ------------------ Performance ~~~~~~~~~~~ ✅ **Fast Transfers** - LAN speed (up to 1 Gbps) - Parallel downloads - Efficient streaming - Minimal overhead ✅ **Scalability** - Multiple concurrent clients - Simultaneous downloads - Efficient resource usage - Configurable limits Developer Features ~~~~~~~~~~~~~~~~~~ ✅ **REST API** - Complete HTTP API - File operations - Authentication - Server information ✅ **WebSocket API** - Real-time events - Socket.IO protocol - Bidirectional communication - Event subscriptions ✅ **Configuration** - Environment variables - .env file support - Runtime configuration - Extensive options Deployment Options ------------------ Development ~~~~~~~~~~~ ✅ **Quick Start** - Simple setup - Hot reload (Vite) - Debug mode - Detailed logging Production ~~~~~~~~~~ ✅ **Docker Support** - Docker Compose ready - Container images - Easy deployment - Isolated environment ✅ **Service Installation** - Systemd (Linux) - LaunchAgent (macOS) - Windows Service - Auto-start on boot Planned Features ---------------- Coming Soon ~~~~~~~~~~~ 🔜 **QR Code Generation** - Automatic QR codes for rooms - Easy mobile scanning - Embedded connection info - Print-friendly 🔜 **File Previews** - Image thumbnails - PDF preview - Video preview - Document preview 🔜 **Built-in HTTPS** - Self-signed certificates - Let's Encrypt integration - Automatic renewal - Secure by default 🔜 **Transfer Compression** - On-the-fly compression - Faster transfers - Bandwidth optimization - Configurable compression levels Future Roadmap ~~~~~~~~~~~~~~ 🚀 **Client Upload** - Bidirectional transfer - Permission system - Upload quotas - Moderation tools 🚀 **Multi-Room** - Multiple simultaneous rooms - Room isolation - Resource allocation - Load balancing 🚀 **File Encryption** - End-to-end encryption - Encrypted storage - Key management - Decryption on download 🚀 **Mobile Apps** - Native iOS app - Native Android app - React Native - Enhanced UX 🚀 **Desktop Apps** - Electron wrapper - Native notifications - System tray integration - File system integration Feature Comparison ------------------ .. list-table:: :header-rows: 1 :widths: 30 20 20 30 * - Feature - WifiX - Cloud Storage - FTP * - Internet Required - ❌ No - ✅ Yes - ❌ No * - Setup Time - 5 minutes - Account needed - 15+ minutes * - File Size Limit - Configurable - Usually limited - Usually unlimited * - Speed - LAN (fast) - Internet (slow) - LAN (fast) * - Security - PIN + optional HTTPS - Cloud encryption - Can be encrypted * - Ease of Use - ⭐⭐⭐⭐⭐ - ⭐⭐⭐⭐ - ⭐⭐ * - Client Software - Browser only - Browser/app - FTP client * - Real-time Updates - ✅ Yes - ⚠️ Sometimes - ❌ No * - Multi-recipient - ✅ Simultaneous - ✅ Yes - ⚠️ Sequential Use Case Scenarios ------------------- See :doc:`quickstart` for detailed scenarios including: - 🎓 Classroom file distribution - 💼 Team meeting file sharing - 🏠 Home network transfers - 👨‍💻 Development environment syncing - 📸 Content creation workflows Feature Requests ---------------- Have an idea for a new feature? 1. Check existing issues: `GitHub Issues `_ 2. Open a feature request with: - Clear description - Use case - Expected behavior - Benefits 3. Participate in discussions See Also -------- - :doc:`quickstart` - Feature walkthroughs - :doc:`configuration` - Enable/configure features - :doc:`../api/rest-api` - API documentation - :doc:`../api/websocket-events` - Real-time features