README: fix some formatting for easier text-mode readability.

It looked okay in markdown, but some of the text lines were a bit too long.
This commit is contained in:
Avery Pennarun 2010-05-03 13:07:30 -04:00
parent 33a73056ee
commit 4a93d3362d

View File

@ -9,18 +9,36 @@ As far as I know, sshuttle is the only program that solves the following
common case: common case:
- Your client machine (or router) is Linux. - Your client machine (or router) is Linux.
- You have access to a remote network via ssh. - You have access to a remote network via ssh.
- You don't necessarily have admin access on the remote network. - You don't necessarily have admin access on the remote network.
- The remote network has no VPN, or only stupid/complex VPN protocols (IPsec, PPTP, etc). Or maybe you <i>are</i> the admin and you just got frustrated with the awful state of VPN tools.
- You don't want to create an ssh port forward for every single host/port on the remote network. - The remote network has no VPN, or only stupid/complex VPN
- You hate openssh's port forwarding because it's randomly slow and/or stupid. protocols (IPsec, PPTP, etc). Or maybe you <i>are</i> the
- You can't use openssh's PermitTunnel feature because it's disabled by default on openssh servers; plus it does TCP-over-TCP, which has terrible performance (see below). admin and you just got frustrated with the awful state of
VPN tools.
- You don't want to create an ssh port forward for every
single host/port on the remote network.
- You hate openssh's port forwarding because it's randomly
slow and/or stupid.
- You can't use openssh's PermitTunnel feature because
it's disabled by default on openssh servers; plus it does
TCP-over-TCP, which has terrible performance (see below).
This is how you use it: This is how you use it:
----------------------- -----------------------
- <tt>git clone git://github.com/apenwarr/sshuttle</tt><br>on your client and server machines. The server can be any ssh server with python available; the client must be Linux with iptables, and you'll need root or sudo access. - <tt>git clone git://github.com/apenwarr/sshuttle</tt>
on your client and server machines. The server can be
any ssh server with python available; the client must
be Linux with iptables, and you'll need root or sudo
access.
- <tt>./sshuttle -r username@sshserver 0.0.0.0/0 -vv</tt> - <tt>./sshuttle -r username@sshserver 0.0.0.0/0 -vv</tt>
That's it! Now your local machine can access the remote network as if you That's it! Now your local machine can access the remote network as if you