X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=htdocs%2Fdocs%2Fconfig.html;h=db4b95427ca39a7efd75207315aea42842f62c58;hb=0bdd3c05c6a3664d7ed9a191ef8ae4ade2162109;hp=c3bfe17f3eb8d450aeb70a46d6b41f408d60d295;hpb=cb61ec822bf114015e4044868c5c7f3c3000ab0d;p=freeside.git diff --git a/htdocs/docs/config.html b/htdocs/docs/config.html index c3bfe17f3..db4b95427 100644 --- a/htdocs/docs/config.html +++ b/htdocs/docs/config.html @@ -3,53 +3,69 @@

Configuration files

-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. +
Create the /usr/local/etc/freeside directory to hold your configuration. +
Setting up Apache user authetication is mandatory. +
Create the /usr/local/etc/freeside/mapsecrets file, which maps Apache users to a secrets file which contains a DBI data source, username and password. Every +line in /usr/local/etc/freeside/mapsecrets should contain a username and +filename, separated by whitespace. Note that these are not local usernames - +they are passed from Apache. +Apache user authetication is mandatory. For example, if you had the Apache users admin, +john, and sam, +you mapsecrets file might look like: +
```
+admin secretfile
+john secretfile
+sam secretfile
+
```
+
Next, the filename(s) referenced in /usr/local/etc/freeside/mapsecrets file should be created in the /usr/local/etc/freeside/ directory. This file contains three lines: DBI data source (for example, + DBI:mysql:freeside or DBI:Pg:dbname=freeside), database username, and database password. + This file should not be world readable. See the DBI manpage and the manpage for your DBD for the exact syntax of a DBI data source. For example: +
```
+DBI:Pg:dbname=freeside
+dbusername
+dbpassword
+
```

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' +/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. -
apacheroot - The directory containing Apache virtual hosts -
apachemachine - A machine with the apacheroot directory and user home directories. The existance of this file enables setup of virtual host directories, and, in conjunction with the `home' configuration file, symlinks into user home directories. -
apachemachines - Your Apache machines, one per line. This enables export of `/etc/apache/vhosts.conf', which can be included in your Apache configuration via the Include directive. -
bindprimary - Your BIND primary nameserver. This enables export of /var/named/named.conf and zone files into /var/named -
bindsecondaries - Your BIND secondary nameservers, one per line. This enables export of /var/named/named.conf -
bsdshellmachines - Your BSD flavored shell (and mail) machines, one per line. This enables export of `/etc/passwd' and `/etc/master.passwd'. -
countrydefault - Default two-letter country code (if not supplied, the default is `US') -
cybercash2 - CyberCash v2 support, four lines: paymentserverhost, paymentserverport, paymentserversecret, and transaction type (`mauthonly' or `mauthcapture'). CCLib.pm is required. +
address - This configuration file is no longer used. See invoice_template instead. +
apacheroot - The directory containing Apache virtual hosts +
apachemachine - A machine with the apacheroot directory and user home directories. The existance of this file enables setup of virtual host directories, and, in conjunction with the `home' configuration file, symlinks into user home directories. +
apachemachines - Your Apache machines, one per line. This enables export of `/etc/apache/vhosts.conf', which can be included in your Apache configuration via the Include directive. +
autocapnames - The presence of this file will cause Freeside to use Javascript in /htdocs/edit/cust_main.cgi to automatically capitalize the first and last names of customers. +
bindprimary - Your BIND primary nameserver. This enables export of /var/named/named.conf and zone files into /var/named +
bindsecondaries - Your BIND secondary nameservers, one per line. This enables export of /var/named/named.conf +
bsdshellmachines - Your BSD flavored shell (and mail) machines, one per line. This enables export of `/etc/passwd' and `/etc/master.passwd'. +
countrydefault - Default two-letter country code (if not supplied, the default is `US') +
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. 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. -
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'. -
hidecancelledpackages - The existance of this file will prevent cancelled packages from showing up in listings (though they will still be in the database) -
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) -
home - For new users, prefixed to usrename to create a directory name. Should have a leading but not a trailing slash. -
icradiusmachines - Your ICRADIUS 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: "radius.isp.tld radius_db radius_user passw0rd". Note that to use ICRADIUS export you need to be using MySQL. -
icradius_mysqldest - Destination directory for the MySQL databases, on the ICRADIUS machines. Defaults to "/usr/local/var/". -
icradius_mysqlsource - Source directory for for the MySQL radcheck table files, on the Freeside machine. Defaults to "/usr/local/var/freeside". -
invoice_from - Return address on email invoices. -
lpr - Print command for paper invoices, for example `lpr -h'. -
mxmachines - MX entries for new domains, weight and machine, one per line, with trailing `.' -
nsmachines - NS nameservers for new domains, one per line, with trailing `.' -
nismachines - Your NIS master (not slave master) machines, one per line. This enables export of `/etc/global/passwd' and `/etc/global/shadow'. -
passwordmin - Minimum password length (default 6); -
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'. -
radiusmachines - Your RADIUS authentication machines, one per line. This enables export of `/etc/raddb/users'. -
registries - Directory which contains domain registry information. Each registry is a directory. +
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. +
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'. +
hidecancelledpackages - The existance of this file will prevent cancelled packages from showing up in listings (though they will still be in the database) +
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) +
home - For new users, prefixed to usrename to create a directory name. Should have a leading but not a trailing slash. +
icradiusmachines - Your ICRADIUS 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: "radius.isp.tld radius_db radius_user passw0rd". Note that to use ICRADIUS export you need to be using MySQL. +
icradius_mysqldest - Destination directory for the MySQL databases, on the ICRADIUS machines. Defaults to "/usr/local/var/". +
icradius_mysqlsource - Source directory for for the MySQL radcheck table files, on the Freeside machine. Defaults to "/usr/local/var/freeside". +
icradius_secrets - Optionally specifies a MySQL database for ICRADIUS export, if you're not running MySQL for your Freeside database. The database should be on the Freeside machine and store data in the icradius_mysqlsource directory. Three lines: DBI data source, username and password. This file should not be world readable. +
invoice_from - Return address on email invoices. +
invoice_template - Required template file for invoices. See the section on billing for details. +
lpr - Print command for paper invoices, for example `lpr -h'. +
maildisablecatchall - The existance of this file will disable the requirement that each virtual domain have a catch-all mailbox. +
money_char - Currency symbol - defaults to `$'. +
mxmachines - MX entries for new domains, weight and machine, one per line, with trailing `.' +
nsmachines - NS nameservers for new domains, one per line, with trailing `.' +
nismachines - Your NIS master (not slave master) machines, one per line. This enables export of `/etc/global/passwd' and `/etc/global/shadow'. +
passwordmin - Minimum password length (default 6); +
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'. +
radiusmachines - Your RADIUS authentication machines, one per line. This enables export of `/etc/raddb/users'. +
referraldefault - Default referral, specified by refnum. +
registries - Directory which contains domain registry information. Each registry is a directory.
- registries/internic - Currently the only supported registry
  - registries/internic/to - Email address to which InterNIC domain registrations are sent.
-
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. -
soadefaultttl - SOA default TTL for new domains. -
soaemail - SOA email for new domains, in BIND form (`.' instead of `@'), with trailing `.' -
soaexpire - SOA expire for new domains -
soamachine - SOA machine for new domains, with trailing `.' -
soarefresh - SOA refresh for new domains -
soaretry - SOA retry for new domains -
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, '. -
usernamemin - Minimum username length (default 2); -
usernamemax - Maximum username length (default is the size of the SQL column, probably specified when fs-setup was run) +
sendmailconfigpath - Sendmail configuration file path - defaults to `/etc'. Many newer distributions use `/etc/mail'. +
sendmailmachines - Your sendmail machines, one per line. This enables export of `/etc/virtusertable' and `/etc/sendmail.cw'. +
sendmailrestart - If defined, the command which is run on sendmail machines after files are copied. +
session-start - If defined, the command which is executed on the Freeside machine when a session begins. The contents of the file are treated as a double-quoted perl string, with the following variables available: $ip, $nasip and $nasfqdn, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on. +
session-stop - If defined, the command which is executed on the Freeside machine when a session ends. The contents of the file are treated as a double-quoted perl string, with the following variables available: $ip, $nasip and $nasfqdn, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on. +
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. +
shellmachine-useradd - The command(s) to run on shellmachine when an account is created. If this file does not exist, useradd -d $dir -m -s $shell -u $uid $username is the default. If the file exists but is empty, cp -pr /etc/skel $dir; chown -R $uid.$gid $dir is the default instead. Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: $username, $uid, $gid, $dir, and $shell. +
shellmachine-userdel - The command(s) to run on shellmachine when an account is deleted. If this file does not exist, userdel $username is the default. If the file exists but is empty, rm -rf $dir is the default instead. Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: $username and $dir. +
shellmachine-usermod - The command(s) to run on shellmachine when an account is modified. If this file does not exist or is empty, [ -d $old_dir ] && mv $old_dir $new_dir || ( chmod u+t $old_dir; mkdir $new_dir; cd $old_dir; find . -depth -print | cpio -pdm $new_dir; chmod u-t $new_dir; chown -R $uid.$gid $new_dir; rm -rf $old_dir ) is the default. Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: $old_dir, $new_dir, $uid and $gid. +
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. +
soadefaultttl - SOA default TTL for new domains. +
soaemail - SOA email for new domains, in BIND form (`.' instead of `@'), with trailing `.' +
soaexpire - SOA expire for new domains +
soamachine - SOA machine for new domains, with trailing `.' +
soarefresh - SOA refresh for new domains +
soaretry - SOA retry for new domains +
statedefault - Default state or province (if not supplied, the default is `CA') +
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, '. +
usernamemin - Minimum username length (default 2); +
usernamemax - Maximum username length (default is the size of the SQL column, probably specified when fs-setup was run)