WifiX
Getting Started
Installation Guide
System Requirements
Prerequisites
Python Installation
Node.js Installation
Git Installation
Installation Steps
Step 1: Clone the Repository
Step 2: Backend Setup
Step 3: Frontend Setup
Step 4: Configuration
Step 5: Verify Installation
Step 6: Access WifiX
Docker Installation (Alternative)
Platform-Specific Notes
Windows
macOS
Linux
Troubleshooting Installation
Port Already in Use
Python Module Not Found
npm Install Fails
Permission Denied
Network Not Detected
Verification Checklist
Next Steps
Need Help?
Quick Start Guide
Your First File Share
Step 1: Start the Server (Host)
Step 2: Start the Frontend
Step 3: Access the Interface
Step 4: Upload a File (Host)
Step 5: Join and Download (Client)
Common Workflows
Classroom File Distribution
Team Meeting File Sharing
Quick Transfer Between Devices
Interface Overview
Host Dashboard
Client Dashboard
Key Features in Action
Real-Time Notifications
Progress Tracking
PIN Protection Levels
Tips & Tricks
Common Questions
Next Steps
Need Help?
Configuration Guide
Environment Variables
Backend Configuration
Core Settings
PORT
HOST
FLASK_ENV
Security Settings
SECRET_KEY
ACCESS_PIN
File Upload Settings
MAX_CONTENT_LENGTH
UPLOAD_FOLDER
FILE_TTL_SECONDS
CORS Settings
CORS_ORIGINS
Rate Limiting
RATELIMIT_ENABLED
RATELIMIT_STORAGE_URL
Network Discovery
MDNS_ENABLED
SERVICE_NAME
Room Code Settings
ROOM_CODE_LENGTH
ROOM_CODE_TTL
Frontend Configuration
Vite Configuration
Environment Variables
Configuration Examples
Development Environment
Production Environment
Classroom/Educational
Office/Corporate
Security Best Practices
Production Checklist
Strong Secret Key
Strong PIN
Troubleshooting
Configuration Not Loading
Port Already in Use
CORS Errors
See Also
User Guide
Host Workflow
Starting as a Host
Initial Setup
Managing Files
Uploading Files
Viewing Uploaded Files
Deleting Files
Monitoring Activity
Connected Clients
Download Activity
Real-Time Notifications
Sharing Connection Info
Share with Clients
Communication Methods
Advanced Features
Rate Limiting
Session Management
File TTL (Time-to-Live)
Best Practices
Security
Performance
Organization
Common Scenarios
Classroom Teaching
Team Meeting
Event File Distribution
Troubleshooting
Upload Failures
No Clients Connecting
Server Performance Issues
See Also
Client Workflow
Connecting to a Room
Prerequisites
Connection Methods
First Connection
Browsing Files
File List View
File Information
Real-Time Updates
Downloading Files
Basic Download
Progress Indicator
Protected Files
Download Multiple Files
Download Location
Managing Downloads
Download Queue
Pausing/Canceling
Failed Downloads
Mobile Experience
Accessing from Phone/Tablet
Mobile-Specific Features
Tablet Considerations
Best Practices
Connection
Downloading
Etiquette
Common Scenarios
Classroom Student
Meeting Participant
Event Attendee
Troubleshooting
Can’t Connect
Room Not Found
Download Fails
Slow Downloads
Advanced Tips
Browser Settings
Keyboard Shortcuts
Using Developer Tools
See Also
Features Overview
Core Features
File Sharing
Real-Time Communication
Network Discovery
Security Features
Authentication
Access Control
User Interface
Host Interface
Client Interface
Cross-Platform Support
Server Platforms
Client Devices
Technical Features
Performance
Developer Features
Deployment Options
Development
Production
Planned Features
Coming Soon
Future Roadmap
Feature Comparison
Use Case Scenarios
Feature Requests
See Also
Security Guide
Security Model
WifiX Security Layers
Threat Model
Authentication
Room PIN
File PIN
Network Security
LAN-Only Operation
Firewall Configuration
Network Isolation
HTTPS/TLS
Enabling HTTPS
Session Security
Session Management
Secret Key
Rate Limiting
Protection Against Abuse
Bypass Rate Limits
Data Protection
File Storage
File Encryption
Sensitive Data Handling
Audit & Monitoring
Logging
Monitoring
Security Checklist
Pre-Deployment
During Operation
After Session
Common Security Scenarios
Classroom Use
Corporate Meeting
Executive Briefing
Reporting Security Issues
See Also
Help & Support
Troubleshooting
Installation Issues
Python Module Not Found
Port Already in Use
npm Install Fails
Network Issues
Cannot Access from Other Devices
mDNS Not Working
CORS Errors
Upload/Download Issues
Upload Fails
Download Stuck at 0%
File Not Found After Upload
WebSocket Issues
Connection Failed
Real-Time Updates Not Working
Authentication Issues
Incorrect PIN Error
Session Expired
Performance Issues
Slow Upload/Download
High Memory Usage
Browser Issues
Files Not Displaying
Drag & Drop Not Working
Advanced Troubleshooting
Enable Debug Logging
Check Server Logs
Test API Endpoints
Network Diagnostics
Reset Everything
Getting Help
Error Reference
Frequently Asked Questions
General Questions
What is WifiX?
Do I need internet to use WifiX?
Is WifiX free?
What platforms does WifiX support?
Features
What’s the maximum file size I can share?
How many files can I share at once?
Can multiple people download simultaneously?
How fast are transfers?
Can clients upload files?
Security
Is WifiX secure?
Can others on my network see my files?
How do I change the PIN?
What happens to my files?
Usage
How do I connect from my phone?
Do clients need to install anything?
Can I use WifiX in a classroom?
How long does my room code last?
Can I password protect individual files?
Technical
What technologies does WifiX use?
Can I run WifiX on a Raspberry Pi?
Does WifiX work offline?
Can I access WifiX from outside my network?
What’s mDNS/Bonjour?
Troubleshooting
Why can’t other devices connect?
Upload/download is very slow. Why?
Files disappear after a while. Why?
Can I use a different port?
Comparison
WifiX vs Cloud Storage (Dropbox, Google Drive)
WifiX vs USB Drives
WifiX vs Email
Contributing
Can I contribute to WifiX?
How do I report bugs?
Can I request features?
Licensing
Can I use WifiX commercially?
Can I modify WifiX?
Still Have Questions?
Changelog
[1.0.0] - 2025-11-13
Added
Security
Known Issues
[Unreleased]
Planned
Version History Summary
Migration Guides
From 0.9.0 to 1.0.0
Development Roadmap
Q1 2026
Q2 2026
Q3 2026
Q4 2026
Contributing
Release Process
Versioning
Support
Acknowledgments
Dependencies
License
License
MIT License
What This Means
Third-Party Licenses
Backend Dependencies
Frontend Dependencies
Documentation
Attribution
Patent Grant
Trademark
Warranty Disclaimer
Liability Limitation
Contributing
Commercial Use
Comparison with Other Licenses
Questions?
Full License Text
WifiX
Index
Index