added sendmailrestart and sendmailconfigpath config files

[freeside.git] / htdocs / docs / config.html

diff --git a/htdocs/docs/config.html b/htdocs/docs/config.html
index 3c7c0bd..c824b74 100644 (file)
--- a/htdocs/docs/config.html
+++ b/htdocs/docs/config.html
@@ -28,6 +28,7 @@ All further configuration files and directories are located in
   <li>bindprimary - Your BIND primary nameserver.  This enables export of /var/named/named.conf and zone files into /var/named
   <li>bindsecondaries - Your BIND secondary nameservers, one per line.  This enables export of /var/named/named.conf
   <li>bsdshellmachines - Your BSD flavored shell (and mail) machines, one per line.  This enables export of `/etc/passwd' and `/etc/master.passwd'.
+  <li>countrydefault - Default two-letter country code (if not supplied, the default is `US')
   <li>cybercash2 - <a href="http://www.cybercash.com/cybercash/services/cashreg214.html">CyberCash v2</a> support, four lines: paymentserverhost, paymentserverport, paymentserversecret, and transaction type (`mauthonly' or `mauthcapture').  CCLib.pm is required.
   <li>cybercash3.2 - <a href="http://www.cybercash.com/cybercash/services/technology.html">CyberCash v3.2</a> support.  Two lines: the full path and name of your merchant_conf file, and the transaction type (`mauthonly' or `mauthcapture').  CCMckLib3_2.pm, CCMckDirectLib3_2.pm and CCMckErrno3_2 are required.
   <li>deletecustomers - The existance of this file will enable customer deletions.  Be very careful!  Deleting a customer will remove all traces that this customer ever existed!  It should probably only be used when auditing a legacy database.  Normally, you cancel all of a customers' packages if they cancel service.
@@ -38,10 +39,11 @@ All further configuration files and directories are located in
   <li>hidecancelledcustomers - The existance of this file will prevent customers with only cancelled packages from showing up in listings (though they will still be in the database)
   <li>home - For new users, prefixed to usrename to create a directory name.  Should have a leading but not a trailing slash.
   <li>icradiusmachines - Your <a href="ftp://ftp.cheapnet.net/pub/icradius">ICRADIUS</a> machines, one per line.  The existance of this file (even if empty) turns on radcheck table creation (in the freeside database - the radcheck table needs to be created manually).  Machines listed in this file will have the radcheck table exported to them.  Each line of this file should contain four items, separted by whitespace: machine name, MySQL database name, MySQL username, and MySQL password.  For example: "<CODE>radius.isp.tld&nbsp;radius_db&nbsp;radius_user&nbsp;passw0rd</CODE>".  Note that to use ICRADIUS export you need to be using MySQL.
-  <li>icradius_mysqldest - Destination directory for the MySQL radcheck table files, on the ICRADIUS machines.  Defaults to "/usr/local/var/radius".
+  <li>icradius_mysqldest - Destination directory for the MySQL databases, on the ICRADIUS machines.  Defaults to "/usr/local/var/".
   <li>icradius_mysqlsource - Source directory for for the MySQL radcheck table files, on the Freeside machine.  Defaults to "/usr/local/var/freeside".
   <li>invoice_from - Return address on email invoices.
   <li>lpr - Print command for paper invoices, for example `lpr -h'.
+  <li>maildisablecatchall - The existance of this file will disable the requirement that each virtual domain have a catch-all mailbox.
   <li>mxmachines - MX entries for new domains, weight and machine, one per line, with trailing `.'
   <li>nsmachines - NS nameservers for new domains, one per line, with trailing `.'
   <li>nismachines - Your NIS master (not slave master) machines, one per line.  This enables export of `/etc/global/passwd' and `/etc/global/shadow'.
@@ -59,7 +61,9 @@ All further configuration files and directories are located in
           <li>registries/internic/to - Email address to which InterNIC domain registrations are sent.
         </ul>
     </ul>
+  <li>sendmailconfigpath - Sendmail configuration file path - defaults to `/etc'.  Many newer distributions use `/etc/mail'.
   <li>sendmailmachines - Your sendmail machines, one per line.  This enables export of `/etc/virtusertable' and `/etc/sendmail.cw'.
+  <li>sendmailrestart - If defined, the command which is run on sendmail machines after files are copied.
   <li>shellmachine - A single machine with user home directories mounted.  This enables home directory creation, renaming and archiving/deletion.  In conjunction with `qmailmachines', it also enables `.qmail-extension' file maintenance.
   <li>shellmachines - Your Linux and System V flavored shell (and mail) machines, one per line.  This enables export of `/etc/passwd' and `/etc/shadow' files.
   <li>shells - Legal shells (think /etc/shells).  You probably want to `cut -d: -f7 /etc/passwd | sort | uniq' initially so that importing doesn't fail with `Illegal shell' errors, then remove any special entries afterwords.  A blank line specifies that an empty shell is permitted.
@@ -71,6 +75,7 @@ All further configuration files and directories are located in
   <li>soamachine - SOA machine for new domains, with trailing `.'
   <li>soarefresh - SOA refresh for new domains
   <li>soaretry - SOA retry for new domains
+  <li>textradiusprepend - The contents of this file will be prepended to the first line of a user's RADIUS entry in text exports.  If necessary, usually `Auth-Type = Local, '.
   <li>usernamemin - Minimum username length (default 2);
   <li>usernamemax - Maximum username length (default is the size of the SQL column, probably specified when fs-setup was run)
 </ul>