Skip to content

UnB21/termux-wireproxy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Termux WireProxy

A lightweight WireGuard-over-SOCKS5 management wrapper for Termux.

Termux WireProxy provides a simple command-line interface (twp) for managing a Wireproxy-based VPN SOCKS5 proxy connection on Android using Termux.

The project is designed to make starting, stopping, checking, and troubleshooting Wireproxy easier from a mobile Linux environment.

Features

  • Simple twp command interface
  • Provider/profile management
  • Start, stop, and restart Wireproxy
  • Process and connection health checks
  • Current configuration display
  • VPN exit IP verification
  • Log viewing and follow mode
  • Version reporting
  • Separation of public project files and private VPN credentials

Requirements

  • Android device
  • Termux
  • Wireproxy
  • A WireGuard-compatible VPN provider configuration

Installation

Clone the repository:

git clone https://github.com/UnB21/termux-wireproxy.git
cd termux-wireproxy

Make the command executable:

chmod +x bin/twp

Run the command:

./bin/twp

Configuration

Provider configurations are stored locally under:

providers/

Example layout:

providers/
├── custom/
├── proton/
│   ├── examples/
│   └── us.conf

Private WireGuard configuration files are intentionally excluded from Git tracking.

Configure configs/wireproxy.conf:

WGConfig = /path/to/provider/profile.conf

[Socks5]
BindAddress = 127.0.0.1:25344

Commands

Start WireProxy

twp start

Stop WireProxy

twp stop

Restart WireProxy

twp restart

Check Status

twp status

Health Check

twp health

Diagnose Problems

twp doctor

Show Current Configuration

twp current

Show VPN Exit IP

twp ip

View Logs

twp logs

Follow logs:

twp logs -f

List Providers

twp providers

Change Provider Profile

twp use <provider> <profile>

Example:

twp use proton us.conf

Show Version

twp version

Security

Sensitive files are intentionally excluded from version control.

Ignored files include:

providers/**/*.conf
logs/
state/

Do not upload private WireGuard configuration files, private keys, or VPN credentials.

Project Status

Current version:

0.1.0-alpha

This project is currently under active development.

License

This project is licensed under the MIT License.
See the LICENSE file for details.

About

A lightweight Termux wrapper for managing Wireproxy-based WireGuard SOCKS5 VPN connections on Android.

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages