| 1 |
Installing Flent |
| 2 |
---------------- |
| 3 |
Installing Flent can be done in several ways, depending on your operating system: |
| 4 |
|
| 5 |
|
| 6 |
- **Arch Linux:** |
| 7 |
|
| 8 |
Install Flent from `the AUR <https://aur.archlinux.org/packages/flent>`_. |
| 9 |
|
| 10 |
- **Debian and Ubuntu:** |
| 11 |
|
| 12 |
.. code-block:: bash |
| 13 |
|
| 14 |
apt install flent |
| 15 |
|
| 16 |
- **Fedora:** |
| 17 |
|
| 18 |
.. code-block:: bash |
| 19 |
|
| 20 |
dnf install flent |
| 21 |
|
| 22 |
- **Gentoo:** (supported in `pkalin overlay <https://github.com/thinrope/pkalin>`_) |
| 23 |
|
| 24 |
.. code-block:: bash |
| 25 |
|
| 26 |
eselect repository enable pkalin && eix-sync |
| 27 |
emerge net-analyzer/flent |
| 28 |
|
| 29 |
- **Nix:** |
| 30 |
|
| 31 |
Flent is available in nixpkgs through the `flent` attribute. |
| 32 |
|
| 33 |
- **Ubuntu pre-18.04:** |
| 34 |
|
| 35 |
Add the `tohojo/flent PPA <https://launchpad.net/~tohojo/+archive/ubuntu/flent>`_. |
| 36 |
|
| 37 |
- **Other Linux:** |
| 38 |
|
| 39 |
Install from the `Python Package Index <https://pypi.python.org/pypi/flent>`_: |
| 40 |
|
| 41 |
.. code-block:: bash |
| 42 |
|
| 43 |
pip install flent |
| 44 |
|
| 45 |
- **FreeBSD:** |
| 46 |
|
| 47 |
Install the package |
| 48 |
|
| 49 |
.. code-block:: bash |
| 50 |
|
| 51 |
pkg install flent |
| 52 |
|
| 53 |
Or install the port |
| 54 |
|
| 55 |
.. code-block:: bash |
| 56 |
|
| 57 |
cd /usr/ports/net/flent && make install |
| 58 |
|
| 59 |
- **macOS:** |
| 60 |
|
| 61 |
`Homebrew <https://brew.sh/>`_ and Python 3 must be installed (Python 3 can be installed using Homebrew) |
| 62 |
|
| 63 |
Install the `patched netperf package <https://github.com/kris-anderson/homebrew-netperf>`_ |
| 64 |
|
| 65 |
.. code-block:: bash |
| 66 |
|
| 67 |
brew tap kris-anderson/netperf |
| 68 |
brew install netperf-enable-demo |
| 69 |
|
| 70 |
Install other dependencies |
| 71 |
|
| 72 |
.. code-block:: bash |
| 73 |
|
| 74 |
brew install fping |
| 75 |
pip3 install matplotlib --user |
| 76 |
|
| 77 |
Install Flent using pip |
| 78 |
|
| 79 |
.. code-block:: bash |
| 80 |
|
| 81 |
pip3 install flent --user |
| 82 |
|
| 83 |
Optional (install this if you want to use `flent-gui`) |
| 84 |
|
| 85 |
.. code-block:: bash |
| 86 |
|
| 87 |
pip3 install pyqt5 qtpy --user |
| 88 |
|
| 89 |
Quick start |
| 90 |
----------- |
| 91 |
You must run netperf on two computers - a **server** and a **client**. |
| 92 |
|
| 93 |
#. **Server (Computer 1):** Netperf needs to be started in "server mode" to |
| 94 |
listen for commands from the Client. To do this, install netperf on the |
| 95 |
Server computer, then enter: |
| 96 |
|
| 97 |
``netserver &`` |
| 98 |
|
| 99 |
*Note:* Instead of installing netperf on a local server, you may substitute |
| 100 |
the netserver that is running on netperf.bufferbloat.net by using :option:`-H |
| 101 |
netperf.bufferbloat.net<-H>` in the commands below. |
| 102 |
|
| 103 |
List of public hosts you can test against: |
| 104 |
|
| 105 |
- netperf.bufferbloat.net (also called netperf-east.bufferbloat.net) |
| 106 |
- netperf-west.bufferbloat.net |
| 107 |
- netperf-eu.bufferbloat.net |
| 108 |
|
| 109 |
#. **Client (Computer 2):** Install netperf, then install flent on your Client |
| 110 |
computer. When you invoke flent on the Client, it will connect to the |
| 111 |
specified netserver (:option:`-H`) and carry out the measurements. Here are some useful |
| 112 |
commands: |
| 113 |
|
| 114 |
- RRUL: Create the standard graphic image used by the Bufferbloat project to |
| 115 |
show the down/upload speeds plus latency in three separate charts:: |
| 116 |
|
| 117 |
flent rrul -p all_scaled -l 60 -H address-of-netserver -t text-to-be-included-in-plot -o filename.png |
| 118 |
|
| 119 |
- CDF: A Cumulative Distribution Function plot showing the probability that |
| 120 |
ping times will be below a bound:: |
| 121 |
|
| 122 |
flent rrul -p ping_cdf -l 60 -H address-of-netserver -t text-to-be-included-in-plot -o filename.png |
| 123 |
|
| 124 |
- TCP Upload: Displays TCP upload speed and latency in two charts:: |
| 125 |
|
| 126 |
flent tcp_upload -p totals -l 60 -H address-of-netserver -t text-to-be-included-in-plot -o filename.png |
| 127 |
|
| 128 |
- TCP Download: Displays TCP download speeds and latency in two charts:: |
| 129 |
|
| 130 |
flent tcp_download -p totals -l 60 -H address-of-netserver -t text-to-be-included-in-plot -o filename.png |
| 131 |
|
| 132 |
The output of each of these commands is a graphic (PNG) image along with a data |
| 133 |
file in the current working directory that can be used to re-create the plot, |
| 134 |
either from the command line (see :doc:`options`), or by loading them into the |
| 135 |
GUI. Run :command:`flent-gui` to start the GUI. |