sshuttle

mirror of https://github.com/sshuttle/sshuttle.git synced 2024-11-24 17:04:36 +01:00

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.

Go to file

Brian May c5dcc918db Add changelog entry for 1.0.3		2020-07-12 19:09:32 +10:00
.github/workflows	Create github workflow	2020-05-21 08:12:26 +10:00
bin	Auto sudoers file (#269 )	2019-12-13 08:15:31 +11:00
docs	Fix formatting typos in usage docs	2020-07-04 12:02:44 +02:00
sshuttle	Add missing import	2020-06-27 18:54:02 +10:00
tests	reduce	2020-06-03 14:30:37 +10:00
.gitignore	Add entries to .gitignore	2018-03-16 18:10:09 +11:00
.prospector.yml	Fixes some style issues and minor bugs	2017-11-13 11:58:43 +11:00
bandit.yml	updated bandit config	2018-10-17 20:52:04 +11:00
CHANGES.rst	Add changelog entry for 1.0.3	2020-07-12 19:09:32 +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	Fix errors in long_documentation	2020-06-05 08:19:24 +10:00
requirements-tests.txt	Bump pytest-cov from 2.9.0 to 2.10.0	2020-06-15 19:14:10 +10:00
requirements.txt	Bump setuptools-scm from 4.1.1 to 4.1.2	2020-06-01 19:30:15 +10:00
run	Updated supported Python versions	2020-05-29 07:44:51 +10:00
setup.cfg	Fix/pep8 (#277 )	2019-02-11 09:59:13 +11:00
setup.py	Ask setuptools to require Python 3.5 and above	2020-06-17 22:17:03 -07:00
tox.ini	Updated supported Python versions	2020-05-29 07:44:51 +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`_.
  
.. _terrible performance: https://sshuttle.readthedocs.io/en/stable/how-it-works.html

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

- Debian stretch or later::

      apt-get install sshuttle
      
- Arch Linux::

      pacman -S sshuttle

- Fedora::

      dnf install sshuttle

- NixOS::

      nix-env -iA nixos.sshuttle

- From PyPI::

      sudo pip install sshuttle

- Clone::

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

- FreeBSD::

      # ports
      cd /usr/ports/net/py-sshuttle && make install clean
      # pkg
      pkg install py36-sshuttle

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
      cd sshuttle
      ./setup.py install

- Homebrew::

      brew install sshuttle

- Nix::

      nix-env -iA nixpkgs.sshuttle


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

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


Running as a service
--------------------
Sshuttle can also be run as a service and configured using a config management system: 
https://medium.com/@mike.reider/using-sshuttle-as-a-service-bec2684a65fe