X-Git-Url: https://git.hcoop.net/hcoop/debian/courier-authlib.git/blobdiff_plain/ac40fd9eb9d1980c90dc009d526a23ead1ec0f76..refs/tags/upstream/0.63.0:/userdb/makeuserdb.html.in?pf=hcoop%2Fdebian diff --git a/userdb/makeuserdb.html.in b/userdb/makeuserdb.html.in index 7aa2332..c4f01f0 100644 --- a/userdb/makeuserdb.html.in +++ b/userdb/makeuserdb.html.in @@ -1,11 +1,11 @@ -
make â create @userdb@
makeuserdb
[-f filename
]
pw2userdb
vchkpw2userdb
[--vpopmailhome=dir
] [--todir=dir
]
-makeuserdb creates @userdb@.dat
from
+-->
makeuserdb â create @userdb@
makeuserdb
[-f filename
]
pw2userdb
vchkpw2userdb
[--vpopmailhome=dir
] [--todir=dir
]
+makeuserdb creates @userdb@.dat
from
the contents of @userdb@
.
@userdb@
's contents are described later in this document.
Maildrop,
@@ -24,13 +24,13 @@ when there's a large number of accounts it will be significantly faster to
search
@userdb.dat@
, which is a binary database,
instead of a flat text file that the system password file usually is.
-The makeuserdb command can be safely executed during +The makeuserdb command can be safely executed during normal system activity.
The -f
option creates
from
filename
.dat
, instead of the
default filename
@userdb@.dat
from
-@userdb@
.
@userdb@
+@userdb@
.
@userdb@
@userdb@
is a plain text file that can be created using
any text editor. Blank lines are ignored. Lines that start with the #
character are comments, and are also ignored.
@@ -62,7 +62,7 @@ directory.
login shell.
systempw
- value
is the account's
password. See
-userdbpw(8)
+userdbpw(8)
for details on how to set up this field.
pop3pw, esmtppw, imappw...
- value
specifies a separate password used only for authenticating access using a
@@ -72,7 +72,7 @@ restricted only to certain services, such as POP3, even if other services
are also enabled on the server.
mail
- value
specifies the location of
the account's Maildir mailbox. This is an optional field that is normally
-used when userdb is used to provide aliases for other
+used when userdb is used to provide aliases for other
mail accounts. For example, one particular multi-domain E-mail
service configuration
that's used by both Qmail and
@@ -80,7 +80,7 @@ that's used by both Qmail and
mailbox in a virtual domain, such as "user@example.com", to a local mailbox
called "example-user". Instead of requiring the E-mail account
holder to log in as
-"example-user" to download mail from this account, a userdb
+"example-user" to download mail from this account, a userdb
entry for "user@example.com" is set up with mail
set to the
location of example-user's Maildir mailbox, thus hiding the internal
mail configuration from the E-mail account holder's view.
@@ -91,37 +91,37 @@ This has nothing to do with actual filesystem quotas. software-based Maildir quota enforcement mechanism which requires additional setup and configuration. See -maildirquota(7) -for additional information.
@userdb@shadow.dat
All fields whose name ends with 'pw' will NOT copied to
@userdb@.dat
. These fields will be copied to
@userdb@shadow.dat
.
-makeuserdb creates @userdb@shadow.dat
+makeuserdb creates @userdb@shadow.dat
without any group and world permissions.
-Note that makeuserdb reports an error
-if @userdb@ has any group
-or world permissions.
/etc/passwd
+Note that makeuserdb reports an error
+if @userdb@ has any group
+or world permissions./etc/passwd
and vpopmail to @userdb@
format
-pw2userdb reads the /etc/passwd
and
+pw2userdb reads the /etc/passwd
and
/etc/shadow
files and converts all entries to the
@userdb@
format,
printing the result on standard output.
-The output of pw2userdb
-can be saved as @userdb@ (or as some file in this
+The output of pw2userdb
+can be saved as @userdb@ (or as some file in this
subdirectory).
Linear searches of /etc/passwd
can
be very slow when you have
tens of thousands of accounts.
-Programs like maildrop always look in
+Programs like maildrop always look in
@userdb@
first.
By saving the system password file in
@userdb@
it is possible to significantly reduce the
amount of
time it takes to look up this information.
-After saving the output of pw2userdb, you must still run
-makeuserdb to create
+After saving the output of pw2userdb, you must still run
+makeuserdb to create
@userdb@.dat
.
-vchkpw2userdb converts a vpopmail-style
+vchkpw2userdb converts a vpopmail-style
directory hierarchy to the @userdb@
format.
This is an external virtual domain management package that's often used
with Qmail servers.
@@ -138,12 +138,12 @@ multiple domains. For example,
has the passwd file for the domain example.com
.
Some systems also have a soft link, domains/default
,
that points to a domain that's considered a "default" domain.
-The vchkpw2userdb reads all this information, and tries to
+The vchkpw2userdb reads all this information, and tries to
convert it into the @userdb@
format. The
--vpopmailhost
option specifies the top level
directory, if it is
not the home directory of the vpopmail account.
-The vchkpw2userdb script prints the results on standard
+The vchkpw2userdb script prints the results on standard
output. If specified, the --todir
option
tries to convert all
vpasswd
files one at a time, saving each one
@@ -152,15 +152,15 @@ mkdir @userdb@
vchkpw2userdb --todir=@userdb@/vpopmail
makeuserdb
-It is still necessary to run makeuserdb, of course, to
+It is still necessary to run makeuserdb, of course, to
create the binary database file @userdb@.dat
-NOTE: You are still required to create the @userdb@ entry
+NOTE: You are still required to create the @userdb@ entry
which maps
system userids back to accounts,
"uid
=<TAB>name
",
-if that's applicable. vchkpw2userdb will not do it for
+if that's applicable. vchkpw2userdb will not do it for
you.
-NOTE: makeuserdb may complain about duplicate entries, if
+NOTE: makeuserdb may complain about duplicate entries, if
your "default" entries in users/vpasswd
or
domains/default/vpasswd
are the same as anything in any
other @userdb@
file. It is also likely that you'll end
@@ -171,25 +171,25 @@ entries - you'll have entries for both user
user@example.com
.
If you intend to maintain the master set of accounts using
vchkpw/vpopmail,
in order to avoid cleaning this up every time, you might want to consider
-doing the following: run vchkpw2userdb once, using the
+doing the following: run vchkpw2userdb once, using the
--todir
option.
Then, go into the resulting directory, and
replace one of the redundant files with a soft link to
/dev/null
.
This allows you to run
-vchkpw2userdb without having to go in and
-cleaning up again, afterwards.
@userdb@
@userdb@.dat
@userdb@shadow.dat
@tmpdir@/userdb.tmp
 - temporary file
@tmpdir@/userdbshadow.tmp
 - temporary file
-