IntenseWebs/boringproxy
3
0
Fork 0
mirror of https://github.com/boringproxy/boringproxy.git synced 2025-02-25 18:55:29 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add instructions for running server

Browse Source
This commit is contained in:
Anders Pitman 2020-09-23 10:39:14 -06:00
parent 1008abdc44
commit f7689465fc
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -8,7 +8,8 @@ allows you to easily do that.
If you have: If you have:
* A SirTunnel server instance listening on port 443 of `example.com`. * A SirTunnel [server instance](#running-the-server) listening on port 443 of
`example.com`.
* A copy of the sirtunnel.py script available on the PATH of the server. * A copy of the sirtunnel.py script available on the PATH of the server.
* An SSH server running on port 22 of `example.com`. * An SSH server running on port 22 of `example.com`.
* A webserver running on port 8080 of your laptop. * A webserver running on port 8080 of your laptop.
@ -63,6 +64,20 @@ The main advantages of SirTunnel are:
so it's important but not unique. so it's important but not unique.
# Running the server
Assuming you already have an ssh server running, getting the SirTunnel server
going consists of simply downloading a copy of Caddy and running it with the
provided config. Take a look at [`install.sh`](./install.sh) and
[`run_server.sh`](./run_server.sh) for details.
**Note:** Caddy needs to bind to port 443, either by running as root (not
recommended), setting the `CAP_NET_BIND_SERVICE` capability on the Caddy binary
(what the `install.sh` script does), or changing `caddy_config.json` to bind
to a different port (say 9000) and using something like iptables to forward
to that port.
[0]: https://github.com/anderspitman/awesome-tunneling [0]: https://github.com/anderspitman/awesome-tunneling