extern/sshuttle
1
1
Fork 0
mirror of https://github.com/sshuttle/sshuttle.git synced 2024-11-22 07:53: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.
473 Commits 9 Branches 50 Tags 3.6 MiB
Python 95.9%
Shell 3.1%
Nix 0.5%
Dockerfile 0.5%
6d5d0d766f
Go to file
vieira 6d5d0d766f Tests and documentation for systemd integration 
Some tests and documentation for the systemd notification feature.
Also fixes some corner case issues detected while writing the tests.
2016-10-30 10:58:03 +11:00
docs Tests and documentation for systemd integration 2016-10-30 10:58:03 +11:00
sshuttle Tests and documentation for systemd integration 2016-10-30 10:58:03 +11:00
.gitignore Update files list 2016-04-30 18:05:47 +10:00
.travis.yml Backward compatibility with Python 2.4 (server) 2016-04-03 13:14:02 +10:00
CHANGES.rst New release 2016-08-06 18:58:00 +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 Update files list 2016-04-30 18:05:47 +10:00
README.rst Fix typo, space not required here 2016-09-01 18:38:13 +10:00
requirements.txt Add requirements.txt for readthedocs 2016-01-17 16:32:53 +11:00
run Support using run from different directory 2016-08-30 19:03:46 +10:00
setup.cfg Add pytest-runner support 2016-07-10 11:26:32 +10:00
setup.py Move pytest-runner to tests_require 2016-10-29 12:04:22 +11: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

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/