add JSON to initial install instructions
[freeside.git] / httemplate / docs / install.html
index d89ea3f..78172e8 100644 (file)
@@ -21,6 +21,7 @@ Before installing, you need:
          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.  You <b>must</b> 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/I/n/InnoDB.html">InnoDB</a>.  Set it as the default table type using the <code>--default-table-type=InnoDB</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=InnoDB</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>
+    <i>Note: the above only applies to the database used by the Freeside software itself. Freeside can integrate with RADIUS and other servers running MySQL <!--(any version)--> or any other DBI-supported database.</i>
   <li>Perl modules (<a href="http://search.cpan.org/~andk/CPAN/lib/CPAN.pm">CPAN</a> will query, download and build perl modules automatically)
     <ul>
 <!--      <li><a href="http://search.cpan.org/dist/Array-PrintCols">Array-PrintCols</a>
@@ -51,7 +52,7 @@ Before installing, you need:
       <li><a href="http://search.cpan.org/dist/Net-SSH">Net-SSH</a>
       <li><a href="http://search.cpan.org/dist/String-ShellQuote">String-ShellQuote</a>
       <li><a href="http://search.cpan.org/dist/Net-SCP">Net-SCP</a>
-      <li><a href="http://www.masonhq.com/">HTML::Mason</a> (recommended, enables full functionality) or <a href="http://www.apache-asp.org/">Apache::ASP</a> (deprecated, integrated RT ticketing will not be available)
+      <li><a href="http://www.masonhq.com/">HTML::Mason</a>
       <li><a href="http://search.cpan.org/dist/Tie-IxHash">Tie-IxHash</a>
       <li><a href="http://search.cpan.org/dist/Time-Duration">Time-Duration</a>
       <li><a href="http://search.cpan.org/dist/HTML-Widgets-SelectLayers">HTML-Widgets-SelectLayers</a>
@@ -68,8 +69,10 @@ Before installing, you need:
       <li><a href="http://search.cpan.org/dist/Frontier-RPC">Frontier::RPC (Frontier::RPC2)</a>
       <li><a href="http://search.cpan.org/dist/MIME-tools">MIME::Entity (MIME-tools)</a>
       <li><a href="http://search.cpan.org/dist/IPC-Run3">IPC::Run3</a>
+      <li><a href="http://search.cpan.org/dist/Term-ReadKey">Term::ReadKey</a>
 <!--      <li><a href="http://search.cpan.org/dist/Crypt-YAPassGen">Crypt::YAPassGen</a> -->
