X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=htdocs%2Fdocs%2Fconfig.html;h=7994af8f9a46125b8e3b8e780cea5a62e7b88013;hb=ab210fc8d75ee85574c5d4ca345c33190d9d5e2e;hp=9b8002601bae28cdb22619032bdec51edb6ffaa4;hpb=696202f2b3a7141f2400b32ca859cf72b6315d5e;p=freeside.git diff --git a/htdocs/docs/config.html b/htdocs/docs/config.html index 9b8002601..7994af8f9 100644 --- a/htdocs/docs/config.html +++ b/htdocs/docs/config.html @@ -3,15 +3,34 @@

Configuration files

-Configuration files and directories are located in `/var/spool/freeside/conf'. +Configuration file layout has changed in 1.2.x. +

First, the file `/usr/local/etc/freeside/mapsecrets' is read. Each line +in this file contains a username and filename, separated by whitespace. Note +that these are not local usernames - they are passed from Apache (you _did_ +setup +user authetication, correct?). Filenames are located in +`/usr/local/etc/freeside/'. The specified filename is parsed exactly +the same as the pre-1.2.x `secrets' file: +
Three lines: Database engine datasource (for example, + `DBI:mysql:freeside' or `DBI:Pg:dbname=freeside'), username, and password. + This file should not be world readable. See the DBI manpage and the manpage + for your DBD for the exact syntax. +

+All further configuration files and directories are located in +`/usr/local/etc/freeside/conf.datasource', for example, +`/usr/local/etc/freeside/conf.DBI:Pg:dbname=freeside'

address - Your company name and address, four lines.
bsdshellmachines - Your BSD flavored shell (and mail) machines, one per line. This enables export of `/etc/passwd' and `/etc/master.passwd'.
cybercash2 - CyberCash v2 support, four lines: paymentserverhost, paymentserverport, paymentserversecret, and transaction type (`mauthonly' or `mauthcapture'). CCLib.pm is required.
cybercash3.2 - CyberCash v3.2 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. +
deletecustomers - The existance of this file will enable customer deletions.
domain - Your domain name. +
editreferrals - The existance of this file will allow you to change the referral of existing customers.
erpcdmachines - Your ERPCD authenticaion machines, one per line. This enables export of `/usr/annex/acp_passwd' and `/usr/annex/acp_dialup'.
home - For new users, prefixed to usrename to create a directory name. Should have a leading but not a trailing slash. +
invoice_from - Return address on email invoices.
lpr - Print command for paper invoices, for example `lpr -h'.
nismachines - Your NIS master (not slave master) machines, one per line. This enables export of `/etc/global/passwd' and `/etc/global/shadow'.
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'. @@ -27,11 +46,11 @@ Configuration files and directories are located in `/var/spool/freeside/conf'.
registries/internic/to - Email address to which InterNIC domain registrations are sent.

secrets - Three lines: Database engine datasource (for example, `DBI:mysql:freeside' or `DBI:Pg:dbname=freeside'), username, and password. This file should not be world readable.

sendmailmachines - Your sendmail machines, one per line. This enables export of `/etc/virtusertable' and `/etc/sendmail.cw'.

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.

shellmachines - Your Linux and System V flavored shell (and mail) machines, one per line. This enables export of `/etc/passwd' and `/etc/shadow' files.

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. +

showpasswords - The existance of this file will allow unencrypted user passwords to be displayed.

smtpmachine - SMTP relay for Freeside's outgoing mail.