extern/sshuttle
1
1
Fork 0
mirror of https://github.com/sshuttle/sshuttle.git synced 2024-11-08 17:14:43 +01:00
Code Issues Packages Projects Releases Wiki Activity
Transparent proxy server that works as a poor man's VPN. Forwards over ssh. Doesn't require admin. Works with Linux and MacOS. Supports DNS tunneling.
396 Commits 9 Branches 50 Tags 3.6 MiB
Python 95.9%
Shell 3.1%
Nix 0.5%
Dockerfile 0.5%
59865269ac
Go to file
Brian May 59865269ac Update documentation 
Closes #60.
2016-01-17 18:34:10 +11:00
docs Update documentation 2016-01-17 18:34:10 +11:00
sshuttle Use Sphinx for documentation 2016-01-17 16:19:13 +11:00
.gitignore Experimental: Use setuptools-scm 2016-01-13 19:00:08 +11:00
.travis.yml Disable Python 2.6 tests 2015-11-17 09:33:46 +11:00
CHANGES.rst Version 0.75 2016-01-12 12:29:08 +11:00
LICENSE Moved docs out of the src directory 2014-09-15 14:14:52 +10:00
MANIFEST.in Use Sphinx for documentation 2016-01-17 16:19:13 +11:00
README.rst Add link to documentation 2016-01-17 18:20:42 +11:00
requirements.txt Add requirements.txt for readthedocs 2016-01-17 16:32:53 +11:00
run Try Python3.5 by default. 2015-12-05 14:41:22 +11:00
setup.py Fix installation from wheel 2016-01-17 10:21:21 +11:00
tox.ini Add tox.ini file. 2015-12-07 13:17:09 +11:00
VERSION.txt Version 0.75 2016-01-12 12:29:08 +11:00

README.rst 

sshuttle: where transparent proxy meets VPN meets ssh
=====================================================

As far as I know, sshuttle is the only program that solves the following
common case:

- Your client machine (or router) is Linux, FreeBSD, or MacOS.

- You have access to a remote network via ssh.

- 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 *are* 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.

- 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).


Obtaining sshuttle
------------------

- From PyPI::

      pip install sshuttle

- Clone::

      git clone https://github.com/sshuttle/sshuttle.git
      ./setup.py install

Documentation
-------------

The documentation for the latest development version is available at:
http://sshuttle.readthedocs.org/en/latest/