From 2c2a0951a5e6387d57af7ee9511f1f3496525979 Mon Sep 17 00:00:00 2001 From: Stan Grams Date: Sat, 28 Feb 2026 08:39:55 +0100 Subject: [PATCH] [docs](trx-rs): update README config file docs Document the combined trx-rs.toml search order and clarify\nthe HTTP auth example for combined vs legacy config files.\n\nCo-authored-by: Codex Signed-off-by: Stan Grams --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7b93652..2574a72 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,24 @@ A modular transceiver control stack with configurable backends and frontends. Th Configuration reference: see `CONFIGURATION.md` for all server/client options and defaults. +## Configuration Files + +`trx-server` and `trx-client` now support a shared `trx-rs.toml` as well as the legacy per-binary files. + +- Default search order for each app: + current directory, then `~/.config/trx-rs`, then `/etc/trx-rs` +- At each location, the loader checks: + `trx-rs.toml` first (`[trx-server]` or `[trx-client]` section), then the legacy flat file +- Combined file names: + `trx-rs.toml` +- Legacy flat file names: + `trx-server.toml` in the current directory, `server.toml` under XDG/`/etc` + `trx-client.toml` in the current directory, `client.toml` under XDG/`/etc` +- `--config ` still loads an explicit file path. If that file contains a `[trx-server]` or `[trx-client]` section, only that section is used; otherwise the whole file is parsed as the legacy flat format. +- `--print-config` prints an example combined config block suitable for `trx-rs.toml`. + +See `trx-rs.toml.example` for a complete combined example. + ## Supported backends - Yaesu FT-817 (feature-gated crate `trx-backend-ft817`) @@ -32,10 +50,11 @@ Authentication is disabled by default for backward compatibility. When enabled, ### Configuration -Enable authentication in `trx-client.toml`: +In a combined `trx-rs.toml`, enable authentication under `[trx-client.frontends.http.auth]`. +If you use a legacy `trx-client.toml`, use the same keys under `[frontends.http.auth]`. ```toml -[frontends.http.auth] +[trx-client.frontends.http.auth] enabled = true rx_passphrase = "read-only-secret" control_passphrase = "full-control-secret"