2 <title>Installation</title>
6 Before installing, you need:
8 <li><a href="http://www.perl.com/">Perl</a> Don't enable experimental features like threads or the PerlIO abstraction layer.
9 <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)
10 <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)
11 <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.)
12 <li><a href="http://rsync.samba.org/">rsync</a>
13 <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>.
15 <li><a href="http://www.postgresql.org/">PostgreSQL</a> is recommended (v7or later).
16 <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.
17 <!-- <li>MySQL has been reported to work. -->
18 <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>.
20 <li>Perl modules (<a href="http://theoryx5.uwinnipeg.ca/CPAN/perl/CPAN.html">CPAN</a> will query, download and build perl modules automatically)
22 <!-- <li><a href="http://search.cpan.org/search?dist=Array-PrintCols">Array-PrintCols</a>
23 <li><a href="http://search.cpan.org/search?dist=Term-Query">Term-Query</a> (make test broken; install manually) -->
24 <li><a href="http://search.cpan.org/search?dist=MIME-Base64">MIME-Base64</a>
25 <li><a href="http://search.cpan.org/search?dist=Digest-MD5">Digest-MD5</a>
26 <!-- <li><a href="http://search.cpan.org/search?dist=MD5">MD5</a> -->
27 <li><a href="http://search.cpan.org/search?dist=URI">URI</a>
28 <li><a href="http://search.cpan.org/search?dist=HTML-Tagset">HTML-Tagset</a>
29 <li><a href="http://search.cpan.org/search?dist=HTML-Parser">HTML-Parser</a>
30 <li><a href="http://search.cpan.org/search?dist=libnet">libnet</a>
31 <li><a href="http://search.cpan.org/search?dist=Locale-Codes">Locale-Codes</a>
32 <li><a href="http://search.cpan.org/search?dist=Net-Whois">Net-Whois</a>
33 <li><a href="http://search.cpan.org/search?dist=libwww-perl">libwww-perl</a>
34 <li><a href="http://search.cpan.org/search?dist=Business-CreditCard">Business-CreditCard</a>
35 <!-- <li><a href="http://search.cpan.org/search?dist=Data-ShowTable">Data-ShowTable</a> -->
36 <li><a href="http://search.cpan.org/search?dist=MailTools">MailTools</a>
37 <li><a href="http://search.cpan.org/search?dist=TimeDate">TimeDate</a>
38 <li><a href="http://search.cpan.org/search?dist=DateManip">DateManip</a>
39 <li><a href="http://search.cpan.org/search?dist=File-CounterFile">File-CounterFile</a>
40 <li><a href="http://search.cpan.org/search?dist=FreezeThaw">FreezeThaw</a>
41 <li><a href="http://search.cpan.org/search?dist=String-Approx">String-Approx</a>
42 <li><a href="http://search.cpan.org/search?dist=Text-Template">Text-Template</a>
43 <li><a href="http://search.cpan.org/search?dist=DBI">DBI</a>
44 <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)
45 <li><a href="http://search.cpan.org/search?dist=DBIx-DataSource">DBIx-DataSource</a>
46 <li><a href="http://search.cpan.org/search?dist=DBIx-DBSchema">DBIx-DBSchema</a>
47 <li><a href="http://search.cpan.org/search?dist=Net-SSH">Net-SSH</a>
48 <li><a href="http://search.cpan.org/search?dist=String-ShellQuote">String-ShellQuote</a>
49 <li><a href="http://search.cpan.org/search?dist=Net-SCP">Net-SCP</a>
50 <li><a href="http://www.apache-asp.org/">Apache::ASP</a> or <a href="http://www.masonhq.com/">HTML::Mason</a>
51 <li><a href="http://search.cpan.org/search?dist=Tie-IxHash">Tie-IxHash</a>
52 <li><a href="http://search.cpan.org/search?dist=Time-Duration">Time-Duration</a>
53 <li><a href="http://search.cpan.org/search?dist=HTML-Widgets-SelectLayers">HTML-Widgets-SelectLayers</a>
54 <li><a href="http://search.cpan.org/search?dist=Storable">Storable</a>
55 <!-- MyAccounts, maybe only for dev <li><a href="http://search.cpan.org/search?dist=Cache-Cache">Cache::Cache</a> -->
56 <li><a href="http://search.cpan.org/search?dist=ApacheDBI">Apache::DBI</a> <i>(optional but recommended for better webinterface performance)</i>
59 Install the Freeside distribution:
61 <li>Add the user and group `freeside' to your system.
62 <li>Allow the freeside user full access to the freeside database.
64 <li> with <a href="http://www.postgresql.org/users-lounge/docs/7.1/postgres/user-manag.html#DATABASE-USERS">PostgreSQL</a>:
66 $ su postgres (pgsql on some distributions)
67 $ createuser -P freeside
68 Enter password for user "freeside":
70 Shall the new user be allowed to create databases? (y/n) y
71 Shall the new user be allowed to create more new users? (y/n) n
73 <li> with <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#User_Account_Management">MySQL</a>:
75 $ mysqladmin -u root password '<i>set_a_root_database_password</i>'
77 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>
79 <!-- <li>Unpack the tarball: <pre>gunzip -c fs-x.y.z.tar.gz | tar xvf -</pre>-->
80 <li>Edit the top-level Makefile:
82 <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.
83 <li>Set <tt>DB_PASSWORD</tt> to the freeside database user's password.
85 <li>Add the freeside database to your database engine:
88 # make create-database</pre>
89 (or manually, with Postgres:)
92 $ createdb freeside</pre>
95 $ mysqladmin -u freeside -p create freeside </pre>
96 <li>Build and install the Perl modules:
100 # make install-perl-modules</pre>
101 <li>Create the necessary configuration files:<pre>
105 <li>Run a <b>separate</b> iteration of Apache[-SSL] with mod_perl enabled <b>as the freeside user</b>.
109 <th>Apache::ASP</th><th>Mason</th>
113 <li>Run <tt>make aspdocs</tt>
114 <li>Copy <tt>aspdocs/</tt> to your web server's document space:
115 <font size="-1"><pre>
116 cp aspdocs /usr/local/apache/htdocs/freeside-asp
118 <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>:
119 <font size="-1"><pre>
120 mkdir /usr/local/etc/freeside/asp-global/
121 chown freeside /usr/local/etc/freeside/asp-global/
123 <li>Copy <tt>htetc/global.asa</tt> to the Global directory:
124 <font size="-1"><pre>
125 cp htetc/global.asa /usr/local/etc/freeside/asp-global/global.asa
127 <li>Configure Apache for the Global directory and to execute .cgi files using Apache::ASP. For example:
128 <font size="-1"><pre>
129 PerlModule Apache::ASP
130 <Directory /usr/local/apache/htdocs/freeside-asp>
131 <Files ~ (\.cgi)>
132 AddHandler perl-script .cgi
133 PerlHandler Apache::ASP
136 $MLDBM::RemoveTaint = 1;
138 PerlSetVar Global /usr/local/etc/freeside/asp-global/
144 <li>Run <tt>make masondocs</tt>
145 <li>Copy <tt>masondocs/</tt> to your web server's document space. (For example: <tt>/usr/local/apache/htdocs/freeside-mason</tt>)
146 <li>Copy <tt>htetc/handler.pl</tt> to <tt>/usr/local/etc/freeside</tt> (use htetc/handler.pl-1.0x for Mason versions before 1.10).
147 <li>Edit <tt>handler.pl</tt> and:
149 <li> set an appropriate <tt>comp_root</tt>, such as <tt>/usr/local/apache/htdocs/freeside-mason</tt>
150 <li> set an appropriate <tt>data_dir</tt>, such as <tt>/usr/local/etc/freeside/masondata</tt>
153 <li>Configure Apache to use the <tt>handler.pl</tt> file and to execute .cgi files using HTML::Mason. For example:
154 <font size="-1"><pre>
155 PerlModule HTML::Mason
156 <Directory /usr/local/apache/htdocs/freeside-mason>
157 <Files ~ (\.cgi)>
158 AddHandler perl-script .cgi
159 PerlHandler HTML::Mason
162 require "/usr/local/etc/freeside/handler.pl";
170 <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):
172 <Directory /usr/local/apache/htdocs/freeside-asp>
175 AuthUserFile /usr/local/etc/freeside/htpasswd
179 <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):
181 <li>First user:<font size="-1">
183 $ <a href="man/bin/freeside-adduser.html">freeside-adduser</a> -c -h /usr/local/etc/freeside/htpasswd <i>username</i></pre></font>
184 <li>Additional users:<font size="-1">
186 $ <a href="man/bin/freeside-adduser.html">freeside-adduser</a> -h /usr/local/etc/freeside/htpasswd <i>username</i></pre></font>
188 <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>
189 <li>As the freeside UNIX user, run <tt>bin/fs-setup <b>username</b></tt> (in the untar'ed freeside directory) to create the database tables, passing the username of a Freeside user you created above:
192 $ cd <b>/path/to/freeside/</b>
193 $ bin/fs-setup <b>username</b>
195 <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:
198 $ cd <b>/path/to/freeside/</b>
199 $ bin/populate-msgcat <b>username</b>
201 <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>)
202 <li>Now proceed to the initial <a href="admin.html">administration</a> of your installation.