Home | History | Annotate | Download | only in docs
      1 .. _obtaining:
      2 
      3 Obtaining iperf3
      4 ================
      5 
      6 Binary Distributions
      7 --------------------
      8 
      9 Note that ESnet does not distribute binary packages of iperf3.  All of
     10 the packages listed in this section are provided by third parties, who
     11 are solely responsible for their contents.  This is an incomplete list
     12 of binary packages:
     13 
     14 * FreeBSD:  `benchmarks/iperf3
     15   <http://freshports.org/benchmarks/iperf3>`_ in the FreeBSD Ports Collection
     16 * Fedora / CentOS: `iperf3
     17   <https://apps.fedoraproject.org/packages/iperf3/>`_ and
     18   `iperf3-devel
     19   <https://apps.fedoraproject.org/packages/iperf3-devel>`_ in Fedora
     20   19 and 20 and in Fedora EPEL 5, 6, and 7.  iperf3 is included as a
     21   part of RedHat Enterprise Linux 7.4 and later (as well as CentOS 7.4
     22   and later).
     23 * Ubuntu:  `iperf3 <https://launchpad.net/ubuntu/+source/iperf3>`_,
     24   is available in Trusty (backports), and as a part of the main
     25   release in Vivid and newer.
     26 * macOS:  via HomeBrew.
     27 * Windows:  `iperf3 binaries for Windows
     28   <https://iperf.fr/iperf-download.php#windows>`_ are available from
     29   iperf.fr (and other sources).
     30 
     31 Source Distributions
     32 --------------------
     33 
     34 Source distributions of iperf are available as compressed (gzip)
     35 tarballs at:
     36 
     37 https://downloads.es.net/pub/iperf/
     38 
     39 **Note:**  Due to a software packaging error, the 3.0.2 release
     40 tarball was not compressed, even though its filename had a ``.tar.gz``
     41 suffix.
     42 
     43 **Note:**  GitHub, which currently hosts the iperf3 project, supports
     44 a "Releases" feature, which can automatically generate ``.zip`` or ``.tar.gz``
     45 archives, on demand, from tags in the iperf3 source tree.  These tags are
     46 created during the release engineering process to mark the exact
     47 version of files making up a release.
     48 
     49 In theory, the ``.tar.gz`` files produced by GitHub contain the same
     50 contents as what are in the official tarballs, note that the tarballs
     51 themselves will be different due to internal timestamps or other
     52 metadata.  Therefore these files will *not* match the published SHA256
     53 checksums and no guarantees can be made about the integrity of the
     54 files.  The authors of iperf3 always recommend downloading source
     55 distributions from the the directory above (or a mirror site), and
     56 verifying the SHA256 checksums before using them for any purpose, to
     57 ensure the files have not been tampered with.
     58 
     59 Source Code Repository
     60 ----------------------
     61 
     62 The iperf3 project is hosted on GitHub at:
     63 
     64 https://github.com/esnet/iperf
     65 
     66 The iperf3 source code repository can be checked out directly from
     67 GitHub using:
     68 
     69 ``git clone https://github.com/esnet/iperf.git``
     70 
     71 Primary development for iperf3 takes place on CentOS 7 Linux, FreeBSD 11,
     72 and macOS 10.12. At this time, these are the only officially supported
     73 platforms, however there have been some reports of success with
     74 NetBSD, OpenBSD, Windows, Solaris, Android, and iOS.
     75