httemplate/docs/install.html

   1 <head>
   2   <title>Installation</title>
   3 </head>
   4 <body>
   5 <h1>Installation</h1>
   6 <i>Note: Install Freeside on a firewalled, private server, not a public (web, RADIUS, etc.) server.</i><br><br>
   7 Before installing, you need:
   8 <ul>
   9   <li><a href="http://www.perl.com/">Perl</a>, minimum version 5.005_03. (5.8.3 for the integrated RT ticketing)
  10   <li><a href="http://www.apache.org">Apache</a> (<a href="http://www.modssl.org/">mod_ssl</a> or <a href="http://www.apache-ssl.org">Apache-SSL</a> highly recommended)
  11   <li><a href="http://perl.apache.org/">mod_perl</a> (if compiling your own mod_perl, make sure you set the <a href="http://perl.apache.org/guide/install.html#EVERYTHING">EVERYTHING</a>=1 compile-time option)
  12   <li><a href="http://www.openssh.com/">SSH</a> (<a href="http://www.openssh.com//">OpenSSH</a> is recommended.  SSH Communications Security <a href="http://www.ssh.com/products/ssh/download.cfm">commercial SSH version 3</a> has been reported incompatible with Freeside.)
  13   <li><a href="http://rsync.samba.org/">rsync</a>
  14   <li>Optional, enables typeset invoices: teTeX and Ghostscript (included with most distributions).
  15   <li>A <b>transactional</b> database engine <a href="http://search.cpan.org/search?mode=module&query=DBD%3A%3A">supported</a> by Perl's <a href="http://dbi.perl.org">DBI</a>.
  16     <ul>
  17       <li><a href="http://www.postgresql.org/">PostgreSQL</a> is recommended (v7.2 or later).
  18       <li> <a href="http://www.mysql.com/">MySQL</a> is <b>not currently supported</b>.  <FONT SIZE="-1"><i>Developers intersted in maintaining MySQL support are welcome to ask on the -devel mailing list; many things work, but MySQL support needs a maintainer to update it for recent (and future) changes.</i></FONT>
  19       <!-- <li><a href="http://www.mysql.com/">MySQL</a> <b>MINIMUM VERSION 4.1</b> is untested but may work.   Versions before 4.1 do not support standard SQL subqueries and are <b>NOT SUPPORTED</b>.
  20 <!--       <li>MySQL has been reported to work.
  21          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>.
  22 -->
  23     </ul>
  24   <li>Perl modules (<a href="http://search.cpan.org/~andk/CPAN/lib/CPAN.pm">CPAN</a> will query, download and build perl modules automatically)
  25     <ul>
  26 <!--      <li><a href="http://search.cpan.org/dist/Array-PrintCols">Array-PrintCols</a>
  27       <li><a href="http://search.cpan.org/dist/Term-Query">Term-Query</a> (make test broken; install manually) -->
  28       <li><a href="http://search.cpan.org/dist/MIME-Base64">MIME-Base64</a>
  29       <li><a href="http://search.cpan.org/dist/Digest-MD5">Digest-MD5</a>
  30 <!--      <li><a href="http://search.cpan.org/dist/MD5">MD5</a> -->
  31       <li><a href="http://search.cpan.org/dist/URI">URI</a>
  32       <li><a href="http://search.cpan.org/dist/HTML-Tagset">HTML-Tagset</a>
  33       <li><a href="http://search.cpan.org/dist/HTML-Parser">HTML-Parser</a>
  34       <li><a href="http://search.cpan.org/dist/libnet">libnet</a>
  35       <li><a href="http://search.cpan.org/dist/Locale-Codes">Locale-Codes</a>
  36       <li><a href="http://search.cpan.org/dist/Net-Whois-Raw">Net-Whois-Raw</a>
  37       <li><a href="http://search.cpan.org/dist/libwww-perl">libwww-perl</a>
  38       <li><a href="http://search.cpan.org/dist/Business-CreditCard">Business-CreditCard</a>
  39 <!--      <li><a href="http://search.cpan.org/dist/Data-ShowTable">Data-ShowTable</a> -->
  40       <li><a href="http://search.cpan.org/dist/MailTools">MailTools</a>
  41       <li><a href="http://search.cpan.org/dist/TimeDate">TimeDate</a>
  42       <li><a href="http://search.cpan.org/dist/DateManip">DateManip</a>
  43       <li><a href="http://search.cpan.org/dist/File-CounterFile">File-CounterFile</a>
  44       <li><a href="http://search.cpan.org/dist/FreezeThaw">FreezeThaw</a>
  45       <li><a href="http://search.cpan.org/dist/String-Approx">String-Approx</a>
  46       <li><a href="http://search.cpan.org/dist/Text-Template">Text-Template</a>
  47       <li><a href="http://search.cpan.org/dist/DBI">DBI</a>
  48       <li><a href="http://search.cpan.org/search?mode=module&query=DBD">DBD for your database engine</a> (<a href="http://search.cpan.org/dist/DBD-Pg">DBD::Pg</a> for PostgreSQL<!--, <a href="http://search.cpan.org/search?dist=DBD-mysql">DBD::mysql</a> for MySQL-->)
  49 <!--      <li><a href="http://search.cpan.org/dist/DBIx-DataSource">DBIx-DataSource</a> -->
  50       <li><a href="http://search.cpan.org/dist/DBIx-DBSchema">DBIx-DBSchema</a>
  51       <li><a href="http://search.cpan.org/dist/Net-SSH">Net-SSH</a>
  52       <li><a href="http://search.cpan.org/dist/String-ShellQuote">String-ShellQuote</a>
  53       <li><a href="http://search.cpan.org/dist/Net-SCP">Net-SCP</a>
  54       <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)
  55       <li><a href="http://search.cpan.org/dist/Tie-IxHash">Tie-IxHash</a>
  56       <li><a href="http://search.cpan.org/dist/Time-Duration">Time-Duration</a>
  57       <li><a href="http://search.cpan.org/dist/HTML-Widgets-SelectLayers">HTML-Widgets-SelectLayers</a>
  58       <li><a href="http://search.cpan.org/dist/Storable">Storable</a>
  59       <li><a href="http://search.cpan.org/dist/Cache-Cache">Cache::Cache</a>
  60       <li><a href="http://search.cpan.org/dist/NetAddr-IP">NetAddr-IP</a>
  61       <li><a href="http://search.cpan.org/dist/Chart">Chart</a>
  62       <li><a href="http://search.cpan.org/dist/Crypt-PasswdMD5">Crypt::PasswdMD5</a>
  63       <li><a href="http://search.cpan.org/dist/Locale-SubCountry">Locale::SubCountry</a>
  64       <li><a href="http://search.cpan.org/dist/JavaScript-RPC">JavaScript::RPC (JavaScript::RPC::Server::CGI)</a>
  65       <li><a href="http://search.cpan.org/dist/Frontier-RPC">Frontier::RPC</a>
  66       <li><a href="http://search.cpan.org/dist/Text-CSV_XS">Text::CSV_XS</a>
  67       <li><a href="http://search.cpan.org/dist/Spreadsheet-WriteExcel">Spreadsheet::WriteExcel</a>
  68       <li><a href="http://search.cpan.org/dist/IO-stringy">IO-stringy (IO::Scalar)</a>
  69       <li><a href="http://search.cpan.org/dist/Frontier-RPC">Frontier::RPC (Frontier::RPC2)</a>
  70       <li><a href="http://search.cpan.org/dist/MIME-tools">MIME::Entity (MIME-tools)</a>
  71 <!--      <li><a href="http://search.cpan.org/dist/Crypt-YAPassGen">Crypt::YAPassGen</a> -->
  72       <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>
  73       <li><a href="http://search.cpan.org/dist/ApacheDBI">Apache::DBI</a> <i>(optional but recommended for better webinterface performance)</i>
  74     </ul>
  75 </ul>
  76 Install the Freeside distribution:
  77 <ul>
  78   <li>Add the user and group `freeside' to your system.
  79   <li>Allow the freeside user full access to the freeside database.
  80     <ul>
  81       <li> with <a href="http://www.postgresql.org/users-lounge/docs/7.1/postgres/user-manag.html#DATABASE-USERS">PostgreSQL</a>:
  82         <pre>
  83 $ su postgres (pgsql on some distributions)
  84 $ createuser -P freeside
  85 Enter password for user "freeside":
  86 Enter it again:
  87 Shall the new user be allowed to create databases? (y/n) y
  88 Shall the new user be allowed to create more new users? (y/n) n
  89 CREATE USER</pre>
  90       <li> with <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#User_Account_Management">MySQL</a>:
  91         <pre>
  92 $ mysqladmin -u root password '<i>set_a_root_database_password</i>'
  93 $ mysql -u root -p
  94 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>
  95     </ul>
  96 <!--  <li>Unpack the tarball: <pre>gunzip -c fs-x.y.z.tar.gz | tar xvf -</pre>-->
  97   <li>Edit the top-level Makefile:
  98     <ul>
  99       <li>Set <tt>DATASOURCE</tt> to your <a href="http://search.cpan.org/doc/TIMB/DBI-1.28/DBI.pm">DBI data source</a>, for example, <tt>DBI:Pg:dbname=freeside</tt> for PostgresSQL or <tt>DBI:mysql:freeside</tt> for MySQL.  See the <a href="http://search.cpan.org/doc/TIMB/DBI-1.28/DBI.pm">DBI manpage</a> and the <a href="http://search.cpan.org/search?mode=module&query=DBD%3A%3A">manpage for your DBD</a> for the exact syntax of your DBI data source.
 100       <li>Set <tt>DB_PASSWORD</tt> to the freeside database user's password.
 101     </ul>
 102   <li>Add the freeside database to your database engine:
 103     <ul>
 104       <li>with Postgres:
 105         <pre>
 106 $ su freeside
 107 $ createdb -E sql_ascii freeside</pre>
 108       <li>with MySQL:
 109         <pre>
 110 $ mysqladmin -u freeside -p create freeside </pre>
 111     </ul>
 112   <li>Build and install the Perl modules:
 113     <pre>
 114 $ make perl-modules
 115 $ su
 116 # make install-perl-modules</pre>
 117     <li>Create the necessary configuration files:<pre>
 118 $ su
 119 # make create-config
 120 </pre>
 121     <li>Run a <b>separate</b> iteration of Apache[-SSL] with mod_perl enabled <b>as the freeside user</b>.
 122     <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>.
 123     <li>Run <tt> make install-docs</tt>.
 124 </ul>
 125 <table>
 126   <tr>
 127     <th>Mason (recommended)</th><th>Apache::ASP (deprecated)</th>
 128   </tr>
 129   <tr>
 130
 131     <td valign="top"><ul>
 132       <li>Configure Apache:
 133 <font size="-1"><pre>
 134 PerlModule HTML::Mason
 135 # your freeside docuemnt root
 136 &lt;Directory&nbsp;/var/www/freeside&gt;
 137 &lt;Files ~ (\.cgi|\.html)&gt;
 138 AddHandler perl-script .cgi .html
 139 PerlHandler HTML::Mason
 140 &lt;/Files&gt;
 141 &lt;Perl&gt;
 142 require&nbsp;"/usr/local/etc/freeside/handler.pl";
 143 &lt;/Perl&gt;
 144 &lt;/Directory&gt;
 145 </pre></font>
 146     </ul></td>
 147
 148     <td valign="top"><ul>
 149       <li>Configure Apache:
 150 <font size="-1"><pre>
 151 PerlModule Apache::ASP
 152 # your freeside document root
 153 &lt;Directory&nbsp;/var/www/freeside&gt;
 154 &lt;Files ~ (\.cgi|\.html)&gt;
 155 AddHandler perl-script .cgi .html
 156 PerlHandler Apache::ASP
 157 &lt;/Files&gt;
 158 &lt;Perl&gt;
 159 $MLDBM::RemoveTaint = 1;
 160 &lt;/Perl&gt;
 161 PerlSetVar&nbsp;Global&nbsp;/usr/local/etc/freeside/asp-global/
 162 PerlSetVar&nbsp;Debug&nbsp;2
 163 PerlSetVar&nbsp;RequestBinaryRead&nbsp;Off
 164 # your freeside document root
 165 PerlSetVar&nbsp;IncludesDir&nbsp;/var/www/freeside
 166 &lt;/Directory&gt;
 167 </pre></font>
 168     </ul></td>
 169
 170   </tr>
 171 </table>
 172 <ul>
 173 <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:
 174 <pre>
 175 #your freeside document root
 176 &lt;Directory /var/www/freeside&gt;
 177 AuthName Freeside
 178 AuthType Basic
 179 AuthUserFile /usr/local/etc/freeside/htpasswd
 180 require valid-user
 181 &lt;/Directory&gt;
 182 </pre>
 183   <li>Create one or more Freeside users (your internal sales/tech folks, not customer accounts).  These users are setup using using Apache authentication, not UNIX user accounts.  For example, using <a href="http://httpd.apache.org/docs/mod/mod_auth.html">mod_auth</a> (flat files):
 184     <ul>
 185       <li>First user:<font size="-1">
 186 <pre>$ su
 187 $ <a href="man/bin/freeside-adduser.html">freeside-adduser</a> -c -h /usr/local/etc/freeside/htpasswd <i>username</i></pre></font>
 188       <li>Additional users:<font size="-1">
 189 <pre>$ su
 190 $ <a href="man/bin/freeside-adduser.html">freeside-adduser</a> -h /usr/local/etc/freeside/htpasswd <i>username</i></pre></font>
 191     </ul>
 192   <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>
 193   <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:
 194 <pre>
 195 $ su freeside
 196 $ freeside-setup <b>username</b>
 197 </pre>
 198   Alternately, use the -s option to enable shipping addresses: <tt>freeside-setup -s <b>username</b></tt>
 199   <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:
 200 <pre>
 201 $ su freeside
 202 $ cd <b>/path/to/freeside/</b>
 203 $ bin/populate-msgcat <b>username</b>
 204 </pre>
 205   <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>)
 206   <li>Now proceed to the initial <a href="admin.html">administration</a> of your installation.
 207 </ul>
 208 </body>