Skip to content

Latest commit

 

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wireguard.koplugin

Dead simple KOReader plugin to connect to wireguard VPNs via wireproxy, overcoming Kindles inability to create network interfaces and thus simply using wg-quick.

Setup

  • Download this repo into your KOReader plugins/ directory
  • Cross-compile wireproxy for your architecture and dump it into bin/
  • Copy conf/wp.conf.sample and edit it into conf/wp.conf to both:
    • Connect to your VPN (same as Wireguard's wg.conf)
    • Define your desired network architecture (see Wireproxy Configurations for more)

Additionally, you will need to configure your companion apps one way or another depending on your network layout.

Usage

The plugin adds a Wireproxy VPN entry to KOReader's main menu, providing two conveniences while wireproxy runs in the background:

  • Proxy Status — tap to start/stop the proxy. The menu stays open and the line reflects the new state.
  • Test Connection — parses wp.conf and TCP-connects to every BindAddress (TCP tunnels, SOCKS5 and HTTP proxies), reporting each entry. The menu stays open; a popup shows the result.

KOReader serves solely as an convenient interface to toggle wireproxy manually. No automatic actions are taken, ever.

Wireproxy configurations

Please refer to windtf/wireproxy for full documentation on these. This README lists only config snippets I've found relevant to this KOReader plugin.

TCP Tunnel

In wp.conf, add:

[TCPClientTunnel]
BindAddress = 127.0.0.1:8080   # This local address at your preferred port...
Target = 144.26.0.1:8123       # ...is going to actually point at this remote service

No extra config is needed. Link your services using the BindAddress address rather than your VPN's.

HTTP Proxy

KOReader only supports HTTP proxies. and wireproxy allows only HTTP CONNECT.

In wp.conf, add:

[http]
BindAddress = 127.0.0.1:1080   

Then set these proxies at application-level (KOReader). Services on your VPN will be routed automatically and need only be configured using their usual Wireguard addresses.

Acknowledgements

About

Connect to wireguard VPNs on Kindle via wireproxy

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages