Merge pull request #295 from AsterisMono/master

doc: add option doc for interactiveSudo

1 files changed, 4 insertions, 0 deletions

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" ];