1PAM_MKHOMEDIR(8)               Linux-PAM Manual               PAM_MKHOMEDIR(8)
2
3
4

NAME

6       pam_mkhomedir - PAM module to create users home directory
7

SYNOPSIS

9       pam_mkhomedir.so [silent] [debug] [umask=mode] [skel=skeldir]
10

DESCRIPTION

12       The pam_mkhomedir PAM module will create a users home directory if it
13       does not exist when the session begins. This allows users to be present
14       in central database (such as NIS, kerberos or LDAP) without using a
15       distributed file system or pre-creating a large number of directories.
16       The skeleton directory (usually /etc/skel/) is used to copy default
17       files and also sets a umask for the creation.
18
19       The new users home directory will not be removed after logout of the
20       user.
21

OPTIONS

23       silent
24           Don't print informative messages.
25
26       debug
27           Turns on debugging via syslog(3).
28
29       umask=mask
30           The user file-creation mask is set to mask. The default value of
31           mask is 0022.
32
33       skel=/path/to/skel/directory
34           Indicate an alternative skel directory to override the default
35           /etc/skel.
36

MODULE TYPES PROVIDED

38       Only the session module type is provided.
39

RETURN VALUES

41       PAM_BUF_ERR
42           Memory buffer error.
43
44       PAM_PERM_DENIED
45           Not enough permissions to create the new directory or read the skel
46           directory.
47
48       PAM_USER_UNKNOWN
49           User not known to the underlying authentication module.
50
51       PAM_SUCCESS
52           Environment variables were set.
53

FILES

55       /etc/skel
56           Default skel directory
57

EXAMPLES

59       A sample /etc/pam.d/login file:
60
61             auth       requisite   pam_securetty.so
62             auth       sufficient  pam_ldap.so
63             auth       required    pam_unix.so
64             auth       required    pam_nologin.so
65             account    sufficient  pam_ldap.so
66             account    required    pam_unix.so
67             password   required    pam_unix.so
68             session    required    pam_mkhomedir.so skel=/etc/skel/ umask=0022
69             session    required    pam_unix.so
70             session    optional    pam_lastlog.so
71             session    optional    pam_mail.so standard
72
73
74

SEE ALSO

76       pam.d(5), pam(8).
77

AUTHOR

79       pam_mkhomedir was written by Jason Gunthorpe <jgg@debian.org>.
80
81
82
83Linux-PAM Manual                  11/25/2020                  PAM_MKHOMEDIR(8)
Impressum