blob: 905b9531088322d7951242952e9e0d04fe520567 [file] [log] [blame]
<!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>Obtaining iperf3 &#8212; iperf3 3.15 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=4468db6d" />
<link rel="stylesheet" href="_static/bootstrap-3.3.6/css/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/esnet/esnet.css" type="text/css" />
<script src="_static/documentation_options.js?v=c35749de"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/jquery-1.11.0.min.js"></script>
<script src="_static/js/jquery-fix.js"></script>
<script src="_static/bootstrap-3.3.6/js/bootstrap.min.js"></script>
<script src="_static/bootstrap-sphinx.js"></script>
<link rel="icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Building iperf3" href="building.html" />
<link rel="prev" title="iperf3 Project News" href="news.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">
iperf3</a>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="index.html">Section <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="news.html">iperf3 Project News</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Obtaining iperf3</a></li>
<li class="toctree-l1"><a class="reference internal" href="building.html">Building iperf3</a></li>
<li class="toctree-l1"><a class="reference internal" href="invoking.html">Invoking iperf3</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev.html">iperf3 Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">iperf3 FAQ</a></li>
</ul>
</ul>
</li>
<li>
<a href="news.html" title="Previous Chapter: iperf3 Project News">
<span class="glyphicon glyphicon-chevron-left"></span>
<span class="hidden-sm">
iperf3 Project News
</span>
</a>
</li>
<li>
<a href="building.html" title="Next Chapter: Building iperf3">
<span class="hidden-sm">
Building iperf3
</span>
<span class="glyphicon glyphicon-chevron-right"></span>
</a>
</li>
<li class="divider-vertical"></li>
<li><a href="genindex.html">Index</a></li>
<li><a href="https://www.es.net">ESnet</a></li>
<li><a href="https://github.com/esnet/iperf"><img src="_static/icon-github.png" height="20" width="20"></a></li>
<li class="hidden-sm">
<div id="sourcelink">
<a href="_sources/obtaining.rst.txt"
rel="nofollow">Source</a>
</div></li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3">
<div id="sidebar" class="bs-sidenav" role="complementary"><ul>
<li><a class="reference internal" href="#">Obtaining iperf3</a><ul>
<li><a class="reference internal" href="#binary-distributions">Binary Distributions</a></li>
<li><a class="reference internal" href="#source-distributions">Source Distributions</a></li>
<li><a class="reference internal" href="#source-code-repository">Source Code Repository</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="col-md-9">
<section id="obtaining-iperf3">
<span id="obtaining"></span><h1>Obtaining iperf3<a class="headerlink" href="#obtaining-iperf3" title="Link to this heading"></a></h1>
<section id="binary-distributions">
<h2>Binary Distributions<a class="headerlink" href="#binary-distributions" title="Link to this heading"></a></h2>
<p>Note that ESnet does not distribute binary packages of iperf3. All of
the packages listed in this section are provided by third parties, who
are solely responsible for their contents. This is an incomplete list
of binary packages for various operating systems and distributions:</p>
<ul class="simple">
<li><p>FreeBSD: via the FreeBSD Ports Collection with <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">pkg</span> <span class="pre">install</span>
<span class="pre">benchmarks/iperf3</span></code>.</p></li>
<li><p>Fedora / RedHat Linux / CentOS / Rocky: <a class="reference external" href="https://packages.fedoraproject.org/pkgs/iperf3/iperf3/">iperf3</a> and
<a class="reference external" href="https://packages.fedoraproject.org/pkgs/iperf3/iperf3-devel/">iperf3-devel</a> in Fedora
19 and 20 and in Fedora EPEL 5, 6, and 7. iperf3 is included as a
part of RedHat Enterprise Linux 7.4 and later (as well as CentOS 7.4
and later, and all versions of Rocky Linux), and can generally be
installed with <code class="docutils literal notranslate"><span class="pre">yum</span> <span class="pre">install</span> <span class="pre">iperf3</span></code>.</p></li>
<li><p>Ubuntu: <a class="reference external" href="https://launchpad.net/ubuntu/+source/iperf3">iperf3</a>,
is available in Trusty (backports), and as a part of the main
release in Vivid and newer. It can generally be installed with
<code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apt-get</span> <span class="pre">install</span> <span class="pre">iperf3</span></code>.</p></li>
<li><p>macOS: via HomeBrew with <code class="docutils literal notranslate"><span class="pre">brew</span> <span class="pre">install</span> <span class="pre">iperf3</span></code> or MacPorts with
<code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">port</span> <span class="pre">install</span> <span class="pre">iperf3</span></code>.</p></li>
<li><p>Windows: iperf3 binaries for Windows (built with <a class="reference external" href="https://www.cygwin.com/">Cygwin</a>) can be found in a variety of
locations, including <a class="reference external" href="https://files.budman.pw/">https://files.budman.pw/</a>
(<a class="reference external" href="https://www.neowin.net/forum/topic/1234695-iperf/">discussion thread</a>).</p></li>
<li><p>Android: iperf3 binaries for Android can be found in several
locations, including <a class="reference external" href="https://github.com/davidBar-On/android-iperf3/">https://github.com/davidBar-On/android-iperf3/</a>.</p></li>
</ul>
</section>
<section id="source-distributions">
<h2>Source Distributions<a class="headerlink" href="#source-distributions" title="Link to this heading"></a></h2>
<p>Source distributions of iperf are available as compressed (gzip)
tarballs at:</p>
<p><a class="reference external" href="https://downloads.es.net/pub/iperf/">https://downloads.es.net/pub/iperf/</a></p>
<p><strong>Note:</strong> Due to a software packaging error, the 3.0.2 release
tarball was not compressed, even though its filename had a <code class="docutils literal notranslate"><span class="pre">.tar.gz</span></code>
suffix.</p>
<p><strong>Note:</strong> GitHub, which currently hosts the iperf3 project, supports
a “Releases” feature, which can automatically generate <code class="docutils literal notranslate"><span class="pre">.zip</span></code> or <code class="docutils literal notranslate"><span class="pre">.tar.gz</span></code>
archives, on demand, from tags in the iperf3 source tree. These tags are
created during the release engineering process to mark the exact
version of files making up a release.</p>
<p>In theory, the <code class="docutils literal notranslate"><span class="pre">.tar.gz</span></code> files produced by GitHub contain the same
contents as what are in the official tarballs, note that the tarballs
themselves will be different due to internal timestamps or other
metadata. Therefore these files will <em>not</em> match the published SHA256
checksums and no guarantees can be made about the integrity of the
files. The authors of iperf3 always recommend downloading source
distributions from the the directory above (or a mirror site), and
verifying the SHA256 checksums before using them for any purpose, to
ensure the files have not been tampered with.</p>
</section>
<section id="source-code-repository">
<h2>Source Code Repository<a class="headerlink" href="#source-code-repository" title="Link to this heading"></a></h2>
<p>The iperf3 project is hosted on GitHub at:</p>
<p><a class="reference external" href="https://github.com/esnet/iperf">https://github.com/esnet/iperf</a></p>
<p>The iperf3 source code repository can be checked out directly from
GitHub using:</p>
<p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/esnet/iperf.git</span></code></p>
<p>Primary development for iperf3 takes place on CentOS 7 Linux, FreeBSD 11,
and macOS 10.12. At this time, these are the only officially supported
platforms, however there have been some reports of success with
NetBSD, OpenBSD, Windows, Solaris, Android, and iOS.</p>
</section>
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<div class="row">
<div class="col-md-1">
<a href="http://www.es.net/"><img src="_static/ESnet_Final_Logos_All_Blue_Circle_Stamp_RGB.png" alt="[ESnet]"></a>
</div>
<div class="col-md-11">
<p class="pull-right">
<a href="#">Back to top</a>
</p>
<p>
&copy; Copyright 2014-2023, ESnet.<br/>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 7.2.6.<br/>
</p>
</div>
</div>
</div>
</footer>
</body>
</html>