Command-line utility for limiting an adapter's bandwidth
Shell Makefile
Switch branches/tags
Nothing to show

README.md

The Wonder Shaper 1.4

Copyright

bert hubert ahu@ds9a.nl http://lartc.org/wondershaper (c) Copyright 2002 Simon Séhier simon@sehier.fr - Camptocamp (c) Copyright 2015 - HTB magnific0 http://www.github.com/magnific0 (c) Copyright 2012-2017 Licenced under the GPL

About

Wonder Shaper is a script that allow the user to limit the bandwidth of one or more network adapters. It does so by using iproute's tc command, but greatly simplifies its operation. Wonder Shaper was first released by Bert Hubert in 2002, but the original version lacked a command-line interface, from on version 1.2 this feature was added. From version 1.3, the HTB queing is used instead of CBQ, allowing better bandwith managment on high speed (above ten megabits) links. In version 1.4 an improved ingress shaping method was implemented and the ability to limit either down or up (both is still possible too). The original README is a rather lengthy document and is saved under README.old, for those who'd like some more background information. Except any notes on operation this document is considered up-to-date.

Installation

Obtaining wondershaper

It is recommended to clone the GitHub repository of wondershaper such that you can pull in new updates at any time (if available). Open a new terminal and clone the repository using

git clone  https://github.com/magnific0/wondershaper.git

This will clone wondershaper in your current folder in a new folder named wondershaper. Now enter the folder using

cd wondershaper

Using wondershaper

You can run wondershaper (as any user with sufficient permissions) without installation and stop following the instructions at this point. Show the wondershaper usage instructions by typing

./wondershaper -h

The program details all available options on how to use wondershaper. Next is to pick an interface that you want to shape. You can see all availble interfaces by typing

ip addr show

Note that on older systems this command might not be available. In this case you should run ifconfig instead.

Identify the network interface that you want to shape. The names differ per system.

In the following example a wireless interface is limited to an upload of 4Mbps and download of 8Mbps.

./wondershaper -a wlp4s0 -u 4096 -d 8192

If you get messages telling you that RTNETLINK answers: Operation not permitted your user account does not have sufficient priviliges. In that case try:

sudo ./wondershaper -a wlp4s0 -u 4096 -d 8192

System installation (optional)

A makefile file provided for easy installation. The default location for wondershaper is in /usr/bin. If you want to install to your system you can run:

sudo make install

You can verify that wondershaper was installed correctly by entering:

which wondershaper

This should return /usr/bin/wondershaper. You can follow the same instructions as explained in the "Using wondershaper" section, but instead of running the local version of the program you now run the system version by removing the ./ from the beginning of each command. For example to show the help instructions again run:

wondershaper -h

Persistent usage of wondershaper (optional)

To make sure wondershaper is reactivated on reboot a systemd service file is provided. First enable wondershapre as a systemd service using:

sudo systemctl enable wondershaper.service 

Instead of using the commandline options to set the rates and interface as previously shown, it is necessary to set these parameters in the wondershaper.conf configuration file. You can edit this file using your favourite text editor (nano in the example below) as such:

sudo nano /etc/conf.d/wondershaper.conf

This way wondershaper is activated with your setting upon reboot.

Usage

wondershaper [-hcs] [-a <adapter>] [-d <rate>] [-u <rate>]

The following command line options are allowed:

  • -h Display help

  • -a <adapter> Set the adpter

  • -d <rate> Set maximum download rate (in Kbps) and/or

  • -u <rate> Set maximum upload rate (in Kbps)

  • -p Use the presets in /etc/conf.d/wondershaper.conf

  • -c Clear the limits from adapter

  • -s Show the current status of adapter

The different modes are:

wondershaper -a <adapter> -d <rate> -u <rate>

wondershaper -c -a <adapter>

wondershaper -s -a <adapter>

Some examples:

wondershaper -a eth0 -d 1024 -u 512

wondershaper -a eth1 -d 94000 -u 94000  # could be used on a 100Mbps link

wondershaper -a eth1 -u 94000  # only limit upload

wondershaper -c -a eth0