<i>Note: Install Freeside on a firewalled, private server, not a public (web, RADIUS, etc.) server.</i><br><br>
Before installing, you need:
<ul>
- <li><a href="http://www.perl.com/">Perl</a>
+ <li><a href="http://www.perl.com/">Perl</a>, minimum version 5.005_03. (5.8.3 for the integrated RT ticketing)
<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)
<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)
<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.)
<li><a href="http://rsync.samba.org/">rsync</a>
+ <li>Optional, enables typeset invoices: teTeX and Ghostscript (included with most distributions).
<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>.
<ul>
- <li><a href="http://www.postgresql.org/">PostgreSQL</a> is recommended (v7or later).
- <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>. If you are a developer who wishes to contribute MySQL 3.x/4.0 support, see <a href="http://pouncequick.420.am/rt/Ticket/Display.html?id=438">ticket #438</a> in the bug-tracking system and ask on the -devel mailing list.
-<!-- <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 want to use MySQL, 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/B/D/BDB.html">BDB</a> or <a href="http://www.mysql.com/doc/I/n/InnoDB.html">InnoDB</a>, and set it as the default table type using the <code>--default-table-type=BDB</code> or <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=BDB</code> or <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>.
+ <li><a href="http://www.postgresql.org/">PostgreSQL</a> is recommended (v7.2 or later).
+ <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>
+ <!-- <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>.
+<!-- <li>MySQL has been reported to work.
+ 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>
<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/search?dist=Array-PrintCols">Array-PrintCols</a>
- <li><a href="http://search.cpan.org/search?dist=Term-Query">Term-Query</a> (make test broken; install manually) -->
- <li><a href="http://search.cpan.org/search?dist=MIME-Base64">MIME-Base64</a>
- <li><a href="http://search.cpan.org/search?dist=Digest-MD5">Digest-MD5</a>
-<!-- <li><a href="http://search.cpan.org/search?dist=MD5">MD5</a> -->
- <li><a href="http://search.cpan.org/search?dist=URI">URI</a>
- <li><a href="http://search.cpan.org/search?dist=HTML-Tagset">HTML-Tagset</a>
- <li><a href="http://search.cpan.org/search?dist=HTML-Parser">HTML-Parser</a>
- <li><a href="http://search.cpan.org/search?dist=libnet">libnet</a>
- <li><a href="http://search.cpan.org/search?dist=Locale-Codes">Locale-Codes</a>
- <li><a href="http://search.cpan.org/search?dist=Net-Whois">Net-Whois</a>
- <li><a href="http://search.cpan.org/search?dist=libwww-perl">libwww-perl</a>
- <li><a href="http://search.cpan.org/search?dist=Business-CreditCard">Business-CreditCard</a>
-<!-- <li><a href="http://search.cpan.org/search?dist=Data-ShowTable">Data-ShowTable</a> -->
- <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=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=DBI">DBI</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=Time-Duration">Time-Duration</a>
- <li><a href="http://search.cpan.org/search?dist=HTML-Widgets-SelectLayers">HTML-Widgets-SelectLayers</a>
- <li><a href="http://search.cpan.org/search?dist=Storable">Storable</a>
-<!-- MyAccounts, maybe only for dev <li><a href="http://search.cpan.org/search?dist=Cache-Cache">Cache::Cache</a> -->
- <li><a href="http://search.cpan.org/search?dist=NetAddr-IP">NetAddr-IP</a>
- <li><a href="http://search.cpan.org/search?dist=Chart">Chart</a>
- <li><a href="http://search.cpan.org/search?dist=Crypt-PasswdMD5">Crypt::PasswdMD5</a>
- <li><a href="http://search.cpan.org/search?dist=ApacheDBI">Apache::DBI</a> <i>(optional but recommended for better webinterface performance)</i>
+<!-- <li><a href="http://search.cpan.org/dist/Array-PrintCols">Array-PrintCols</a>
+ <li><a href="http://search.cpan.org/dist/Term-Query">Term-Query</a> (make test broken; install manually) -->
+ <li><a href="http://search.cpan.org/dist/MIME-Base64">MIME-Base64</a>
+ <li><a href="http://search.cpan.org/dist/Digest-MD5">Digest-MD5</a>
+<!-- <li><a href="http://search.cpan.org/dist/MD5">MD5</a> -->
+ <li><a href="http://search.cpan.org/dist/URI">URI</a>
+ <li><a href="http://search.cpan.org/dist/HTML-Tagset">HTML-Tagset</a>
+ <li><a href="http://search.cpan.org/dist/HTML-Parser">HTML-Parser</a>
+ <li><a href="http://search.cpan.org/dist/libnet">libnet</a>
+ <li><a href="http://search.cpan.org/dist/Locale-Codes">Locale-Codes</a>
+ <li><a href="http://search.cpan.org/dist/Net-Whois-Raw">Net-Whois-Raw</a>
+ <li><a href="http://search.cpan.org/dist/libwww-perl">libwww-perl</a>
+ <li><a href="http://search.cpan.org/dist/Business-CreditCard">Business-CreditCard</a>
+<!-- <li><a href="http://search.cpan.org/dist/Data-ShowTable">Data-ShowTable</a> -->
+ <li><a href="http://search.cpan.org/dist/MailTools">MailTools</a>
+ <li><a href="http://search.cpan.org/dist/TimeDate">TimeDate</a>
+ <li><a href="http://search.cpan.org/dist/DateManip">DateManip</a>
+ <li><a href="http://search.cpan.org/dist/File-CounterFile">File-CounterFile</a>
+ <li><a href="http://search.cpan.org/dist/FreezeThaw">FreezeThaw</a>
+ <li><a href="http://search.cpan.org/dist/String-Approx">String-Approx</a>
+ <li><a href="http://search.cpan.org/dist/Text-Template">Text-Template</a>
+ <li><a href="http://search.cpan.org/dist/DBI">DBI</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/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/dist/DBIx-DataSource">DBIx-DataSource</a> -->
+ <li><a href="http://search.cpan.org/dist/DBIx-DBSchema">DBIx-DBSchema</a>
+ <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://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>
+ <li><a href="http://search.cpan.org/dist/Storable">Storable</a>
+ <li><a href="http://search.cpan.org/dist/Cache-Cache">Cache::Cache</a>
+ <li><a href="http://search.cpan.org/dist/NetAddr-IP">NetAddr-IP</a>
+ <li><a href="http://search.cpan.org/dist/Chart">Chart</a>
+ <li><a href="http://search.cpan.org/dist/Crypt-PasswdMD5">Crypt::PasswdMD5</a>
+ <li><a href="http://search.cpan.org/dist/JavaScript-RPC">JavaScript::RPC (JavaScript::RPC::Server::CGI)</a>
+ <li><a href="http://search.cpan.org/dist/Frontier-RPC">Frontier::RPC</a>
+ <li><a href="http://search.cpan.org/dist/Text-CSV_XS">Text::CSV_XS</a>
+ <li><a href="http://search.cpan.org/dist/Spreadsheet-WriteExcel">Spreadsheet::WriteExcel</a>
+ <li><a href="http://search.cpan.org/dist/IO-stringy">IO-stringy (IO::Scalar)</a>
+<!-- <li><a href="http://search.cpan.org/dist/Crypt-YAPassGen">Crypt::YAPassGen</a> -->
+ <li><a href="http://search.cpan.org/dist/ApacheDBI">Apache::DBI</a> <i>(optional but recommended for better webinterface performance)</i>
</ul>
</ul>
Install the Freeside distribution:
<li>Set <tt>DB_PASSWORD</tt> to the freeside database user's password.
</ul>
<li>Add the freeside database to your database engine:
- <pre>
-$ su
-# make create-database</pre>
- (or manually, with Postgres:)
- <pre>
+ <ul>
+ <li>with Postgres:
+ <pre>
$ su freeside
-$ createdb freeside</pre>
- (with MySQL:)
- <pre>
+$ createdb -E sql_ascii freeside</pre>
+ <li>with MySQL:
$ mysqladmin -u freeside -p create freeside </pre>
+ </ul>
<li>Build and install the Perl modules:
<pre>
$ make perl-modules
# make create-config
</pre>
<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>Apache::ASP</th><th>Mason</th>
+ <th>Mason (recommended)</th><th>Apache::ASP (deprecated)</th>
</tr>
<tr>
- <td><ul>
- <li>Run <tt>make aspdocs</tt>
- <li>Copy <tt>aspdocs/</tt> to your web server's document space:
-<font size="-1"><pre>
-cp aspdocs /usr/local/apache/htdocs/freeside-asp
-</pre></font>
- <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>:
-<font size="-1"><pre>
-mkdir /usr/local/etc/freeside/asp-global/
-chown freeside /usr/local/etc/freeside/asp-global/
-</pre></font>
- <li>Copy <tt>htetc/global.asa</tt> to the Global directory:
+
+ <td valign="top"><ul>
+ <li>Configure Apache:
<font size="-1"><pre>
-cp htetc/global.asa /usr/local/etc/freeside/asp-global/global.asa
+PerlModule HTML::Mason
+# your freeside docuemnt root
+<Directory /var/www/freeside>
+<Files ~ (\.cgi|\.html)>
+AddHandler perl-script .cgi .html
+PerlHandler HTML::Mason
+</Files>
+<Perl>
+require "/usr/local/etc/freeside/handler.pl";
+</Perl>
+</Directory>
</pre></font>
- <li>Configure Apache for the Global directory and to execute .cgi files using Apache::ASP. For example:
+ </ul></td>
+
+ <td valign="top"><ul>
+ <li>Configure Apache:
<font size="-1"><pre>
PerlModule Apache::ASP
# your freeside document root
-<Directory /usr/local/apache/htdocs/freeside-asp>
+<Directory /var/www/freeside>
<Files ~ (\.cgi|\.html)>
-SetHandler perl-script
+AddHandler perl-script .cgi .html
PerlHandler Apache::ASP
</Files>
<Perl>
PerlSetVar Debug 2
PerlSetVar RequestBinaryRead Off
# your freeside document root
-PerlSetVar IncludesDir /usr/local/apache/htdocs/freeside-asp
+PerlSetVar IncludesDir /var/www/freeside
</Directory>
</pre></font>
</ul></td>
- <td><ul>
- <li>Run <tt>make masondocs</tt>
- <li>Copy <tt>masondocs/</tt> to your web server's document space. (For example: <tt>/usr/local/apache/htdocs/freeside-mason</tt>)
- <li>Copy <tt>htetc/handler.pl</tt> to <tt>/usr/local/etc/freeside</tt>
- <li>Edit <tt>handler.pl</tt> and:
- <ul>
- <li> set an appropriate <tt>comp_root</tt>, such as <tt>/usr/local/apache/htdocs/freeside-mason</tt>
- <li> set an appropriate <tt>data_dir</tt>, such as <tt>/usr/local/etc/freeside/masondata</tt>
- </ul>
- <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>
-PerlModule HTML::Mason
-<Directory /usr/local/apache/htdocs/freeside-mason>
-<Files ~ (\.cgi|.html)>
-SetHandler perl-script
-PerlHandler HTML::Mason
-</Files>
-<Perl>
-require "/usr/local/etc/freeside/handler.pl";
-</Perl>
-</Directory>
-</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):
+<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>
-<Directory /usr/local/apache/htdocs/freeside-asp>
+#your freeside document root
+<Directory /var/www/freeside>
AuthName Freeside
AuthType Basic
AuthUserFile /usr/local/etc/freeside/htpasswd
<pre>$ su
$ <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>
+ <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>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
projects / freeside.git / blobdiff