aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTomasz Kramkowski <tomasz@kramkow.ski>2025-07-20 12:31:13 +0100
committerTomasz Kramkowski <tomasz@kramkow.ski>2025-07-20 12:31:13 +0100
commit847cfa692b20903a8c6a43c01948ded6db0035a7 (patch)
tree9aa5eb2751c5e6a360776f9585af37a198dbc11c /README.md
parente6ac7b1643e01764c5fccddee985d25bf53494e2 (diff)
downloadmqttr-847cfa692b20903a8c6a43c01948ded6db0035a7.tar.gz
mqttr-847cfa692b20903a8c6a43c01948ded6db0035a7.tar.xz
mqttr-847cfa692b20903a8c6a43c01948ded6db0035a7.zip
Non-UTF8 path/argument support
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index f18d485..910fe66 100644
--- a/README.md
+++ b/README.md
@@ -58,10 +58,13 @@ The routes follow the following format:
]
"foo/bar/baz" = {
qos = "at-least-once", # Subscription QoS
- programs = [["/foo"], ["/bar"]]
+ programs = [["/foo"], ["/bar"], [{b64 = "L3NpbGx5/3BhdGg="}, "normal-arg"]]
}
```
+Note: If your program path or one of its arguments contains invalid UTF8, you
+can use a `{ b64 = "BaSe64==" }` in place of the argument.
+
On startup, `mqttr` will read the config file and subscribe to all the topics.
When a message is received, `mqttr` will match the message topic against the
routes and execute every program which is part of a matching route. Each program
@@ -88,7 +91,6 @@ it being ran every time a new MQTT message is published to this topic.
## Missing Features
-* Ability to configure programs with non-UTF-8 in paths
* TLS
* mTLS
* Graceful signal handling