Update lqos.example to more sane defaults, and add a TESTING-1.4.md document to provide some temporary instructions for testing this release.

src/TESTING-1.4.md

@@ -0,0 +1,101 @@
+# How to Test V1.4
+
+Version 1.4 is still undergoing active development, but if you'd like to benefit from it right now (or help us test/develop it!), here's a guide.
+
+## Clone the repo
+
+> My preferred install location is `/opt/libreqos` - but you can put it wherever you want.
+
+Go to your preferred install location, and clone the repo:
+
+```
+git clone https://github.com/LibreQoE/LibreQoS.git
+```
+
+Switch to the development branch:
+
+```
+git checkout v1.4-pre-alpha-rust-integration
+```
+
+## Install Dependencies from apt and pip
+
+You need to have a few packages from `apt` installed:
+
+```
+apt get install -y python3-pip clang gcc gcc-multilib llvm libelf-dev git nano graphviz curl screen
+```
+
+Then you need to install some Python dependencies:
+
+```
+python3 -m pip install ipaddress schedule influxdb-client requests flask flask_restful flask_httpauth waitress psutil binpacking graphviz
+```
+
+## Install the Rust development system
+
+Go to [RustUp](https://rustup.rs) and follow the instructions. Basically, run the following:
+
+```
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
+
+Once that's done, change directory to `/wherever_you_put_libreqos/src/`, and run:
+
+```
+./build_rust.sh
+```
+
+This will take a while the first time, but it puts everything in the right place.
+
+## Setup the LibreQoS Daemon
+
+Copy the daemon configuration file to `/etc`:
+
+```
+sudo cp lqos.example /etc/lqos
+```
+
+Now edit the file to match your setup:
+
+```toml
+lqos_directory = '/opt/libreqos/src'
+queue_check_period_ms = 1000
+
+[tuning]
+stop_irq_balance = true
+netdev_budget_usecs = 8000
+netdev_budget_packets = 300
+rx_usecs = 8
+tx_usecs = 8
+disable_rxvlan = true
+disable_txvlan = true
+disable_offload = [ "gso", "tso", "lro", "sg", "gro" ]
+
+interface_mapping = [
+       { name = "enp1s0f1", redirect_to = "enp1s0f2", scan_vlans = false },
+       { name = "enp1s0f2", redirect_to = "enp1s0f1", scan_vlans = false }
+]
+vlan_mapping = []
+```
+
+Change `enp1s0f1` and `enp1s0f2` to match your network interfaces. It doesn't matter which one is which.
+
+## Configure LibreQoS
+
+Follow the regular instructions to set your interfaces in `ispConfig.py` and your `network.json` and `ShapedDevices.csv` files.
+
+## Run the program
+
+You can setup `lqosd` and `lqos_node_manager` as daemons to keep running (there are example `systemd` files in the `src/bin` folder). Since v1.4 is under such heavy development, I recommend using `screen` to run detached instances - and make finding issues easier.
+
+1. `screen`
+2. `cd /wherever_you_put_libreqos/src/bin`
+3. `sudo ./lqosd`
+4. Create a new `screen` window with `Ctrl-A, C`.
+5. Run the webserver with `./lqos_node_manager`
+6. If you didn't see errors, detach with `Ctrl-A, D`
+
+You can now point a web browser at `http://a.b.c.d:9123` (replace `a.b.c.d` with the management IP address of your shaping server) and enjoy a real-time view of your network.
+
+In the web browser, click `Reload LibreQoS` to setup your shaping rules.

src/lqos.example

@@ -7,10 +7,10 @@ queue_check_period_ms = 1000
 
 [tuning]
 stop_irq_balance = true
-netdev_budget_usecs = 20
-netdev_budget_packets = 1
-rx_usecs = 0
-tx_usecs = 0
+netdev_budget_usecs = 8000
+netdev_budget_packets = 300
+rx_usecs = 8
+tx_usecs = 8
 disable_rxvlan = true
 disable_txvlan = true
 disable_offload = [ "gso", "tso", "lro", "sg", "gro" ]