-      <li><a href="http://search.cpan.org/search?mode=module&query=MIME::Entity">Fax::Hylafax::Client</a> <i>(Required if using FAX invoice destinations</i>
+      <li><a href="http://search.cpan.org/dist/JSON">JSON</a>
+      <li><a href="http://search.cpan.org/search?mode=module&query=MIME::Entity">Fax::Hylafax::Client</a> <i>(Required if using FAX invoice destinations)</i>
       <li><a href="http://search.cpan.org/dist/ApacheDBI">Apache::DBI</a> <i>(optional but recommended for better webinterface performance)</i>
     </ul>
 </ul>
@@ -121,15 +124,7 @@ $ su
     <li>Run a <b>separate</b> iteration of Apache[-SSL] with mod_perl enabled <b>as the freeside user</b>.
     <li>Edit the <tt>Makefile</tt> and set <tt>TEMPLATE</tt> to <tt>asp</tt> or <tt>mason</tt>.  Also set <tt>FREESIDE_DOCUMENT_ROOT</tt>.
     <li>Run <tt> make install-docs</tt>.
-</ul>
-<table>
-  <tr>
-    <th>Mason (recommended)</th><th>Apache::ASP (deprecated)</th>
-  </tr>
-  <tr>
-
-    <td valign="top"><ul>
-      <li>Configure Apache:
+<li>Configure Apache:
 <font size="-1"><pre>
 PerlModule HTML::Mason
 # your freeside docuemnt root
@@ -143,33 +138,6 @@ require&nbsp;"/usr/local/etc/freeside/handler.pl";
 &lt;/Perl&gt;
 &lt;/Directory&gt;
 </pre></font>
-    </ul></td>
-
-    <td valign="top"><ul>
-      <li>Configure Apache:
-<font size="-1"><pre>
-PerlModule Apache::ASP
-# your freeside document root
-&lt;Directory&nbsp;/var/www/freeside&gt;
-&lt;Files ~ (\.cgi|\.html)&gt;
-AddHandler perl-script .cgi .html
-PerlHandler Apache::ASP
-&lt;/Files&gt;
-&lt;Perl&gt;
-$MLDBM::RemoveTaint = 1;
-&lt;/Perl&gt;
-PerlSetVar&nbsp;Global&nbsp;/usr/local/etc/freeside/asp-global/
-PerlSetVar&nbsp;Debug&nbsp;2
-PerlSetVar&nbsp;RequestBinaryRead&nbsp;Off
-# your freeside document root
-PerlSetVar&nbsp;IncludesDir&nbsp;/var/www/freeside
-&lt;/Directory&gt;
-</pre></font>
-    </ul></td>
-
-  </tr>
-</table>
-<ul>
 <li>Restrict access to this web interface - see the <a href="http://httpd.apache.org/docs/misc/FAQ.html#user-authentication">Apache documentation on user authentication</a>.    For example, to configure user authentication with <a href="http://httpd.apache.org/docs/mod/mod_auth.html">mod_auth</a> (flat files), add something like the following to your Apache httpd.conf file, adjusting for your actual paths:
 <pre>
 #your freeside document root
@@ -184,27 +152,20 @@ require valid-user
     <ul>
       <li>First user:<font size="-1">
 <pre>$ su
-% <a href="man/bin/freeside-adduser.html">freeside-adduser</a> -c -h /usr/local/etc/freeside/htpasswd <i>username</i></pre></font>
+# <a href="man/bin/freeside-adduser.html">freeside-adduser</a> -c -h /usr/local/etc/freeside/htpasswd <i>username</i></pre></font>
       <li>Additional users:<font size="-1">
 <pre>$ su
-% <a href="man/bin/freeside-adduser.html">freeside-adduser</a> -h /usr/local/etc/freeside/htpasswd <i>username</i></pre></font>
+# <a href="man/bin/freeside-adduser.html">freeside-adduser</a> -h /usr/local/etc/freeside/htpasswd <i>username</i></pre></font>
     </ul>
   <i>(using other auth types, add each user to your <a href="http://httpd.apache.org/docs/misc/FAQ.html#user-authentication">Apache authentication</a> and then run: <tt>freeside-adduser <b>username</b></tt>)</i>
   <li>Create the Freeside system users:
 <pre>$ su
-% <a href="man/bin/freeside-adduser.html">freeside-adduser</a> fs_queue
-% <a href="man/bin/freeside-adduser.html">freeside-adduser</a> fs_selfservice</pre>
-  <li>As the freeside UNIX user, run <tt>freeside-setup <b>username</b></tt> to create the database tables, passing the username of a Freeside user you created above:
-<pre>
-$ su freeside
-$ freeside-setup <b>username</b>
-</pre>
-  Alternately, use the -s option to enable shipping addresses: <tt>freeside-setup -s <b>username</b></tt>
-  <li>As the freeside UNIX user, run <tt>bin/populate-msgcat <b>username</b></tt> (in the untar'ed freeside directory) to populate the message catalog, passing the username of a Freeside user you created above:
+# <a href="man/bin/freeside-adduser.html">freeside-adduser</a> fs_queue
+# <a href="man/bin/freeside-adduser.html">freeside-adduser</a> fs_selfservice</pre>
+  <li>As the freeside UNIX user, run <tt>freeside-setup -d <b>domain.name</b> <b>username</b></tt> to create the database tables and initial data, passing the username of a Freeside user you created above:
 <pre>
 $ su freeside
-$ cd <b>/path/to/freeside/</b>
-$ bin/populate-msgcat <b>username</b>
+$ freeside-setup -d </b>example.com</b> <b>username</b>
 </pre>
   <li><tt>freeside-queued</tt> was installed with the Perl modules.  Start it now and ensure that is run upon system startup (Do this manually, or edit the top-level Makefile, replacing INIT_FILE with the appropriate location on your systemand QUEUED_USER with the username of a Freeside user you created above, and run <tt>make install-init</tt>)
   <li>Now proceed to the initial <a href="admin.html">administration</a> of your installation.