Handle hostnames with upper-case letters
[webmin.git] / useradmin / help.html
1 <body bgcolor=#ffffff>
2 <title>Users and Groups</title>
3 <center><img src="images/useradmin.gif"></center><br>
4 <h2><i>This help page is incomplete</i></h2>
5 <hr>
6 <h3>Introduction</h3>
7 This module allows you to create, edit and delete Unix users and groups.
8 Typically, there is one Unix user account for each person who wants to
9 login to your system. In addition, various system programs will have
10 their own accounts, such as <tt>uucp</tt> or <tt>www</tt>. Every user
11 belongs to one or more groups, one of which is the primary group for
12 the user. <p>
13
14 The main <tt>Users and Groups</tt> page shows all the local users and
15 groups on your system. NIS and NIS+ users and groups will not be shown
16 in the list, because they are not stored locally and cannot be edited.
17 However, groups can contain NIS users and users can have an NIS group
18 as their primary group. <p>
19
20 If your machine is an NIS or NIS+ server and the table sources
21 are not <tt>/etc/passwd</tt> and <tt>/etc/group</tt>, you can change the
22 <a href="../config.cgi?useradmin">module configuration</a> to edit the
23 appropriate files. The <tt>Command to run after change</tt> parameter can
24 be set to something like <tt>cd /var/yp ; make</tt> to update NIS maps
25 after every change to the password and group files. <p>
26
27 <hr>
28 <h3>Editing an Existing User</h3>
29 To edit a user, just click on the user's name from the list on the
30 main page. This will display a form in which you can edit the following
31 user details :<p>
32         <ul>
33         <li><b>Username</b><br>
34             The name that the user uses to login to the system. Each user
35             must have a unique login name. <p>
36         <li><b>Real name</b><br>
37             The user's real name. This is stored in the comment field in
38             the password file. <p>
39         <li><b>Encrypted password</b> and <b>Plain text password</b><br>
40             The Unix password file stores passwords in one-way encrypted
41             form only. This means that the form cannot display the user's
42             plain-text password, only the encrypted form. To set a new
43             password for a user you can either enter the password into
44             the <tt>Plain text password</tt> field, or copy and paste an
45             encrypted string into the <tt>Encrypted password</tt> field. <p>
46         <li><b>Password type</b><br>
47             If you choose <tt>No password</tt> here, then no password is
48             needed to login to the account. If you choose <tt>Locked</tt>,
49             then no login is allowed. Only if <tt>Normal password</tt> is
50             chosen will the passwords described above be used. <p>
51         <li><b>Unix UID</b><br>
52             The UID is the number that the system <b>really</b> uses for
53             controlling access to files. Every user should have a unique
54             UID. If you change the Unix UID, then the <tt>Change UID</tt>
55             option at the bottom of the page determines what happens to
56             files owned by that user. <p>
57         <li><b>Home directory</b><br>
58             Every user should have a home directory to store personal files.
59             Typically, user home directories are all located under one
60             parent directory, such as <tt>/home</tt>. <p>
61         <li><b>Shell program</b><br>
62             When a user logs into the system, their shell program is run to
63             process whatever commands the user types. If a user has a shell
64             like <tt>/bin/false</tt>, then they will not be able to login.
65             This is useful for users who should only have FTP or email
66             access. <p>
67         <li><b>Primary group</b><br>
68             A user's primary group is the group which will usually be
69             assigned to any new files the user creates. If you change the
70             primary group, the <tt>Change GID</tt> option at the bottom
71             of the page controls what happens to files owned by that user
72             and group. <p>
73         <li><b>Other groups</b><br>
74             This is a list of all the other groups a user belongs to. Only
75             local groups will be shown, not NIS or NIS+ groups. <p>
76         </ul><p>
77 Some other user properties are only available if your system has a
78 shadow password file and the module configuration knows about it. They
79 are :<p>
80         <ul>
81         <li><b>foo</b><br>
82             foo. <p>
83         </ul><p>
84
85 <hr>
86 <h3>Creating a New User</h3>
87 To create a new user, click on the <tt>Create New User</tt> link below
88 the list of existing users on the main page. This will display the same
89 form as is used for editing a user, but with almost all the fields empty.
90 The only field that will be automatically filled in for you is the UID,
91 which Webmin will compute by picking a free UID at the end of a sequence
92 of existing UIDs. <p>
93
94 When a new user is created, the user's home directory can be created as
95 well. To have webmin create and set the permissions on the directory you
96 specify, choose <tt>Create home directory</tt> at the bottom of the page.
97 You should do this for all normal users you add. <p>
98
99 The <tt>Files to copy</tt> option in the module preferences can be used
100 to copy various files (such as <tt>.cshrc</tt> or <tt>.profile</tt>) into
101 the home directory of a newly created user. You should change this
102 parameter to a space-separated list of files to copy. <p>
103
104 <hr>
105 <h3>Deleting a User</h3>
106 To delete an existing user, click on the <tt>Delete</tt> button in the
107 user details form. This will take you to a page asking if you want to
108 delete the user's home directory as well. Be very careful when choosing
109 to do this, as some system users have the root directory as their 
110 home directory. <p>
111
112 In general, you should never change the UID, username or shell of system
113 users such as <tt>root</tt>, <tt>bin</tt> or <tt>nobody</tt>. Doing so
114 could make your system unusable or unbootable. Do not try to delete any
115 of these users either, <b>especially</b> <tt>root</tt>. <p>
116
117 <hr>
118 <h3>Editing an Existing Group</h3>
119 To edit a group, click on the group name from the list of groups on the
120 main page. This will bring you to a form in which you can edit the
121 following group properties :
122         <ul>
123         <li><b>Group name</b><br>
124             The unique name for this group. <p>
125         <li><b>Group GID</b><br>
126             Like this UID for a Unix user, this is a number that the system
127             uses to identify the group. Each group should have a unique
128             GID. <p>
129         <li><b>Members</b><br>
130             The list of all users in this group. This can include NIS or
131             NIS+ users as well, if they are in use on your system. <p>
132         <li><b>Password</b><br>
133             Not used? <p>
134         </ul><p>
135
136 <hr>
137 <h3>Creating a New Group</h3>
138 To create a new group, click on the <tt>Create new group</tt> link 
139 beneath the list of existing groups. This links to the same form as is
140 used for editing an existing group, but with all the fields blank except
141 for the GID. This is automatically filled by finding a free GID for the
142 new group. <p>
143
144 <hr>
145 <h3>Deleting a Group</h3>
146 To delete an existing group, click on the <tt>Delete Group</tt> button
147 on the group details page. This will immediately delete the group without
148 asking. No files or directories will be deleted though. <p>
149
150 <hr>
151 <a href="/"><img alt="<-" align=middle border=0 src=/images/left.gif></a>
152 &nbsp;&nbsp;<a href="">Return to module</a><p>
153  
154