doc updates
[freeside.git] / htdocs / docs / install.html
index 7fcd13a..300104b 100644 (file)
@@ -6,18 +6,21 @@
 Before installing, you need:
 <ul>
   <li>A web server, such as <a href="http://www.apache-ssl.org">Apache-SSL</a> or <a href="http://www.apache.org">Apache</a>
-  <li><a href="ftp://ftp.cs.hut.fi/pub/ssh/">SSH</a>
-  <li><a href="http://www.perl.com/CPAN/doc/relinfo/INSTALL.html">Perl</a> (at least 5.004_04)
-  <li>A database engine supported by Perl's <a href="http://www.hermetica.com/technologia/DBI/">DBI</a>, such as <a href="http://www.tcx.se/">MySQL</a> or <a href="http://www.postgresql.org/">PostgreSQL</a> (see the <a href="postgresql.html">PostgreSQL notes</a>)
-  <li>Perl modules
+  <li><a href="http://www.openssh.com//">SSH</a>
+  <li><a href="http://www.perl.com/CPAN/doc/relinfo/INSTALL.html">Perl</a> (at least 5.004_05 for the 5.004 series or 5.005_03 for the 5.005 series.  Don't enable experimental features like threads or the PerlIO abstraction layer.)
+  <li>A database engine supported by Perl's <a href="http://www.hermetica.com/technologia/DBI/">DBI</a>, such as <a href="http://www.tcx.se/">MySQL</a> or <a href="http://www.postgresql.org/">PostgreSQL</a> (verstion 6.5 or higher) (see the <a href="postgresql.html">PostgreSQL notes</a>)
+  <li>Perl modules (<a href="http://www.perl.com/CPAN/doc/manual/html/lib/CPAN.html">CPAN</a> will query, download and build perl modules automatically)
     <ul>
       <li><a href="http://www.perl.com/CPAN/modules/by-module/Array/">Array-PrintCols</a>
-      <li><a href="http://www.perl.com/CPAN/modules/by-module/Term/">Term-Query</a>
+      <li><a href="http://www.perl.com/CPAN/modules/by-module/Term/">Term-Query</a> (make test broken; install manually)
       <li><a href="http://www.perl.com/CPAN/modules/by-module/MIME/">MIME-Base64</a>
       <li><a href="http://www.perl.com/CPAN/modules/by-module/Data">Data-Dumper</a>
-      <li><a href="http://www.perl.com/CPAN/modules/by-module/MD5">MD5</a>
+      <li><a href="http://www.perl.com/CPAN/modules/by-module/MD5">Digest-MD5</a>
       <li><a href="http://www.perl.com/CPAN/modules/by-module/URI">URI</a>
+      <li><a href="http://www.perl.com/CPAN/modules/by-module/HTTP">HTML-Parser</a>
       <li><a href="http://www.perl.com/CPAN/modules/by-module/Net">libnet</a>
+      <li><a href="http://www.perl.com/CPAN/modules/by-module/Locale">Locale-Codes</a>
+      <li><a href="http://www.perl.com/CPAN/modules/by-module/Net">Net-Whois</a>
       <li><a href="http://www.perl.com/CPAN/modules/by-module/LWP/">libwww-perl</a>
       <li><a href="http://www.perl.com/CPAN/modules/by-module/Business/">Business-CreditCard</a>
       <li><a href="http://www.perl.com/CPAN/modules/by-module/Data/">Data-ShowTable</a>
@@ -27,6 +30,7 @@ Before installing, you need:
       <li><a href="http://www.perl.com/CPAN/modules/by-module/File/">File-CounterFile</a>
       <li><a href="http://www.perl.com/CPAN/modules/by-module/FreezeThaw/">FreezeThaw</a>
       <li><a href="http://www.perl.com/CPAN/modules/by-module/String/">String-Approx</a>
+      <li><a href="http://www.perl.com/CPAN/modules/by-module/Text/">Text-Template</a>
       <li><a href="http://www.perl.com/CPAN/modules/by-module/DBI/">DBI
       <li><a href="http://www.perl.com/CPAN/modules/by-module/DBD/">DBD for your database engine</a>
     </ul>
@@ -34,11 +38,22 @@ Before installing, you need:
 Install the Freeside distribution:
 <ul>
   <li>Add the user `freeside' to your system.
-  <li>Add the freeside database to your database engine.  (with <a href="http://www.mysql.com/Manual_chapter/manual_Syntax.html#Create_database">MySQL</a>) (with <a href="http://www.postgresql.org/docs/admin/manage-ag.htm#AEN854">PostgreSQL</a>)
-  <li>Allow the freeside user full access to the freeside database.  (with <a href="http://www.mysql.com/Manual_chapter/manual_Privilege_system.html#Privilege_system">MySQL</a>) (with <a href="http://www.postgresql.org/docs/admin/newuser.htm">PostgreSQL</a>)
+  <li>Add the freeside database to your database engine.  (with <a href="http://www.mysql.com/Manual_chapter/manual_Reference.html#CREATE_DATABASE">MySQL</a>) (with <a href="http://www.postgresql.org/docs/admin/manage-ag.htm#AEN854">PostgreSQL</a>)
+  <li>Allow the freeside user full access to the freeside database.
+    <ul>
+      <li> with <a href="http://www.mysql.com/Manual_chapter/manual_Privilege_system.html#Privilege_system">MySQL</a>:<pre>$ mysqladmin -u root password '<i>set_a_root_database_password</i>'
+$ mysql -u root -p
+mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP on freeside.* TO freeside@localhost IDENTIFIED BY '<i>set_a_freeside_database_password</i>';</pre>
+      <li> with <a href="http://www.postgresql.org/docs/admin/newuser.htm">PostgreSQL</a>
+    </ul>
   <li>Unpack the tarball: <pre>gunzip -c fs-x.y.z.tar.gz | tar xvf -</pre>
-  <li>Copy or link fs-x.y.z/site_perl to FS in your site_perl directory.  (try `<code>perl -V</code>' if unsure) <pre>mkdir /usr/local/lib/site_perl/FS
-cp fs-x.y.z/site_perl/* /usr/local/lib/site_perl/FS</pre> or <pre>ln -s /full/path/to/fs-x.y.z/site_perl /usr/local/lib/site_perl/FS</pre>
+  <li>Build and install the Perl libraries:
+    <pre>
+$ cd FS/
+$ perl Makefile.PL
+$ make
+$ su
+# make install</pre>
   <li>Copy or link fs-x.y.z/htdocs to your web server's document space.  <pre>mkdir /usr/local/apache/htdocs/freeside
 cp -r fs-x.y.z/htdocs/* /usr/local/apache/htdocs/freeside</pre> or <pre>ln -s /full/path/to/fs-x.y.z/htdocs /usr/local/apache/htdocs/freeside</pre>
   <li>Restrict access to this web interface.  (with <a href="http://www.apache.org/docs/misc/FAQ.html#user-authentication">Apache</a>)