qosify: add support for keeping stats

[project/qosify.git] / README

diff --git a/README b/README
index 7b191dbf39d3caa5b64ff0cdcacff5a166149815..10d0c55b8a4d067b3d65ae9974e599c26aead763 100644 (file)
--- a/README
+++ b/README
@@ -9,7 +9,7 @@ It supports the following features:
 - dynamically add IP entries with timeout
 - dns regex entries and ubus api for providing dns lookup results
 
-It con be configured via ubus call qosify config.
+It can be configured via ubus call qosify config.
 
 This call supports the following parameters:
 - "reset": BOOL
@@ -87,6 +87,31 @@ interface/device properties:
        CAKE options for ingress + egress
 
 
+Mapping file syntax:
+
+Each line has two whitespace separated fields, match and dscp
+match is one of:
+- tcp:<port>[-<endport>]
+       TCP single port, or range from <port> to <endport>
+- udp:<port>[-<endport>]
+       UDP single port, or range from <port> to <endport>
+- <ipaddr>
+       IPv4 address, e.g. 1.1.1.1
+- <ipv6addr>
+       IPv6 address, e.g. ff01::1
+- dns:<pattern>
+       fnmatch() pattern supporting * and ? as wildcard characters
+- dns:/<regex>
+       POSIX.2 extended regular expression for matching hostnames
+       Only works, if dns lookups are passed to qosify via the add_dns_host ubus call.
+- dns_c:...
+       Like dns:... but only matches cname entries
+
+dscp can be a raw value, or a codepoint like CS0
+Adding a + in front of the value tells qosify to only override the DSCP value if it is zero
+DNS entries are compared in the order in which they are specified in the config, using the
+first matching entry.
+
+
 Planned features:
-- Integration with dnsmasq to support hostname pattern based DSCP marking
 - Support for LAN host based priority