diff options
| author | Ryo Nakamura <upa@haeena.net> | 2024-02-06 10:35:38 +0900 |
|---|---|---|
| committer | Ryo Nakamura <upa@haeena.net> | 2024-02-06 10:35:38 +0900 |
| commit | ff45d9d71b85a618aed6d3d5e5056bada6ff81f9 (patch) | |
| tree | 8f5989f7f30f8e8a9320128617fa63e22115d65a /doc | |
| parent | 9908fb309d9388481769e1a558a1f8dc47c4dabf (diff) | |
add two env vars to pass password/keyphrase (#9)
MSCP_SSH_AUTH_PASSWORD passes a password, and MSCP_SSH_AUTH_PASSPHRASE
passes a passphrase for publickey auth. They enable avoiding interactive
password input. Test cases are also added.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mscp.1.in | 18 | ||||
| -rw-r--r-- | doc/mscp.rst | 15 |
2 files changed, 32 insertions, 1 deletions
diff --git a/doc/mscp.1.in b/doc/mscp.1.in index 545ea09..b329c27 100644 --- a/doc/mscp.1.in +++ b/doc/mscp.1.in @@ -236,6 +236,24 @@ Prints help. .SH EXIT STATUS Exit status is 0 on success, and >0 if an error occurs. +.SH ENVIRONMENT + +.PP +.B mscp +recognizes the following environment variables. + +.TP +.B MSCP_SSH_AUTH_PASSWORD +This environment variable passes a password for password +authentication to establish SSH connections. + +.TP +.B MSCP_SSH_AUTH_PASSPHRASE +This environment variable passes a passphrase for public-key +authentication for establishing SSH connections. + + + .SH NOTES .PP diff --git a/doc/mscp.rst b/doc/mscp.rst index ca4cf44..c4ed35b 100644 --- a/doc/mscp.rst +++ b/doc/mscp.rst @@ -2,7 +2,7 @@ MSCP ==== -:Date: v0.1.3 +:Date: v0.1.3-15-g9908fb3 NAME ==== @@ -147,6 +147,19 @@ EXIT STATUS Exit status is 0 on success, and >0 if an error occurs. +ENVIRONMENT +=========== + +**mscp** recognizes the following environment variables. + +**MSCP_SSH_AUTH_PASSWORD** + This environment variable passes a password for password + authentication to establish SSH connections. + +**MSCP_SSH_AUTH_PASSPHRASE** + This environment variable passes a passphrase for public-key + authentication for establishing SSH connections. + NOTES ===== |