From b363f30298ae04ad1cf97b0cc65ed9f3c35bece2 Mon Sep 17 00:00:00 2001 From: moparisthebest Date: Mon, 16 Dec 2019 19:29:01 -0500 Subject: [PATCH] update readme --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 49 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f70d83f..d5c19b0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,57 @@ # wireguard-proxy +[![Travis-CI Build Status](https://api.travis-ci.org/moparisthebest/wireguard-proxy.svg?branch=master)](https://travis-ci.org/moparisthebest/wireguard-proxy) +[![Build status](https://ci.appveyor.com/api/projects/status/vl8c9xdhvgn997d2/branch/master?svg=true)](https://ci.appveyor.com/project/moparisthebest/wireguard-proxy/branch/master) +[![crates.io](https://img.shields.io/crates/v/wireguard-proxy.svg)](https://crates.io/crates/wireguard-proxy) + Proxy wireguard UDP packets over TCP/TLS `wireguard-proxy` has 2 modes: -- server-side daemon to accept TCP connections from multiple clients and pipe data to and from the specified UDP port -- client-side daemon that accepts UDP packets on a local port from a single client, connects to a single remote TCP port, and pipes data between them +- server-side daemon to accept TCP/TLS connections from multiple clients and pipe data to and from the specified UDP port +- client-side daemon that accepts UDP packets on a local port from a single client, connects to a single remote TCP/TLS port, and pipes data between them + +``` +$ wireguard-proxy -h +usage: wireguard-proxy [options...] + Client Mode (requires --tcp-target): + -tt, --tcp-target TCP target to send packets to, where + wireguard-proxy server is running + -uh, --udp-host UDP host to listen on, point wireguard + client here, default: 127.0.0.1:51820 + --tls use TLS when connecting to tcp-target + WARNING: currently verifies nothing! + + Server Mode (requires --tcp-host): + -th, --tcp-host TCP host to listen on + -ut, --udp-target UDP target to send packets to, where + wireguard server is running, + default: 127.0.0.1:51820 + -ur, --udp-bind-host-range UDP host and port range to bind to, + one port per TCP connection, to + listen on for UDP packets to send + back over the TCP connection, + default: 127.0.0.1:30000-40000 + -tk, --tls-key TLS key to listen with, + requires --tls-cert also + -tc, --tls-cert TLS cert to listen with, + requires --tls-key also + + Common Options: + -h, --help print this usage text + -st, --socket-timeout Socket timeout (time to wait for data) + before terminating, default: 0 +``` + +Binaries: + +- [releases](https://github.com/moparisthebest/wireguard-proxy/releases) has static builds for most platforms performed by travis-ci and appveyor courtesy of [trust](https://github.com/japaric/trust) +- Arch Linux AUR [wireguard-proxy](https://aur.archlinux.org/packages/wireguard-proxy/) and [wireguard-proxy-git](https://aur.archlinux.org/packages/wireguard-proxy-git/) + +Building: + +- `cargo build --release` - minimal build without TLS support, no dependencies +- `cargo build --release --feature tls` - links to system openssl +- `cargo build --release --feature openssl_vendored` - compiles vendored openssl and link to it Testing: