install warnings about mysql
[freeside.git] / httemplate / docs / install.html
index e719645..b739af0 100644 (file)
@@ -12,7 +12,10 @@ Before installing, you need:
   <li>A <b>transactional</b> database engine supported by Perl's <a href="http://www.hermetica.com/technologia/DBI/">DBI</a>.
     <ul>
       <li><a href="http://www.postgresql.org/">PostgreSQL</a> (v7 or higher) is recommended.
-      <li>MySQL has been reported to work.  <b>MySQL's default <a href="http://www.mysql.com/doc/M/y/MyISAM.html">MyISAM</a> and <a href="http://www.mysql.com/doc/I/S/ISAM.html">ISAM</a> table types are not supported</b>.  If you really want to use MySQL, you need to use one of the new <a href="http://www.mysql.com/doc/T/a/Table_types.html">transaction-safe table types</a> such as <a href="http://www.mysql.com/doc/B/D/BDB.html">BDB</a>, and set it as the default table type using the <code>--default-table-type=BDB</code> <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Command-line_options">mysqld command-line option</a> or by setting <code>default-table-type=BDB</code> in the <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Option_files">my.cnf option file</a>.
+      <li><b>MySQL does not work at this time.</b>
+        <i>The following information is provided for developers who wish to contribute MySQL support:</i> See tickets <a href="http://pouncequick.420.am/rt/Ticket/Display.html?id=300">#300</a> and <a href="http://pouncequick.420.am/rt/Ticket/Display.html?id=334">#334</a> in the bug-tracking system.
+      <!-- <li>MySQL has been reported to work.  -->
+        <b>MySQL's default <a href="http://www.mysql.com/doc/M/y/MyISAM.html">MyISAM</a> and <a href="http://www.mysql.com/doc/I/S/ISAM.html">ISAM</a> table types are not supported</b>.  If you really want to use MySQL, you need to use one of the new <a href="http://www.mysql.com/doc/T/a/Table_types.html">transaction-safe table types</a> such as <a href="http://www.mysql.com/doc/B/D/BDB.html">BDB</a>, and set it as the default table type using the <code>--default-table-type=BDB</code> <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Command-line_options">mysqld command-line option</a> or by setting <code>default-table-type=BDB</code> in the <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Option_files">my.cnf option file</a>.
     </ul>
   <li>Perl modules (<a href="http://theoryx5.uwinnipeg.ca/CPAN/perl/CPAN.html">CPAN</a> will query, download and build perl modules automatically)
     <ul>
@@ -32,21 +35,21 @@ Before installing, you need:
       <li><a href="http://search.cpan.org/search?dist=MailTools">MailTools</a>
       <li><a href="http://search.cpan.org/search?dist=TimeDate">TimeDate</a>
       <li><a href="http://search.cpan.org/search?dist=DateManip">DateManip</a>
-      <li><a href="http://search.cpan.org/search?dist=Time-Duration">Time-Duration</a>
       <li><a href="http://search.cpan.org/search?dist=File-CounterFile">File-CounterFile</a>
       <li><a href="http://search.cpan.org/search?dist=FreezeThaw">FreezeThaw</a>
       <li><a href="http://search.cpan.org/search?dist=String-Approx">String-Approx</a>
       <li><a href="http://search.cpan.org/search?dist=Text-Template">Text-Template</a>
       <li><a href="http://search.cpan.org/search?dist=Archive-Tar">Archive-Tar</a>
       <li><a href="http://search.cpan.org/search?dist=DBI">DBI</a>
-      <li><a href="http://search.cpan.org/search?mode=module&query=DBD">DBD for your database engine</a>
+      <li><a href="http://search.cpan.org/search?mode=module&query=DBD">DBD for your database engine</a> (<a href="http://search.cpan.org/search?dist=DBD-Pg">DBD::Pg</a> for PostgreSQL, <a href="http://search.cpan.org/search?dist=DBD-mysql">DBD::mysql</a> for MySQL)
       <li><a href="http://search.cpan.org/search?dist=DBIx-DataSource">DBIx-DataSource</a>
       <li><a href="http://search.cpan.org/search?dist=DBIx-DBSchema">DBIx-DBSchema</a>
       <li><a href="http://search.cpan.org/search?dist=Net-SSH">Net-SSH</a>
       <li><a href="http://search.cpan.org/search?dist=String-ShellQuote">String-ShellQuote</a>
       <li><a href="http://search.cpan.org/search?dist=Net-SCP">Net-SCP</a>
       <li><a href="http://www.apache-asp.org/">Apache::ASP</a> or <a href="http://www.masonhq.com/">HTML::Mason</a>
