Return to obtaining.rst CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / iperf / docs

Annotation of embedaddon/iperf/docs/obtaining.rst, revision 1.1.1.3

1.1       misho       1: .. _obtaining:
                      2: 
                      3: Obtaining iperf3
                      4: ================
                      5: 
                      6: Binary Distributions
                      7: --------------------
                      8: 
1.1.1.2   misho       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
1.1.1.3 ! misho      12: of binary packages for various operating systems and distributions:
1.1       misho      13: 
1.1.1.3 ! misho      14: * FreeBSD: via the FreeBSD Ports Collection with ``sudo pkg install
        !            15:   benchmarks/iperf3``.
        !            16: * Fedora / RedHat Linux / CentOS / Rocky: `iperf3
        !            17:   <https://packages.fedoraproject.org/pkgs/iperf3/iperf3/>`_ and
1.1       misho      18:   `iperf3-devel
1.1.1.3 ! misho      19:   <https://packages.fedoraproject.org/pkgs/iperf3/iperf3-devel/>`_ in Fedora
1.1.1.2   misho      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
1.1.1.3 ! misho      22:   and later, and all versions of Rocky Linux), and can generally be
        !            23:   installed with ``yum install iperf3``.
1.1.1.2   misho      24: * Ubuntu:  `iperf3 <https://launchpad.net/ubuntu/+source/iperf3>`_,
                     25:   is available in Trusty (backports), and as a part of the main
1.1.1.3 ! misho      26:   release in Vivid and newer. It can generally be installed with
        !            27:   ``sudo apt-get install iperf3``.
        !            28: * macOS:  via HomeBrew with ``brew install iperf3`` or MacPorts with
        !            29:   ``sudo port install iperf3``.
        !            30: * Windows:  iperf3 binaries for Windows (built with `Cygwin <https://www.cygwin.com/>`_) can be found in a variety of
        !            31:   locations, including `<https://files.budman.pw/>`_
        !            32:   (`discussion thread
        !            33:   <https://www.neowin.net/forum/topic/1234695-iperf/>`_).
        !            34: * Android:  iperf3 binaries for Android can be found in several
        !            35:   locations, including `<https://github.com/davidBar-On/android-iperf3/>`_.
1.1       misho      36: 
                     37: Source Distributions
                     38: --------------------
                     39: 
                     40: Source distributions of iperf are available as compressed (gzip)
                     41: tarballs at:
                     42: 
1.1.1.2   misho      43: https://downloads.es.net/pub/iperf/
1.1       misho      44: 
                     45: **Note:**  Due to a software packaging error, the 3.0.2 release
                     46: tarball was not compressed, even though its filename had a ``.tar.gz``
                     47: suffix.
                     48: 
                     49: **Note:**  GitHub, which currently hosts the iperf3 project, supports
                     50: a "Releases" feature, which can automatically generate ``.zip`` or ``.tar.gz``
                     51: archives, on demand, from tags in the iperf3 source tree.  These tags are
                     52: created during the release engineering process to mark the exact
                     53: version of files making up a release.
                     54: 
                     55: In theory, the ``.tar.gz`` files produced by GitHub contain the same
                     56: contents as what are in the official tarballs, note that the tarballs
                     57: themselves will be different due to internal timestamps or other
                     58: metadata.  Therefore these files will *not* match the published SHA256
                     59: checksums and no guarantees can be made about the integrity of the
                     60: files.  The authors of iperf3 always recommend downloading source
                     61: distributions from the the directory above (or a mirror site), and
                     62: verifying the SHA256 checksums before using them for any purpose, to
                     63: ensure the files have not been tampered with.
                     64: 
                     65: Source Code Repository
                     66: ----------------------
                     67: 
                     68: The iperf3 project is hosted on GitHub at:
                     69: 
                     70: https://github.com/esnet/iperf
                     71: 
                     72: The iperf3 source code repository can be checked out directly from
                     73: GitHub using:
                     74: 
                     75: ``git clone https://github.com/esnet/iperf.git``
                     76: 
1.1.1.2   misho      77: Primary development for iperf3 takes place on CentOS 7 Linux, FreeBSD 11,
                     78: and macOS 10.12. At this time, these are the only officially supported
1.1       misho      79: platforms, however there have been some reports of success with
1.1.1.2   misho      80: NetBSD, OpenBSD, Windows, Solaris, Android, and iOS.