localstream 1.0.8

Python CLI client for slipstream-rust DNS tunnel

LocalStream

A robust Python client for the slipstream-rust DNS tunnel, designed to bypass censorship and secure your connection.

---

📖 Overview

LocalStream simplifies the usage of complex DNS tunneling. It wraps the powerful slipstream-rust into a user-friendly interface that manages dependencies, connectivity, and routing automatically.

Designed specifically to operate in restricted network environments, LocalStream supports advanced features like TLS Fragmentation and System-wide VPN (via tun2proxy). Whether you need to secure your entire system or just provide a SOCKS5 proxy for specific applications, LocalStream offers a stable and resilient solution.

✨ Features

• Dual Operation Modes: Switch effortlessly between VPN Mode (full device tunneling) and Proxy Mode (SOCKS5).
• Censorship Circumvention: Optimized for users in high-censorship regions (e.g., Iran), with support for TLS fragmentation and custom DNS resolvers.
• Automated Management: Automatically downloads and configures necessary binaries (slipstream-client, tun2proxy, wintun).
• Resilient Connectivity:
  • Auto-Reconnect: Intelligent watchdog monitors your connection and reconnects instantly if it drops.
  • Auto-Restart: Optional scheduled restarts to maintain long-term stability.
• Config Import/Export: Securely share configuration profiles encrypted with .local files.
• Modern Interface: Available as a robust CLI or a modern GUI application.

📥 Installation

For End Users

Download the latest Setup.exe from our releases page and run the installer.

For Developers

Install via pip:

pip install localstream

Or for local development:

git clone https://gitlab.com/GloryMajor/LocalStream.git
cd LocalStream
pip install -e .

🚀 Usage

GUI Application

Launch LocalStream from your Start Menu or Desktop shortcut.

1. Add your server configuration or import a profile.
2. Select VPN Mode or Proxy Mode.
3. Click Connect.

Command Line Interface (CLI)

Run the application from your terminal:

LocalStream

Follow the interactive menu prompts to configure your server and start the connection.

⚠️ Important: To use VPN Mode, you must run the application with elevated privileges:

• Windows: Run as Administrator
• Linux: Run with sudo

⚙️ Configuration

Your configuration is stored in ~/.localstream/config.json. You can edit it via the application or manually:

{
  "server_ip": "203.0.113.2",
  "server_port": 53,
  "local_port": 5201,
  "domain": "s.example.com",
  "keep_alive_interval": 200,
  "congestion_control": "bbr",
  "enable_fragmentation": false,
  "auto_restart_minutes": 0
}

🛠️ Requirements

• Operating System: Windows 10/11 or Linux (Ubuntu, Debian, Fedora, Arch, etc.)
• Python: 3.11 or higher (for source installation)
• Privileges: Administrator/sudo rights (required for VPN mode)

🤝 Contributing

We welcome contributions! Please check out our CONTRIBUTING.md guide for details on how to get involved.

🔒 Security

We take security seriously. Please review our SECURITY.md policy for reporting vulnerabilities.

📄 License

This project is licensed under the Apache-2.0 License. See the LICENSE file for full details.

---

Built with ❤️ by GloryMajor