Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
S
sshuttle
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
pub
sshuttle
Commits
dd8e68b6
Commit
dd8e68b6
authored
Nov 15, 2015
by
Brian May
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
More formatting fixes.
parent
1f211791
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
47 additions
and
47 deletions
+47
-47
README.rst
README.rst
+47
-47
No files found.
README.rst
View file @
dd8e68b6
...
@@ -4,24 +4,24 @@ sshuttle: where transparent proxy meets VPN meets ssh
...
@@ -4,24 +4,24 @@ sshuttle: where transparent proxy meets VPN meets ssh
As far as I know, sshuttle is the only program that solves the following
As far as I know, sshuttle is the only program that solves the following
common case:
common case:
- Your client machine (or router) is Linux, FreeBSD, or MacOS.
- Your client machine (or router) is Linux, FreeBSD, or MacOS.
- You have access to a remote network via ssh.
- You have access to a remote network via ssh.
- You don't necessarily have admin access on the remote network.
- You don't necessarily have admin access on the remote network.
- The remote network has no VPN, or only stupid/complex VPN
- The remote network has no VPN, or only stupid/complex VPN
protocols (IPsec, PPTP, etc). Or maybe you *are* the
protocols (IPsec, PPTP, etc). Or maybe you *are* the
admin and you just got frustrated with the awful state of
admin and you just got frustrated with the awful state of
VPN tools.
VPN tools.
- You don't want to create an ssh port forward for every
- You don't want to create an ssh port forward for every
single host/port on the remote network.
single host/port on the remote network.
- You hate openssh's port forwarding because it's randomly
- You hate openssh's port forwarding because it's randomly
slow and/or stupid.
slow and/or stupid.
- You can't use openssh's PermitTunnel feature because
- You can't use openssh's PermitTunnel feature because
it's disabled by default on openssh servers; plus it does
it's disabled by default on openssh servers; plus it does
TCP-over-TCP, which has terrible performance (see below).
TCP-over-TCP, which has terrible performance (see below).
...
@@ -29,23 +29,23 @@ common case:
...
@@ -29,23 +29,23 @@ common case:
Prerequisites
Prerequisites
-------------
-------------
- sudo, su, or logged in as root on your client machine.
- sudo, su, or logged in as root on your client machine.
(The server doesn't need admin access.)
(The server doesn't need admin access.)
- If you use Linux on your client machine:
- If you use Linux on your client machine:
iptables installed on the client, including at
iptables installed on the client, including at
least the iptables DNAT, REDIRECT, and ttl modules.
least the iptables DNAT, REDIRECT, and ttl modules.
These are installed by default on most Linux distributions.
These are installed by default on most Linux distributions.
(The server doesn't need iptables and doesn't need to be
(The server doesn't need iptables and doesn't need to be
Linux.)
Linux.)
- If you use MacOS or BSD on your client machine:
- If you use MacOS or BSD on your client machine:
Your kernel needs to be compiled with `IPFIREWALL_FORWARD`
Your kernel needs to be compiled with `IPFIREWALL_FORWARD`
(MacOS has this by default) and you need to have ipfw
(MacOS has this by default) and you need to have ipfw
available. (The server doesn't need to be MacOS or BSD.)
available. (The server doesn't need to be MacOS or BSD.)
- Python 2.x, both locally and the remote system. Python 3.x is not yet
- Python 2.x, both locally and the remote system. Python 3.x is not yet
supported.
supported.
*WARNING*:
*WARNING*:
On MacOS 10.6 (at least up to 10.6.6), your network will
On MacOS 10.6 (at least up to 10.6.6), your network will
...
@@ -60,22 +60,22 @@ again, even after a reboot.
...
@@ -60,22 +60,22 @@ again, even after a reboot.
Additional Suggested Software
Additional Suggested Software
-----------------------------
-----------------------------
- You may want to need autossh, available in various package management
- You may want to need autossh, available in various package management
systems
systems
- For Linux only tproxy support, you need PyXAPI, available here:
- For Linux only tproxy support, you need PyXAPI, available here:
http://www.pps.univ-paris-diderot.fr/~ylg/PyXAPI/
http://www.pps.univ-paris-diderot.fr/~ylg/PyXAPI/
Obtaining sshuttle
Obtaining sshuttle
------------------
------------------
- Clone::
- Clone::
git clone https://github.com/sshuttle/sshuttle.git
git clone https://github.com/sshuttle/sshuttle.git
./setup.py install
./setup.py install
- From PyPI::
- From PyPI::
pip install sshuttle
pip install sshuttle
...
@@ -83,16 +83,16 @@ Obtaining sshuttle
...
@@ -83,16 +83,16 @@ Obtaining sshuttle
Usage
Usage
-----
-----
- Forward all traffic::
- Forward all traffic::
sshuttle -r username@sshserver 0.0.0.0/0 -vv
sshuttle -r username@sshserver 0.0.0.0/0 -vv
- There is a shortcut for 0.0.0.0/0 for those that value
- There is a shortcut for 0.0.0.0/0 for those that value
their wrists::
their wrists::
sshuttle -r username@sshserver 0/0 -vv
sshuttle -r username@sshserver 0/0 -vv
- If you would also like your DNS queries to be proxied
- If you would also like your DNS queries to be proxied
through the DNS server of the server you are connect to::
through the DNS server of the server you are connect to::
sshuttle --dns -vvr username@sshserver 0/0
sshuttle --dns -vvr username@sshserver 0/0
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment