Skip to content

Commit 28beafa

Browse files
committed
Add a note on bash history and sudo password.
1 parent 6f880d2 commit 28beafa

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/source/reference/runners.rst

+10
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,16 @@ This is a remote runner. This runner executes a Linux command on one or more rem
5252
by the user. The last newline character is stripped from ``stdout`` and ``stderr`` fields in the
5353
output.
5454

55+
.. note::
56+
57+
By default |st2| uses paswordless sudo for system user which is used to execute commands on
58+
local and remote systems. In addition to paswordless sudo, local and remote runners also support
59+
password protected sudo via ``sudo_password`` runner parameter. With the remote runner, sudo
60+
password is passed to the sudo command as a command line argument which means it has some
61+
security implications - if bash history is enabled for the system user under which |st2|
62+
remote commands run, this command which includes sudo password will be saved in bash history
63+
and any system user which access to that user bash history file will be able to view it.
64+
5565
Runner Parameters
5666
^^^^^^^^^^^^^^^^^
5767

0 commit comments

Comments
 (0)