tlsgate

TLS reverse proxy
git clone git://git.akobets.xyz/tlsgate
Log | Files | Refs | README | LICENSE

commit bcb76f65c45393789d0eca9b17ce8c52723efbcd
parent 6e1afccf3970d51d3dd5b23f9b3ca2044da6e8d2
Author: Artem Kobets <artem@akobets.xyz>
Date:   Fri, 25 Sep 2020 14:15:19 +0300

docs

Diffstat:
MREADME | 13+++++++------
Mtlsgate.1 | 20++++++++++----------
2 files changed, 17 insertions(+), 16 deletions(-)

diff --git a/README b/README @@ -1,7 +1,7 @@ tlsgate ------- TLS reverse proxy. -It takes incoming client connections and redirects them to a server, like so: +It takes incoming client connections and redirects them to a server: client -> proxy -> server @@ -15,14 +15,15 @@ Dependencies Install ------- -make install +$ make +$ make install Examples ------- -Setup an HTTPS server: accept connections on port 443 and pass them to a local http server on port 80. +Setup an HTTPS server: accept connections on port 443 and pass them to a local HTTP server on port 80. - tlsgate \ +$ tlsgate \ -s \ -h 0.0.0.0 \ -p 443 \ @@ -34,7 +35,7 @@ Setup an HTTPS server: accept connections on port 443 and pass them to a local h Use TLS with an IRC client that does not support it (client is connecting to /tmp/irc.sock). Timeout is set to 0 so proxy does not timeout. - tlsgate \ +$ tlsgate \ -S \ -u /tmp/irc.sock \ -H irc.server.com \ @@ -44,7 +45,7 @@ Timeout is set to 0 so proxy does not timeout. Credits ------- -Thanks to the developers of the quark http server +Thanks to the developers of the quark HTTP server https://tools.suckless.org/quark/ This project had helpful examples on how to handle sockets and signals. tlsgate was initially made to make HTTPS work with quark. diff --git a/tlsgate.1 b/tlsgate.1 @@ -8,7 +8,7 @@ tlsgate - TLS reverse proxy .SH DESCRIPTION .B tlsgate is a TLS reverse proxy. -It takes incoming client connections and redirects them to a server, like so: +It takes incoming client connections and redirects them to a server: client -> proxy -> server @@ -22,13 +22,13 @@ Client side is TLS side. Server side is TLS side. .TP .B -h host -TLS proxy hostname. +Proxy hostname. .TP .B -p port -TLS proxy port number. +Proxy port number. .TP .B -u file -TLS UNIX domain socket path. Can not be used with -s. +Proxy UNIX domain socket path. Can not be used with -s. .TP .B -H host Server hostname. @@ -57,9 +57,9 @@ for example if you're setting up TLS support for an IRC client (see EXAMPLES). .B -v Print version number and exit. .SH EXAMPLES -Accept connections on port 443 and pass them to a local http server on port 80. -.PP - tlsgate \\ +Setup an HTTPS server: accept connections on port 443 and pass them to a local HTTP server on port 80. + +$ tlsgate \\ -s \\ -h 0.0.0.0 \\ -p 443 \\ @@ -67,11 +67,11 @@ Accept connections on port 443 and pass them to a local http server on port 80. -P 80 \\ -c /etc/path/to/cert/cert.pem \\ -k /etc/path/to/key/key.pem -.PP + Use TLS with an IRC client that does not support it (client is connecting to /tmp/irc.sock). Timeout is set to 0 so proxy does not timeout. -.PP - tlsgate \\ + +$ tlsgate \\ -S \\ -u /tmp/irc.sock \\ -H irc.server.com \\