extern/sshuttle
1
1
Fork 0
mirror of https://github.com/sshuttle/sshuttle.git synced 2024-12-29 10:09:26 +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.
504 Commits 9 Branches 50 Tags 3.7 MiB
Python 95.9%
Shell 3.1%
Nix 0.5%
Dockerfile 0.5%
9b7ce2811e
Go to file
vieira 9b7ce2811e Use versions of python3 greater than 3.5 when available (e.g. 3.6) 
Some Linux distros, like Alpine, Arch, etc and some BSDs, like FreeBSD, are
now shipping with python3.6 as the default python3. Both the client and the
server are failing to run in this distros, because we are specifically looking
for python3.5.

These changes make the run shell script use python3 if the version is greater
than 3.5, otherwise falling back as usual.

On the server any version of python3 will do, use it before falling back to
python, as the server code can run with any version of python3.
2017-10-23 06:58:21 +11:00
docs Get version for sphinx from sshuttle.version 2017-07-09 09:08:48 +10:00
sshuttle Use versions of python3 greater than 3.5 when available (e.g. 3.6) 2017-10-23 06:58:21 +11:00
.gitignore Fix error in requirements.rst 2017-07-09 09:08:48 +10:00
.travis.yml Backward compatibility with Python 2.4 (server) 2016-04-03 13:14:02 +10:00
CHANGES.rst Update changelog for 0.78.3 2017-07-09 09:12:04 +10:00
conftest.py Backward compatibility with Python 2.4 (server) 2016-04-03 13:14:02 +10:00
LICENSE Fix LGPL2 license. 2016-03-07 10:03:22 +11:00
MANIFEST.in Fix error in requirements.rst 2017-07-09 09:08:48 +10:00
README.rst Add homebrew instructions 2017-08-03 13:55:04 +10:00
requirements.txt Pin version in requirements.txt 2017-07-09 09:08:48 +10:00
run Use versions of python3 greater than 3.5 when available (e.g. 3.6) 2017-10-23 06:58:21 +11:00
setup.cfg Update setup.cfg 2017-07-09 09:08:48 +10:00
setup.py Fix error in requirements.rst 2017-07-09 09:08:48 +10:00
tox.ini Backward compatibility with Python 2.4 (server) 2016-04-03 13:14:02 +10: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
------------------

- Debian stretch or later::

      apt-get install sshuttle

- From PyPI::

      sudo pip install sshuttle

- Clone::

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

It is also possible to install into a virtualenv as a non-root user.

- From PyPI::

      virtualenv -p python3 /tmp/sshuttle
      . /tmp/sshuttle/bin/activate
      pip install sshuttle

- Clone::

      virtualenv -p python3 /tmp/sshuttle
      . /tmp/sshuttle/bin/activate
      git clone https://github.com/sshuttle/sshuttle.git
      ./setup.py install

- Homebrew::

      brew install sshuttle


Documentation
-------------
The documentation for the stable version is available at:
http://sshuttle.readthedocs.org/

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