WifiX Documentation

WifiX is a local-network file sharing application for moving files between nearby devices without cloud storage, accounts, or manual USB transfers. A device becomes the host, shares a LAN link or QR code, and nearby clients open that link to request access and download shared files.

Current Product Shape

WifiX is currently maintained in two app targets:

Target	Backend	Purpose
Windows desktop	Python backend packaged as a Tauri sidecar	Full desktop app with automatic backend startup
Android mobile	Rust backend embedded in the Tauri mobile app	Mobile host/client testing and LAN sharing from Android
Browser client	Connects to the active host over HTTP on the LAN	Opens the WifiX interface from the shared link

Key Capabilities

• Host files from the desktop app or Android app on the same local network.

• Share a direct LAN URL and QR code with nearby devices.

• Require host approval before clients connect.

• Upload files with progress feedback.

• Add optional per-file PIN protection before upload.

• View shared files from a browser, desktop app, or mobile app.

• Run the Windows desktop backend automatically when the packaged app starts.

• Use a native Android build with an embedded Rust backend for mobile hosting.

Quick Start

For normal users, install the latest release from GitHub:

1. Download the Windows installer, WifiX-Desktop-Windows-Setup.exe.

2. Install and open WifiX on the host computer.

3. Click Become Host.

4. Share the displayed LAN link or QR code.

5. On another device, open the link and click Connect as Client.

6. Approve the request on the host, then share or download files.

For Android testing, install the debug APK from the release assets or with ADB:

adb install -t -r -d WifiX-Mobile-Android-Debug.apk

Note

WifiX is designed for trusted local networks. It does not provide a public internet relay by default. Devices must be on the same LAN unless a separate relay/cloud layer is added later.

Documentation Contents

Getting Started

• Installation Guide
  • System Requirements
  • Install from GitHub Releases
  • Run from Source
  • Build Desktop
  • Build Android
  • Docker Installation (Alternative)
  • Platform-Specific Notes
  • Troubleshooting Installation
  • Verification Checklist
  • Next Steps
  • Need Help?
• Quick Start
  • Share Files from Windows Desktop
  • Connect from Another Device
  • Use Android as Host
  • PIN-Protected Uploads
  • Development Quick Start
  • Troubleshooting
• Release Downloads
  • Recommended Release Assets
  • Windows Desktop Release
  • Android Release
  • Creating a GitHub Release
  • Publishing the Docker Image
  • Release Checklist
• Configuration Guide
  • Environment Variables
  • Frontend Configuration
  • Configuration Examples
  • Security Best Practices
  • Troubleshooting
  • See Also

User Guide

• Host Workflow
  • Starting as a Host
  • Managing Files
  • Monitoring Activity
  • Sharing Connection Info
  • Advanced Features
  • Best Practices
  • Common Scenarios
  • Troubleshooting
  • See Also
• Client Workflow
  • Connecting to a Room
  • Browsing Files
  • Downloading Files
  • Managing Downloads
  • Mobile Experience
  • Best Practices
  • Common Scenarios
  • Troubleshooting
  • Advanced Tips
  • See Also
• Features Overview
  • Core Features
  • Security Features
  • User Interface
  • Cross-Platform Support
  • Technical Features
  • Deployment Options
  • Planned Features
  • Feature Comparison
  • Use Case Scenarios
  • Feature Requests
  • See Also
• Security Guide
  • Security Model
  • Authentication
  • Network Security
  • HTTPS/TLS
  • Session Security
  • Rate Limiting
  • Data Protection
  • Audit & Monitoring
  • Security Checklist
  • Common Security Scenarios
  • Reporting Security Issues
  • See Also

API Reference

• REST API
  • Core Endpoints
  • Compatibility Notes
  • Security Notes
• WebSocket Events
  • Common Events
  • Client Guidance
• Python Integration Notes
  • Useful Entry Points
  • Running the Backend
  • Packaging Notes
• API Examples
  • Check Host Information
  • List Shared Files
  • Create a Client Request
  • Upload a File
  • Download a File

Development

• Architecture
  • Repository Layout
  • Desktop Runtime
  • Mobile Runtime
  • Compatibility Principle
• Contributing
  • Recommended Workflow
  • Development Areas
  • Before Submitting
• Testing
  • Frontend Build
  • Desktop Backend
  • Production Backend Smoke Test
  • Android Build
  • Manual Workflow Checks
• Deployment
  • Windows Desktop
  • Android
  • GitHub Release

Help and Reference

• Troubleshooting
• Frequently Asked Questions
• Changelog
• License

Repository and Support

• Repository: github.com/mehmoodulhaq570/WifiX

• Issues: GitHub Issues

• Discussions: GitHub Discussions

• License: License

Indices and Tables

• Index

• Module Index

• Search Page