From 0bdd3c05c6a3664d7ed9a191ef8ae4ade2162109 Mon Sep 17 00:00:00 2001 From: ivan Date: Sun, 15 Apr 2001 10:33:40 +0000 Subject: [PATCH] better docs for the worst bit, finally --- CREDITS | 5 ++++- TODO | 22 +++++++++++++++++++++- htdocs/docs/config.html | 38 ++++++++++++++++++++++++-------------- 3 files changed, 49 insertions(+), 16 deletions(-) diff --git a/CREDITS b/CREDITS index fe5ac7fa6..cf98b61d2 100644 --- a/CREDITS +++ b/CREDITS @@ -49,7 +49,10 @@ features: - Web site virtual host tracking and export to Apache configuration files Kristian Hoffmann contributed Netscape CCK -autoconfiguration support for the signup server. +autoconfiguration support for the signup server, lots of great mailing +lists posts which I shamelessly made into documentation, fixes to get rid of +the embarassing and non-database-normal "owed" field, and many other things +I'm forgetting. Jeff Finucane send in a bunch of bugfixes (for the sendmail export, cancel-unaudited.cgi), patches to support billing date modification, diff --git a/TODO b/TODO index a9b3f64c1..308da8824 100644 --- a/TODO +++ b/TODO @@ -1,4 +1,4 @@ -$Id: TODO,v 1.59 2001-04-09 23:05:15 ivan Exp $ +$Id: TODO,v 1.60 2001-04-15 10:33:40 ivan Exp $ If you are interested in helping with any of these, please join the *development* mailing list (send a blank message to @@ -6,6 +6,26 @@ ivan-freeside-devel-subscribe@sisd.com) to avoid duplication of effort. --- +******** +for 1.3.0: +******** + +move to DBIx::DBSchema. (gets non-MySQL-specific dbdef-create) + +finish transactions (svc_*.pm, fs_register/) + +Pg-style or universal-style locking in fs_sessmon FS/FS/nas.pm, or rewrite it +to use a database expression that won't need it, or just dump the locking +entirely as nas_heartbeat stuff doesn't need to be accurate; it's just informational. + +radius + +test with MySQL+Sleepycat? + +******** +unclassified, probably either done already or post-1.3.0 +******** + anything doing transactions in the web interface should likely move into *.pm. (transactions are here woo!) diff --git a/htdocs/docs/config.html b/htdocs/docs/config.html index 216668591..db4b95427 100644 --- a/htdocs/docs/config.html +++ b/htdocs/docs/config.html @@ -3,23 +3,33 @@

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