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
dependabot[bot] efb7d1f6cc Bump flake8 from 5.0.4 to 6.1.0
Bumps [flake8](https://github.com/pycqa/flake8) from 5.0.4 to 6.1.0.
- [Commits](https://github.com/pycqa/flake8/compare/5.0.4...6.1.0)

---
updated-dependencies:
- dependency-name: flake8
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-09-09 12:10:57 +10:00
.github Bump actions/checkout from 3 to 4 2023-09-06 01:47:00 +00:00
docs Add support for SSHUTTLE_ARGS environment variable 2023-08-09 15:06:05 +10:00
sshuttle Add support for SSHUTTLE_ARGS environment variable 2023-08-09 15:06:05 +10:00
tests Fix tests 2023-08-07 20:00:32 +10:00
.gitignore Add .coverage to .gitignore 2022-09-06 08:04:28 +10:00
.prospector.yml Fixes some style issues and minor bugs 2017-11-13 11:58:43 +11:00
.readthedocs.yaml Update style issues 2022-04-24 17:37:10 +10:00
.tool-versions Add ASDF .tool-versions file 2022-09-06 08:06:34 +10:00
bandit.yml updated bandit config 2018-10-17 20:52:04 +11:00
CHANGES.rst Move release notes to github 2022-01-28 09:27:47 +11:00
LICENSE Change license text to LGPL-2.1 2020-08-26 12:25:36 -04:00
MANIFEST.in Fix error in requirements.rst 2017-07-09 09:08:48 +10:00
README.rst sshuttle is also avaliable on OpenBSD 2023-08-08 08:19:46 +10:00
requirements-tests.txt Bump flake8 from 5.0.4 to 6.1.0 2023-09-09 12:10:57 +10:00
requirements.txt Bump furo from 2023.8.17 to 2023.8.19 2023-08-22 13:48:45 +10:00
run Fix shellcheck warnings 2021-09-22 12:36:27 +00:00
setup.cfg Bump version: 1.1.0 → 1.1.1 2022-09-06 08:17:47 +10:00
setup.py Bump version: 1.1.0 → 1.1.1 2022-09-06 08:17:47 +10:00
tox.ini Remove support for Python 3.6 and 3.7 2022-03-29 11:47:05 +11:00

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

- Ubuntu 16.04 or later::

      apt-get install sshuttle

- Debian stretch or later::

      apt-get install sshuttle

- Arch Linux::

      pacman -S sshuttle

- Fedora::

      dnf install sshuttle

- openSUSE::

      zypper in sshuttle

- Gentoo::

      emerge -av net-proxy/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

- OpenBSD::

      pkg_add sshuttle

- macOS, via MacPorts::

      sudo port selfupdate
      sudo port install 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