aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndrew Fontaine2022-01-26 22:10:49 -0500
committerAndrew Fontaine2022-01-28 16:18:12 -0500
commit874af9b05bec0bd73a333166a8b5291ecb1c0e3e (patch)
tree3ec4c68c7a2bb93baea99c91c272c592eac3447a /README.md
parent0ac333cdc03407538b5b19d60a8e7c64588490fb (diff)
Add custom sudo command support
This is useful for nodes that utilize `doas` instead of `sudo`.
Diffstat (limited to '')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9fb016e..7f5b748 100644
--- a/README.md
+++ b/README.md
@@ -159,6 +159,11 @@ This is a set of options that can be put in any of the above definitions, with t
# If `sshUser` is specified, this will be the default (though it will _not_ default to your own username)
user = "root";
+ # Which sudo command to use. Must accept at least two arguments:
+ # the user name to execute commands as and the rest is the command to execute
+ # This will default to "sudo -u" if not specified anywhere.
+ sudo = "doas -u";
+
# This is an optional list of arguments that will be passed to SSH.
sshOpts = [ "-p" "2121" ];