Merge commit '3b735dd9330e0989f51a76771c3303031154154e' into 21158-wf-page-list
[arvados.git] / lib / pam / README
1 For configuration advice, please refer to https://doc.arvados.org/install/install-webshell.html
2
3 Usage (in pam config):
4
5     pam_arvados.so arvados_api_host my_vm_hostname ["insecure"] ["debug"]
6
7 pam_arvados.so passes authentication if (according to
8 arvados_api_host) the supplied PAM token belongs to an Arvados user
9 who is allowed to log in to my_vm_host_name with the supplied PAM
10 username.
11
12 If my_vm_hostname is omitted or "-", the current hostname is used.
13
14 "insecure" -- continue even if the TLS certificate presented by
15 arvados_api_host fails verification.
16
17 "debug" -- enable debug-level log messages in syslog and (when not in
18 "silent" mode) on the calling application's stderr.