Herbert Wolverson
7a9e26911a
The three git-install pages each hard-coded an apt list that had already drifted from the scripts (missing make, stale mold/esbuild/graphviz entries). The build scripts install the packages themselves, so the docs now point at build_rust.sh and build_rust_debian.sh instead. The bash -n CI gate is deferred to a separate change.
2.6 KiB
Git Install (For Developers - Not Recommended)
Clone the repo
The recommended install location is /opt/libreqos
Go to the install location, and clone the repo:
cd /opt/
sudo git clone https://github.com/LibreQoE/LibreQoS.git libreqos
sudo chown -R $USER /opt/libreqos
cd /opt/libreqos/
git switch develop
git pull
By specifying libreqos at the end, git will ensure the folder name is lowercase.
Install Dependencies from apt and pip
The build scripts install the required packages from apt. Use
./build_rust.sh on Ubuntu 24.04 and ./build_rust_debian.sh on Debian 13 or
later.
Then you need to install some Python dependencies:
cd /opt/libreqos
sudo python3 -m venv /opt/libreqos/venv
sudo /opt/libreqos/venv/bin/python -m pip install --upgrade pip
sudo /opt/libreqos/venv/bin/python -m pip install --upgrade -r requirements.txt
Install the Rust development system
Run the following:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
When Rust finishes installing, it will tell you to execute a command to place the Rust build tools into your path. You need to either execute this command or logout and back in again.
Once that's done, please run:
cd /opt/libreqos/src/
./build_rust.sh
This will take a while the first time, but it puts everything in the right place.
Now, to build rust crates, run:
cd rust
cargo build --all
Lqos.conf
Copy the lqos.conf configuration file to /etc. This is not neccesarry if you installed using the .deb:
cd /opt/libreqos/src
sudo cp lqos.example /etc/lqos.conf
Configuration
Proceed to configure settings following this guide.
Daemon setup
Run daemons with systemd
Note: If you used the .deb installer, you can skip this section. The .deb installer automatically sets these up.
You can now set up lqosd, and lqos_scheduler as systemd services.
sudo cp /opt/libreqos/src/bin/lqosd.service.example /etc/systemd/system/lqosd.service
sudo cp /opt/libreqos/src/bin/lqos_scheduler.service.example /etc/systemd/system/lqos_scheduler.service
Estas plantillas esperan network-online.target, por lo que lqosd y lqos_scheduler no arrancan antes de que DNS y la ruta por defecto esten listas.
Finally, run
sudo systemctl daemon-reload
sudo systemctl enable lqosd lqos_scheduler
sudo systemctl start lqosd lqos_scheduler
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.