From a1eb366d134308e6e8db781e15b05c6f2cf3de83 Mon Sep 17 00:00:00 2001
From: Chatnoir Miki <cmiki@amono.me>
Date: Wed, 25 Sep 2024 09:10:52 +0800
Subject: [PATCH] doc: add option doc for interactiveSudo

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index 570391b..c353203 100644
--- a/README.md
+++ b/README.md
@@ -197,6 +197,10 @@ This is a set of options that can be put in any of the above definitions, with t
   # This will default to "sudo -u" if not specified anywhere.
   sudo = "doas -u";
 
+  # Whether to enable interactive sudo (password based sudo). Useful when using non-root sshUsers.
+  # This defaults to `false`
+  interactiveSudo = false;
+
   # This is an optional list of arguments that will be passed to SSH.
   sshOpts = [ "-p" "2121" ];