| Server IP : 216.250.13.251 / Your IP : 216.73.216.164 Web Server : nginx/1.24.0 System : Linux gunay 6.8.0-134-generic #134-Ubuntu SMP PREEMPT_DYNAMIC Fri Jun 26 18:43:11 UTC 2026 x86_64 User : root ( 0) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /usr/share/doc/sshuttle/html/ |
Upload File : |
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Requirements — sshuttle 1.1.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=514cf933" />
<script src="_static/documentation_options.js?v=58fbf978"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation.html" />
<link rel="prev" title="Overview" href="overview.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="installation.html" title="Installation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="overview.html" title="Overview"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">sshuttle 1.1.1 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Requirements</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="requirements">
<h1>Requirements<a class="headerlink" href="#requirements" title="Link to this heading">¶</a></h1>
<section id="client-side-requirements">
<h2>Client side Requirements<a class="headerlink" href="#client-side-requirements" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>sudo, or root access on your client machine.
(The server doesn’t need admin access.)</p></li>
<li><p>Python 3.8 or greater.</p></li>
</ul>
<section id="linux-with-nat-method">
<h3>Linux with NAT method<a class="headerlink" href="#linux-with-nat-method" title="Link to this heading">¶</a></h3>
<p>Supports:</p>
<ul class="simple">
<li><p>IPv4 TCP</p></li>
<li><p>IPv4 DNS</p></li>
<li><p>IPv6 TCP</p></li>
<li><p>IPv6 DNS</p></li>
</ul>
<p>Requires:</p>
<ul class="simple">
<li><p>iptables DNAT and REDIRECT modules. ip6tables for IPv6.</p></li>
</ul>
</section>
<section id="linux-with-nft-method">
<h3>Linux with nft method<a class="headerlink" href="#linux-with-nft-method" title="Link to this heading">¶</a></h3>
<p>Supports</p>
<ul class="simple">
<li><p>IPv4 TCP</p></li>
<li><p>IPv4 DNS</p></li>
<li><p>IPv6 TCP</p></li>
<li><p>IPv6 DNS</p></li>
</ul>
<p>Requires:</p>
<ul class="simple">
<li><p>nftables</p></li>
</ul>
</section>
<section id="linux-with-tproxy-method">
<h3>Linux with TPROXY method<a class="headerlink" href="#linux-with-tproxy-method" title="Link to this heading">¶</a></h3>
<p>Supports:</p>
<ul class="simple">
<li><p>IPv4 TCP</p></li>
<li><p>IPv4 UDP</p></li>
<li><p>IPv4 DNS</p></li>
<li><p>IPv6 TCP</p></li>
<li><p>IPv6 UDP</p></li>
<li><p>IPv6 DNS</p></li>
</ul>
</section>
<section id="macos-freebsd-openbsd-pfsense">
<h3>MacOS / FreeBSD / OpenBSD / pfSense<a class="headerlink" href="#macos-freebsd-openbsd-pfsense" title="Link to this heading">¶</a></h3>
<p>Method: pf</p>
<p>Supports:</p>
<ul class="simple">
<li><p>IPv4 TCP</p></li>
<li><p>IPv4 DNS</p></li>
<li><p>IPv6 TCP</p></li>
<li><p>IPv6 DNS</p></li>
</ul>
<p>Requires:</p>
<ul class="simple">
<li><p>You need to have the pfctl command.</p></li>
</ul>
</section>
<section id="windows">
<h3>Windows<a class="headerlink" href="#windows" title="Link to this heading">¶</a></h3>
<p>Not officially supported, however can be made to work with Vagrant. Requires
cmd.exe with Administrator access. See <a class="reference internal" href="windows.html"><span class="doc">Microsoft Windows</span></a> for more information.</p>
</section>
</section>
<section id="server-side-requirements">
<h2>Server side Requirements<a class="headerlink" href="#server-side-requirements" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Python 3.8 or greater.</p></li>
</ul>
</section>
<section id="additional-suggested-software">
<h2>Additional Suggested Software<a class="headerlink" href="#additional-suggested-software" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>If you are using systemd, sshuttle can notify it when the connection to
the remote end is established and the firewall rules are installed. For
this feature to work you must configure the process start-up type for the
sshuttle service unit to notify, as shown in the example below.</p></li>
</ul>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[Unit]</span>
<span class="na">Description</span><span class="o">=</span><span class="s">sshuttle</span>
<span class="na">After</span><span class="o">=</span><span class="s">network.target</span>
<span class="k">[Service]</span>
<span class="hll"><span class="na">Type</span><span class="o">=</span><span class="s">notify</span>
</span><span class="na">ExecStart</span><span class="o">=</span><span class="s">/usr/bin/sshuttle --dns --remote <user>@<server> <subnets...></span>
<span class="k">[Install]</span>
<span class="na">WantedBy</span><span class="o">=</span><span class="s">multi-user.target</span>
</pre></div>
</div>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Requirements</a><ul>
<li><a class="reference internal" href="#client-side-requirements">Client side Requirements</a><ul>
<li><a class="reference internal" href="#linux-with-nat-method">Linux with NAT method</a></li>
<li><a class="reference internal" href="#linux-with-nft-method">Linux with nft method</a></li>
<li><a class="reference internal" href="#linux-with-tproxy-method">Linux with TPROXY method</a></li>
<li><a class="reference internal" href="#macos-freebsd-openbsd-pfsense">MacOS / FreeBSD / OpenBSD / pfSense</a></li>
<li><a class="reference internal" href="#windows">Windows</a></li>
</ul>
</li>
<li><a class="reference internal" href="#server-side-requirements">Server side Requirements</a></li>
<li><a class="reference internal" href="#additional-suggested-software">Additional Suggested Software</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="overview.html"
title="previous chapter">Overview</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="installation.html"
title="next chapter">Installation</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/requirements.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="installation.html" title="Installation"
>next</a> |</li>
<li class="right" >
<a href="overview.html" title="Overview"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">sshuttle 1.1.1 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Requirements</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2024, Brian May.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
</html>