From ec37efd77f8516ccdd13fc81dd7d8df004ccf16d Mon Sep 17 00:00:00 2001 From: DL6ER Date: Sat, 10 Feb 2024 09:34:25 +0100 Subject: [PATCH] Fix debug.api config options description. Signed-off-by: DL6ER --- src/config/config.c | 2 +- src/webserver/webserver.c | 1 - test/pihole.toml | 8 ++++++-- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/src/config/config.c b/src/config/config.c index 45413397..7364ef73 100644 --- a/src/config/config.c +++ b/src/config/config.c @@ -1196,7 +1196,7 @@ void initConfig(struct config *conf) conf->debug.regex.d.b = false; conf->debug.api.k = "debug.api"; - conf->debug.api.h = "Print extra debugging information during telnet API calls. Currently only used to send extra information when getting all queries."; + conf->debug.api.h = "Print extra debugging information concerning API calls. This includes the request, the request parameters, and the internal details about how the algorithms decide which data to present and in what form. This very verbose output should only be used when debugging specific API issues and can be helpful, e.g., when a client cannot connect due to an obscure API error. Furthermore, this setting enables logging of all API requests (auth log) and details about user authentication attempts."; conf->debug.api.t = CONF_BOOL; conf->debug.api.f = FLAG_ADVANCED_SETTING; conf->debug.api.d.b = false; diff --git a/src/webserver/webserver.c b/src/webserver/webserver.c index f9844f4f..5485046f 100644 --- a/src/webserver/webserver.c +++ b/src/webserver/webserver.c @@ -80,7 +80,6 @@ static int redirect_root_handler(struct mg_connection *conn, void *input) if(config.debug.api.v.b) { log_debug(DEBUG_API, "Host header: \"%s\", extracted host: \"%.*s\"", host, (int)host_len, host); - log_debug(DEBUG_API, "URI: %s", uri); } diff --git a/test/pihole.toml b/test/pihole.toml index 9a3939b1..538730f8 100644 --- a/test/pihole.toml +++ b/test/pihole.toml @@ -915,8 +915,12 @@ # Controls if FTLDNS should print extended details about regex matching into FTL.log. regex = true ### CHANGED, default = false - # Print extra debugging information during telnet API calls. Currently only used to - # send extra information when getting all queries. + # Print extra debugging information concerning API calls. This includes the request, + # the request parameters, and the internal details about how the algorithms decide + # which data to present and in what form. This very verbose output should only be used + # when debugging specific API issues and can be helpful, e.g., when a client cannot + # connect due to an obscure API error. Furthermore, this setting enables logging of + # all API requests (auth log) and details about user authentication attempts. api = true ### CHANGED, default = false # Print extra debugging information about TLS connections. This includes the TLS