Skip to content

Commit 67f54db

Browse files
authored
Clarify configuration parameters in README
Updated README to improve clarity of configuration parameters and descriptions.
1 parent 219e579 commit 67f54db

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ The service configuration is located in '/etc/config/dscpclassify'.
9393
|class_high_throughput | string | no | af13 | The default DSCP class applied to high-throughput connections |
9494
|wmm_mark_lan | boolean | no | 0 | Mark packets going out of LAN interfaces with DSCP values respective of [WMM (RFC-8325)](https://datatracker.ietf.org/doc/html/rfc8325#section-4.3) |
9595
|**Advanced** | | | | _**The below options are typically only required on non-standard setups**_ |
96-
|_lan_zone_ | list | no | lan | Used to specify LAN firewall zones (lan/guest etc) |
96+
|_lan_zone_ | list | no | lan | Used to specify LAN firewall zones (`lan`/`guest` etc) |
9797
|_wan_zone_ | list | no | wan | Used to specify WAN firewall zones |
9898
|_lan_device_ | list | no | | Used to specify LAN network interfaces (L3 physical interface i.e. `br-lan`) |
9999
|_wan_device_ | list | no | | Used to specify WAN network interfaces (L3 physical interface) |
@@ -112,7 +112,7 @@ _1. When running on older OpenWrt releases with kernels < 5.13 the service defau
112112
|Name | Type | Required | Default | Description|
113113
|--- | --- | --- | --- | ---|
114114
|enabled | boolean | no | 1 | Detect and classify bulk client connections (i.e. P2P)|
115-
|class | string | no | | Override the service level class_high_throughput setting |
115+
|class | string | no | | Override the service level `class_high_throughput` setting |
116116
|**Advanced** | | | | _**The default configuration for the below should work for most users**_ |
117117
|_min_connections_ | number | no | 10 | Minimum established connections for a client port to be considered as bulk |
118118
|_min_bytes_ | number | no | 10000 | Minimum bytes before a client port is classified as bulk |
@@ -121,7 +121,7 @@ _1. When running on older OpenWrt releases with kernels < 5.13 the service defau
121121
|Name | Type | Required | Default | Description|
122122
|--- | --- | --- | --- | ---|
123123
|enabled | boolean | no | 1 | Detect and classify high throughput service connections (i.e. Windows Update/Steam downloads) |
124-
|class | string | no | | Override the service level class_high_throughput setting |
124+
|class | string | no | | Override the service level `class_high_throughput` setting |
125125
|**Advanced** | | | | _**The default configuration for the below should work for most users**_ |
126126
|_min_connections_ | number | no | 3 | Minimum established connections for a service to be considered as high-throughput |
127127
|_min_bytes_ | number | no | 1000000 | Minimum bytes before the connection is classified as high-throughput |
@@ -222,15 +222,15 @@ It is important that **Ignore DSCP** on ingress is **Allow** in SQM setup otherw
222222

223223
### Below is validated working SQM config for use with the service
224224

225-
| Config parameter | Value |
226-
| ----------- | ----------- |
227-
| qdisc_advanced | 1 |
228-
| squash_dscp | 0, to ensure cake does not remove ingress packet DSCP values|
229-
| **squash_ingress** | **0, to ensure cake looks at packet marks on ingress** |
230-
| qdisc_really_really_advanced | 1 |
231-
| iqdisc_opts | nat dual-dsthost ingress diffserv4 |
232-
| eqdisc_opts | nat dual-srchost ack-filter diffserv4 |
233-
| **script** | **layer_cake_ct.qos** |
225+
| Config parameter | Value | Notes |
226+
| ----------- | ----------- | ----------- |
227+
| qdisc_advanced | 1 | |
228+
| squash_dscp | 0 | 1 removes the DSCP after cake processing, 0 preserves DSCP values |
229+
| **squash_ingress** | **0** | **0 ensures cake does not ignore ingress packet DSCP values** |
230+
| qdisc_really_really_advanced | 1 | |
231+
| iqdisc_opts | nat dual-dsthost ingress diffserv4 | diffserv8 allows differentiation of LE/HT traffic |
232+
| eqdisc_opts | nat dual-srchost ack-filter diffserv4 | diffserv8 allows differentiation of LE/HT traffic |
233+
| **script** | **layer_cake_ct.qos** | |
234234
<br />
235235

236236
<img src="https://user-images.githubusercontent.com/46714706/190709086-c2e820ed-11ed-4be4-8e57-fba4ab6db190.png" width="50%">

0 commit comments

Comments
 (0)