Document the HTTPS listen option.

ltratt · Sep 29, 2024 · 15828b4 · 15828b4
1 parent 42a4b44
commit 15828b4
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/pizauth.conf.5 b/pizauth.conf.5
@@ -42,6 +42,12 @@ specifies the address for the
 HTTP server to listen on.
 Defaults to
 .Qq 127.0.0.1:0 .
+.It Sy https_listen = Qo Em bind-name Qc ;
+specifies the address for the
+.Xr pizauth 1
+HTTPS server to listen on.
+Defaults to
+.Qq 127.0.0.1:0 .
 .It Sy transient_error_if_cmd = Qo Em shell-cmd Qc ;
 specifies a shell command to be run when pizauth repeatedly encounters
 errors when trying to refresh a token.

diff --git a/src/config.rs b/src/config.rs
@@ -26,6 +26,7 @@ const REFRESH_RETRY_DEFAULT: Duration = Duration::from_secs(40);
 const AUTH_NOTIFY_INTERVAL_DEFAULT: u64 = 15 * 60;
 /// What is the default bind() address for the HTTP server?
 const HTTP_LISTEN_DEFAULT: &str = "127.0.0.1:0";
+/// What is the default bind() address for the HTTPS server?
 const HTTPS_LISTEN_DEFAULT: &str = "127.0.0.1:0";
 
 #[derive(Debug)]