From 6d1b2e5049be1e717b46a994df168c4e4e544c21 Mon Sep 17 00:00:00 2001 From: Marc Plano-Lesay Date: Sat, 3 May 2025 15:18:44 +1000 Subject: [PATCH] Document _file option suffix --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0680778..0722e84 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ reddit-magnet [OPTIONS] ## Configuration -Reddit Magnet uses a TOML configuration file. By default, it looks for a configuration file at `$XDG_CONFIG_HOME/reddit-magnet/config.toml`, but you can specify a different location using the `--config` option. +Reddit Magnet uses a TOML configuration file. By default, it looks for a configuration file at `$XDG_CONFIG_HOME/reddit-magnet/config.toml`, but you can specify a different location using the `--config` option. Note that every option can be suffixed with `_file`, and the value set to a path - at runtime, this file will be read and its content will be assumed as the value for the option. This allows storing sensitive credentials somewhere else. ### Example configuration @@ -44,6 +44,7 @@ host = "http://localhost" port = 9091 username = "username" # Optional password = "password" # Optional +# Could also be password_file = "/run/secrets/reddit-magnet/transmission/password" download_dir = "/downloads" # Optional # BitMagnet configuration