projects / freeside.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 7dac9e5)
better docs for the worst bit, finally
authorivan <ivan>
Sun, 15 Apr 2001 10:33:40 +0000 (10:33 +0000)
committerivan <ivan>
Sun, 15 Apr 2001 10:33:40 +0000 (10:33 +0000)
CREDITS patch | blob | history
TODO patch | blob | history
htdocs/docs/config.html patch | blob | history

diff --git a/CREDITS b/CREDITS
index fe5ac7f..cf98b61 100644 (file)
--- a/CREDITS
+++ b/CREDITS
@@ -49,7 +49,10 @@ features:
   - Web site virtual host tracking and export to Apache configuration files
 
 Kristian Hoffmann <khoff@pc-intouch.com> contributed Netscape CCK
   - Web site virtual host tracking and export to Apache configuration files
 
 Kristian Hoffmann <khoff@pc-intouch.com> 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 <jeff@cmh.net> send in a bunch of bugfixes (for the sendmail
 export, cancel-unaudited.cgi), patches to support billing date modification,
 
 Jeff Finucane <jeff@cmh.net> 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 a9b3f64..308da88 100644 (file)
--- 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
 
 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!)
 
 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 2166685..db4b954 100644 (file)
--- a/htdocs/docs/config.html
+++ b/htdocs/docs/config.html
@@ -3,23 +3,33 @@
 </head>
 <body>
   <h1>Configuration files</h1>
 </head>
 <body>
   <h1>Configuration files</h1>
-Configuration file layout has changed in 1.2.x.
 <ul>
 <ul>
-  <li>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 <a href="http://www.apache.org/docs/misc/FAQ.html#user-authentication">
-user authetication</a>, 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:
-  <li>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.
+  <li>Create the <b>/usr/local/etc/freeside</b> directory to hold your configuration.
+  <li>Setting up <a href="http://www.apache.org/docs/misc/FAQ.html#user-authentication">Apache user authetication</a> is mandatory.
+  <li>Create the <b>/usr/local/etc/freeside/mapsecrets</b> file, which maps Apache users to a secrets file which contains a DBI data source, username and password.  Every
+line in <b>/usr/local/etc/freeside/mapsecrets</b> should contain a username and
+filename, separated by whitespace.  Note that these are not local usernames -
+they are passed from Apache.  <a href="http://www.apache.org/docs/misc/FAQ.html#user-authentication">
+Apache user authetication</a> is mandatory.  For example, if you had the Apache users admin,
+john, and sam,  
+you mapsecrets file might look like:
+<pre>
+admin secretfile
+john secretfile
+sam secretfile
+</pre>
+  <li>Next, the filename(s) referenced in <b>/usr/local/etc/freeside/mapsecrets</b> file should be created in the <b>/usr/local/etc/freeside/</b> directory.  This file contains three lines: <a href="http://search.cpan.org/doc/TIMB/DBI-1.15/DBI.pm">DBI data source</a> (for example,
+  <tt>DBI:mysql:freeside</tt> or <tt>DBI:Pg:dbname=freeside</tt>), database username, and database password.
+  This file should not be world readable.  See the <a href="http://search.cpan.org/doc/TIMB/DBI-1.15/DBI.pm">DBI manpage</a> and the <a href="http://search.cpan.org/search?mode=module&query=DBD">manpage for your DBD</a> for the exact syntax of a DBI data source.  For example:
+<pre>
+DBI:Pg:dbname=freeside
+dbusername
+dbpassword
+</pre>
 </ul>
 All further configuration files and directories are located in
 </ul>
 All further configuration files and directories are located in
-`/usr/local/etc/freeside/conf.<i>datasource</i>', for example, 
-`/usr/local/etc/freeside/conf.DBI:Pg:dbname=freeside'
+<tt>/usr/local/etc/freeside/conf.<i>datasource</i></tt>, for example, 
+<tt>/usr/local/etc/freeside/conf.DBI:Pg:dbname=freeside</tt>
 <ul>
   <li><a name="address">address</a> - This configuration file is no longer used.  See <a href="#invoice_template">invoice_template</a> instead.
   <li><a name="apacheroot">apacheroot</a> - The directory containing Apache virtual hosts
 <ul>
   <li><a name="address">address</a> - This configuration file is no longer used.  See <a href="#invoice_template">invoice_template</a> instead.
   <li><a name="apacheroot">apacheroot</a> - The directory containing Apache virtual hosts
Freeside billing, trouble ticketing, network monitoring and provisioning