configuration option to edit referrals of existing customers
[freeside.git] / htdocs / docs / config.html
1 <head>
2   <title>Configuration files</title>
3 </head>
4 <body>
5   <h1>Configuration files</h1>
6 Configuration file layout has changed in 1.2.x.
7 <ul>
8   <li>First, the file `/usr/local/etc/freeside/mapsecrets' is read.  Each line
9 in this file contains a username and filename, separated by whitespace.  Note
10 that these are not local usernames - they are passed from Apache (you _did_
11 setup <a href="">
12 user authetication</a>, correct?).  Filenames are located in 
13 `/usr/local/etc/freeside/'.  The specified filename is parsed exactly
14 the same as the pre-1.2.x `secrets' file:
15   <li>Three lines: Database engine datasource (for example,
16   `DBI:mysql:freeside' or `DBI:Pg:dbname=freeside'), username, and password.
17   This file should not be world readable.  See the DBI manpage and the manpage
18   for your DBD for the exact syntax.
19 </ul>
20 All further configuration files and directories are located in
21 `/usr/local/etc/freeside/conf.<i>datasource</i>', for example, 
22 `/usr/local/etc/freeside/conf.DBI:Pg:dbname=freeside'
23 <ul>
24   <li>address - Your company name and address, four lines.
25   <li>bsdshellmachines - Your BSD flavored shell (and mail) machines, one per line.  This enables export of `/etc/passwd' and `/etc/master.passwd'.
26   <li>cybercash2 - <a href="">CyberCash v2</a> support, four lines: paymentserverhost, paymentserverport, paymentserversecret, and transaction type (`mauthonly' or `mauthcapture'). is required.
27   <li>cybercash3.2 - <a href="">CyberCash v3.2</a> support.  Two lines: the full path and name of your merchant_conf file, and the transaction type (`mauthonly' or `mauthcapture')., and CCMckErrno3_2 are required.
28   <li>domain - Your domain name.
29   <li>editreferrals - The existance of this file will allow you to change the referral of existing customers.
30   <li>erpcdmachines - Your ERPCD authenticaion machines, one per line.  This enables export of `/usr/annex/acp_passwd' and `/usr/annex/acp_dialup'.
31   <li>home - For new users, prefixed to usrename to create a directory name.  Should have a leading but not a trailing slash.
32   <li>invoice_from - Return address on email invoices.
33   <li>lpr - Print command for paper invoices, for example `lpr -h'.
34   <li>nismachines - Your NIS master (not slave master) machines, one per line.  This enables export of `/etc/global/passwd' and `/etc/global/shadow'.
35   <li>qmailmachines - Your qmail machines, one per line.  This enables export of `/var/qmail/control/virtualdomains', `/var/qmail/control/recipientmap', and `/var/qmail/control/rcpthosts'.  The existance of this file (even if empty) also turns on user `.qmail-extension' file maintenance in conjunction with `shellmachine'.
36   <li>radiusmachines - Your RADIUS authentication machines, one per line.  This enables export of `/etc/raddb/users'.
37   <li>registries - Directory which contains domain registry information.  Each registry is a directory.
38     <ul>
39       <li>registries/internic - Currently the only supported registry
40         <ul>
41           <li>registries/internic/from - Email address from which InterNIC domain registrations are sent.
42           <li>regestries/internic/nameservers - The nameservers for InterNIC domain registrations, one per line.  Each line contains an IP address and hostname, separated by whitespace.
43           <li>registries/internic/tech_contact - Technical contact NIC handle for domain registrations.
44           <li>registries/internic/template - Template for InterNIC domain registrations with special markup.  A suitable copy of the InterNIC domain template v4.0 is in `fs-x.y.z/etc/domain-template.txt'.
45           <li>registries/internic/to - Email address to which InterNIC domain registrations are sent.
46         </ul>
47     </ul>
48   <li>sendmailmachines - Your sendmail machines, one per line.  This enables export of `/etc/virtusertable' and `/etc/'.
49   <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.
50   <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.
51   <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.
52   <li>showpasswords - The existance of this file will allow unencrypted user passwords to be displayed.
53   <li>smtpmachine - SMTP relay for Freeside's outgoing mail.
54 </ul>
55 </body>