-      <li><a href="http;//search.cpan.org/search?dist=Tie-IxHash">Tie-IxHash</a>
+      <li><a href="http://search.cpan.org/search?dist=Tie-IxHash">Tie-IxHash</a>
+      <li><a href="http://search.cpan.org/search?dist=Time-Duration">Time-Duration</a>
     </ul>
 </ul>
 Install the Freeside distribution:
@@ -57,7 +60,12 @@ Install the Freeside distribution:
       <li> with <a href="http://www.postgresql.org/users-lounge/docs/7.1/postgres/user-manag.html#DATABASE-USERS">PostgreSQL</a>:
         <pre>
 $ su postgres
-$ createuser -P freeside</pre>
+$ createuser -P freeside
+Enter password for user "freeside": 
+Enter it again: 
+Shall the new user be allowed to create databases? (y/n) y
+Shall the new user be allowed to create more new users? (y/n) n
+CREATE USER</pre>
       <li> with <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#User_Account_Management">MySQL</a>:
         <pre>
 $ mysqladmin -u root password '<i>set_a_root_database_password</i>'
@@ -101,10 +109,13 @@ $ su
       <li>Run <tt>make aspdocs</tt>
       <li>Copy <tt>aspdocs/</tt> to your web server's document space.
       <li>Create a <a href="http://www.apache-asp.org/config.html#Global">Global</a> directory, such as <tt>/usr/local/etc/freeside/asp-global/</tt>
-      <li>Copy <tt>htetc/global.asa</tt> to the Global directory.
+      <li>Copy <tt>htetc/global.asa</tt> to the Global directory:
+<font size="-1"><pre>
+cp&nbsp;htetc/global.asa&nbsp;/usr/local/etc/freeside/asp-global/global.asa
+</pre></font>
       <li>Configure Apache for the Global directory and to execute .cgi files using Apache::ASP.  For example:
 <font size="-1"><pre>
-&lt;Directory /usr/local/apache/htdocs/freeside-asp&gt;
+&lt;Directory&nbsp;/usr/local/apache/htdocs/freeside-asp&gt;
 &lt;Files ~ (\.cgi)&gt;
 AddHandler perl-script .cgi
 PerlHandler Apache::ASP
@@ -112,7 +123,7 @@ PerlHandler Apache::ASP
 &lt;Perl&gt;
 $MLDBM::RemoveTaint = 1;
 &lt;/Perl&gt;
-PerlSetVar Global /usr/local/etc/freeside/asp-global/
+PerlSetVar&nbsp;Global&nbsp;/usr/local/etc/freeside/asp-global/
 PerlSetVar Debug 2
 &lt;/Directory&gt;
 </pre></font>
@@ -124,13 +135,13 @@ PerlSetVar Debug 2
       <li>Edit <tt>handler.pl</tt> and set an appropriate <tt>data_dir</tt>, such as <tt>/usr/local/etc/freeside/mason-data</tt>
       <li>Configure Apache to use the <tt>handler.pl</tt> file and to execute .cgi files using HTML::Mason.  For example:
 <font size="-1"><pre>
-&lt;Directory /usr/local/apache/htdocs/freeside-mason&gt;
+&lt;Directory&nbsp;/usr/local/apache/htdocs/freeside-mason&gt;
 &lt;Files ~ (\.cgi)&gt;
 AddHandler perl-script .cgi
 PerlHandler HTML::Mason
 &lt;/Files&gt;
 &lt;Perl&gt;
-require "/usr/local/apache/conf/handler.pl";
+require&nbsp;"/usr/local/apache/conf/handler.pl";
 &lt;/Perl&gt;
 &lt;/Directory&gt;
 </pre></font>