diff -r 30113bfbe723 -r b3afb9f1e801 doc/configuration.txt --- a/doc/configuration.txt Sun Jan 20 00:12:17 2008 +0100 +++ b/doc/configuration.txt Sun Jan 20 00:22:09 2008 +0100 @@ -1,58 +1,24 @@ + [Top] [Contents] [Index] [ ? ] Vmailmgr Configuration Files - -14 September 2000 - - Bruce Guenter + 1. General Information + 2. Configuration Files _________________________________________________________________ - - Table of Contents - - * 1. General Information - + 1.1 Search Order - + 1.2 File Types - + 1.3 Command Execution - * 2. Configuration Files - + 2.1 authvmailmgr-error - + 2.2 authvmailmgr-loginfail - + 2.3 authvmailmgr-postsetuid - + 2.4 authvmailmgr-presetuid - + 2.5 autoresponse-dir - + 2.6 autoresponse-file - + 2.7 bulletin-dir - + 2.8 checkvpw-error - + 2.9 checkvpw-loginfail - + 2.10 checkvpw-postexec - + 2.11 checkvpw-postsetuid - + 2.12 checkvpw-presetuid - + 2.13 default-expiry - + 2.14 default-maildir - + 2.15 default-msgcount - + 2.16 default-msgsize - + 2.17 default-hardquota - + 2.18 default-softquota - + 2.19 default-username - + 2.20 error-maildir - + 2.21 global-bulletin-dir - + 2.22 maildir-arg-str - + 2.23 password-file - + 2.24 postmaster-aliases - + 2.25 postmaster-email - + 2.26 qmail-root - + 2.27 separators - + 2.28 socket-file - + 2.29 user-dir - + 2.30 user-dir-bits - + 2.31 user-dir-slices - + 2.32 vdeliver-postdeliver - + 2.33 vdeliver-predeliver - + 2.34 vsetup-pre - + 2.35 vsetup-pre + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + + 1. General Information + + 1.1 Search Order + 1.2 File Types + 1.3 Command Execution _________________________________________________________________ - - 1. General Information - + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 1.1 Search Order The system will look for the configuration files listed below in one @@ -60,7 +26,7 @@ 1. The domain-local configuration directory 2. The user-local configuration directory 3. The global configuration directory - + The global configuration directory is set to `/etc/vmailmgr' by default. The user-local and domain-local configuration directories (for now, one and the same) are a subdirectory, named `.vmailmgr' by @@ -68,10 +34,15 @@ subdirectory. If a file matching the configuration name is found in one of the local directories, the search stops and it is not searched for in any higher up directories. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 1.2 File Types Each of the configuration files falls into one of the following types: + String A single line is read from this type and used as-is with no conversion. All data after the first line is ignored. @@ -92,23 +63,27 @@ If the execute bits on the file are set, it is treated as an executable file and is executed with no interpretation by vmailmgr. The the Command Execution section below for details. - + All lines are stripped of any leading or trailing white space. - + Configuration files marked as `(global only)' are read before any user-level processing occurrs, and so are not functional in the user-level configuration. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 1.3 Command Execution The following rules apply to executing a single command or a list of commands. - + The executables are searched in reverse order of the configuration files. That is, the global setting is used first, and then the local settings. If the named file either does not exist in a directory or is not executable, that directory is skipped. - + A command exit code of `99' indicates that the command completed successfully but no further commands should be executed. All other non-zero exit codes are treated as an error and will cause the @@ -118,8 +93,9 @@ `qmail-command' man page for full details on delivery error codes. For `checkvpw', any non-zero exit code (except as described above) will cause authentication to fail. - + The following environment variables will be set (where applicable): + `HOME' The home directory of the real user. `MAILDIR' @@ -147,11 +123,55 @@ `VUSER_SOFTQUOTA' The virtual user's total size soft quota (in bytes, or "-" if not applicable). - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2. Configuration Files - + Each of the following sections identifies a single configuration file - + + 2.1 authvmailmgr-error + 2.2 authvmailmgr-loginfail + 2.3 authvmailmgr-postsetuid + 2.4 authvmailmgr-presetuid + 2.5 autoresponse-dir + 2.6 autoresponse-file + 2.7 bulletin-dir + 2.8 checkvpw-error + 2.9 checkvpw-loginfail + 2.10 checkvpw-postexec + 2.11 checkvpw-postsetuid + 2.12 checkvpw-presetuid + 2.13 default-expiry + 2.14 default-maildir + 2.15 default-msgcount + 2.16 default-msgsize + 2.17 default-hardquota + 2.18 default-softquota + 2.19 default-username + 2.20 error-maildir + 2.21 global-bulletin-dir + 2.22 maildir-arg-str + 2.23 password-file + 2.24 postmaster-aliases + 2.25 postmaster-email + 2.26 qmail-root + 2.27 separators + 2.28 socket-file + 2.29 user-dir + 2.30 user-dir-bits + 2.31 user-dir-slices + 2.32 vdeliver-postdeliver + 2.33 vdeliver-predeliver + 2.34 vsetup-post + 2.35 vsetup-pre + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.1 authvmailmgr-error Type @@ -166,7 +186,11 @@ environment variable AUTHVMAILMGR_ERROR will contain an error message. This can be used to output logging messages about errors in authvmailmgr. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.2 authvmailmgr-loginfail Type @@ -182,19 +206,27 @@ virtual user name if it has been determined. This can be used to output logging messages about login failures or to throttle hackers. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.3 authvmailmgr-postsetuid Type executable Default - @samp {vpopbull} + `vpopbull' Used By authvmailmgr Description This is executed by authvmailmgr after a user is successfully authenticated. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.4 authvmailmgr-presetuid Type @@ -210,7 +242,11 @@ user has not yet been authenticated, or even looked up at this point. For the same reason, `VUSER' is not authenticated and is under complete control of the invoking user. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.5 autoresponse-dir Type @@ -222,7 +258,11 @@ Description Identifies the subdirectory of the virtual user directory in which all autoresponse data is stored. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.6 autoresponse-file Type @@ -234,7 +274,11 @@ Description Identifies the file name within the autoresponse directory that contains the autoresponse message. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.7 bulletin-dir Type @@ -246,7 +290,11 @@ Description Identifies the subdirectory of the domain directory in which bulletins local to a domain are stored. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.8 checkvpw-error Type @@ -260,7 +308,11 @@ those caught by `checkvpw-loginfail' below. The environment variable CHECKVPW_ERROR will contain an error message. This can be used to output logging messages about errors in checkvpw. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.9 checkvpw-loginfail Type @@ -276,7 +328,11 @@ virtual user name if it has been determined. This can be used to output logging messages about login failures or to throttle hackers. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.10 checkvpw-postexec Type @@ -288,19 +344,27 @@ Description This is executed by checkvpw after the subcommand successfully completes. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.11 checkvpw-postsetuid Type executable Default - @samp {vpopbull} + `vpopbull' Used By checkvpw Description This is executed by checkvpw after a user is successfully authenticated. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.12 checkvpw-presetuid Type @@ -316,7 +380,11 @@ user has not yet been authenticated, or even looked up at this point. For the same reason, `VUSER' is not authenticated and is under complete control of the invoking user. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.13 default-expiry Type @@ -328,7 +396,11 @@ Description Sets the default expiry value for newly created users. Negative values indicate no expiry. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.14 default-maildir Type @@ -340,7 +412,11 @@ Description Sets the name of the directory to be used as a non-virtual user's maildir. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.15 default-msgcount Type @@ -351,7 +427,11 @@ vadduser Description Sets the default message count limit. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.16 default-msgsize Type @@ -362,7 +442,11 @@ vadduser Description Sets the default message size limit, in bytes. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.17 default-hardquota Type @@ -373,7 +457,11 @@ vadduser Description Sets the default hard quota, in bytes. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.18 default-softquota Type @@ -384,7 +472,11 @@ vadduser Description Sets the default soft quota, in bytes. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.19 default-username Type @@ -396,7 +488,11 @@ Description Identifies the name of the virtual user to be looked up if a lookup of another virtual user fails. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.20 error-maildir Type @@ -409,7 +505,11 @@ Specifies the path of a read-only maildir containing a message to be sent to the user when the maildir corresponding to that user does not exist. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.21 global-bulletin-dir Type @@ -420,7 +520,11 @@ checkvpw Description Identifies a site-wide bulletin directory. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.22 maildir-arg-str Type @@ -432,7 +536,11 @@ Description Identifies the string to search for when attempting to identify the maildir argument on the command line to checkvpw. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.23 password-file Type @@ -446,7 +554,11 @@ destinations for a virtual domain. Note that this has nothing to do with "real" users, for which the password file is determined by the system libraries. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.24 postmaster-aliases Type @@ -461,7 +573,11 @@ This should always contain both `postmaster' and `mailer-daemon' (required by the RFCs), and should usually contain `root'. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.25 postmaster-email Type @@ -478,7 +594,11 @@ host name. If no `@' is present, the current virtual host name is filled in by vdeliver. If this is set to `postmaster', a mail loop will result and all mail to this address will bounce. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.26 qmail-root Type @@ -491,7 +611,11 @@ Specifies the location of the base directory of your qmail install. Set this to whatever you put into `conf-home' when you built and installed qmail. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.27 separators Type @@ -506,7 +630,11 @@ logging in via checkvpw. For example, if separators contains `@:' then `user@domain' and `user:domain' are equivalent POP mailbox names. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.28 socket-file Type @@ -520,7 +648,11 @@ communicate between the vmailmgr daemon and the other programs. Warning: Changing this in the local configuration directories will cause vdeliver to fail. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.29 user-dir Type @@ -535,7 +667,11 @@ maildir is recorded in the password table, it does not have to be the same for each user within a domain. This is prefixed with `./' before it is used in the password table. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.30 user-dir-bits Type @@ -544,8 +680,12 @@ Used By vmailmgrd and command-line programs when creating new users. Description - See section 2.31 user-dir-slices - + See section 2.31 user-dir-slices. + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.31 user-dir-slices Type @@ -567,7 +707,11 @@ For example, with `user-dir-bits' set to 6 and `user-dir-slices' set to 1, a user named `c' maps to a directory name of `users/2f/c/'. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.32 vdeliver-postdeliver Type @@ -582,7 +726,11 @@ it does not set them itself. If the command returns with an error code, a warning is printed, but delivery does not fail, as failure would lead to duplicates. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.33 vdeliver-predeliver Type @@ -596,8 +744,12 @@ after the virtual user information is looked up. Since vdeliver expects `USER' and `HOME' to be set, it does not set them itself. - -2.34 vsetup-pre + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + +2.34 vsetup-post Type executable @@ -608,7 +760,11 @@ Description This list is executed after the vsetup command has sucessfully done everything else. - + _________________________________________________________________ + + [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ + ? ] + 2.35 vsetup-pre Type @@ -621,6 +777,102 @@ This list is executed before the vsetup command makes any changes. _________________________________________________________________ - - This document was generated on 14 September 2000 using - texi2html 1.56k. + + [Top] [Contents] [Index] [ ? ] + + Table of Contents + + 1. General Information + + 1.1 Search Order + 1.2 File Types + 1.3 Command Execution + + 2. Configuration Files + 2.1 authvmailmgr-error + 2.2 authvmailmgr-loginfail + 2.3 authvmailmgr-postsetuid + 2.4 authvmailmgr-presetuid + 2.5 autoresponse-dir + 2.6 autoresponse-file + 2.7 bulletin-dir + 2.8 checkvpw-error + 2.9 checkvpw-loginfail + 2.10 checkvpw-postexec + 2.11 checkvpw-postsetuid + 2.12 checkvpw-presetuid + 2.13 default-expiry + 2.14 default-maildir + 2.15 default-msgcount + 2.16 default-msgsize + 2.17 default-hardquota + 2.18 default-softquota + 2.19 default-username + 2.20 error-maildir + 2.21 global-bulletin-dir + 2.22 maildir-arg-str + 2.23 password-file + 2.24 postmaster-aliases + 2.25 postmaster-email + 2.26 qmail-root + 2.27 separators + 2.28 socket-file + 2.29 user-dir + 2.30 user-dir-bits + 2.31 user-dir-slices + 2.32 vdeliver-postdeliver + 2.33 vdeliver-predeliver + 2.34 vsetup-post + 2.35 vsetup-pre + _________________________________________________________________ + + [Top] [Contents] [Index] [ ? ] + + Short Table of Contents + + 1. General Information + 2. Configuration Files + _________________________________________________________________ + + [Top] [Contents] [Index] [ ? ] + + About this document + + This document was generated by Bruce.Guenter.dyndns.org on December, + 29 2004 using texi2html + + The buttons in the navigation panels have the following meaning: + + Button Name Go to From 1.2.3 go to + [ < ] Back previous section in reading order 1.2.2 + [ > ] Forward next section in reading order 1.2.4 + [ << ] FastBack previous or up-and-previous section 1.1 + [ Up ] Up up section 1.2 + [ >> ] FastForward next or up-and-next section 1.3 + [Top] Top cover (top) of document + [Contents] Contents table of contents + [Index] Index concept index + [ ? ] About this page + + where the Example assumes that the current position is at + Subsubsection One-Two-Three of a document of the following structure: + * 1. Section One + + * 1.1 Subsection One-One + + * ... + + 1.2 Subsection One-Two + * 1.2.1 Subsubsection One-Two-One + * 1.2.2 Subsubsection One-Two-Two + * 1.2.3 Subsubsection One-Two-Three <== Current Position + * 1.2.4 Subsubsection One-Two-Four + + 1.3 Subsection One-Three + * ... + + 1.4 Subsection One-Four + _________________________________________________________________ + + This document was generated by Bruce.Guenter.dyndns.org on December, + 29 2004 using texi2html