IntenseWebs/LibreQoS
3
0
Fork 0
mirror of https://github.com/LibreQoE/LibreQoS.git synced 2025-02-25 18:55:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add some small documentation for adding config items.

Browse Source
This commit is contained in:
Herbert Wolverson
2024-01-27 10:12:57 -06:00
parent e0e81ed715
commit 699e265850
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/rust/lqos_config/README.md
View File

@@ -1,15 +1,23 @@
# LQosConfig
`lqos_config` is designed to manage configuration of LibreQoS.
`lqos_config` is designed to manage configuration of LibreQoS. Starting in 1.5, all configuration is
centralized into `/etc/lqos.conf`.
Since all of the parts of the system need to know where to find LibreQoS, it first looks for a file named `/etc/lqos.conf` and uses that to locate the LibreQoS installation.
The `lqos_python` module contains functions that mirror each of these, using their original Python
names for integration purposes.
`/etc/lqos.conf` looks like this:
You can find the full definitions of each configuration entry in `src/etc/v15`.
```toml
lqos_directory = '/opt/libreqos'
```
## Adding Configuration Items
The entries are:
There are two ways to add a configuration:
* `lqos_directory`: where LibreQoS is installed (e.g. `/opt/libreqos`)
1. Declare a Major Version Break. This is a whole new setup that will require a new configuration and migration. We should avoid doing this very often.
1. You need to create a new folder, e.g. `src/etc/v16`.
2. You need to port as much of the old config as you are creating.
3. You need to update `src/etc/migration.rs` to include code to read a "v15" file and create a "v16" configuration.
4. *This is a lot of work and should be a planned effort!*
2. Declare an optional new version item. This is how you handle "oh, I needed to snoo the foo" - and add an *optional* configuration item - so nothing will snarl up because it isn't there.
1. Find the section you want to include it in in `src/etc/v15`. If there isn't one, create it using one of the others as a template and be sure to include the defaults. Add it into `top_config` as the type `Option<MySnooFoo>`.
2. Update `example.toml` to include what *should* go there.
3. Go into `lqos_python` and in `lib.rs` add a Python "getter" for the field. Remember to use `if let` to read the `Option` and return a default if it isn't present.