2 <title>Installation</title>
6 Before installing, you need:
8 <li>A web server, such as <a href="http://www.apache-ssl.org">Apache-SSL</a> or <a href="http://www.apache.org">Apache</a>
9 <li><a href="ftp://ftp.cs.hut.fi/pub/ssh/">SSH</a>
10 <li><a href="http://www.perl.com/CPAN/doc/relinfo/INSTALL.html">Perl</a> (at least 5.004_04)
11 <li>A database engine supported by Perl's <a href="http://www.hermetica.com/technologia/DBI/">DBI</a>, such as <a href="http://www.tcx.se/">MySQL</a> or <a href="http://www.postgresql.org/">PostgreSQL</a>
14 <li><a href="http://www.perl.com/CPAN/modules/by-module/MIME/">MIME-Base64</a>
15 <li><a href="http://www.perl.com/CPAN/modules/by-module/Data">Data-Dumper</a>
16 <li><a href="http://www.perl.com/CPAN/modules/by-module/MD5">MD5</a>
17 <li><a href="http://www.perl.com/CPAN/modules/by-module/Net">libnet</a>
18 <li><a href="http://www.perl.com/CPAN/modules/by-module/LWP/">libwww-perl</a>
19 <li><a href="http://www.perl.com/CPAN/modules/by-module/Business/">Business-CreditCard</a>
20 <li><a href="http://www.perl.com/CPAN/modules/by-module/Data/">Data-ShowTable</a>
21 <li><a href="http://www.perl.com/CPAN/modules/by-module/Mail/">MailTools</a>
22 <li><a href="http://www.perl.com/CPAN/modules/by-module/Time/">TimeDate</a>
23 <li><a href="http://www.perl.com/CPAN/modules/by-module/Date/">DateManip</a>
24 <li><a href="http://www.perl.com/CPAN/modules/by-module/File/">File-CounterFile</a>
25 <li><a href="http://www.perl.com/CPAN/modules/by-module/FreezeThaw/">FreezeThaw</a>
26 <li><a href="http://www.perl.com/CPAN/modules/by-module/String/">String-Approx</a>
27 <li><a href="http://www.perl.com/CPAN/modules/by-module/DBI/">DBI
28 <li><a href="http://www.perl.com/CPAN/modules/by-module/DBD/">DBD for your database engine</a>
31 Install the Freeside distribution:
33 <li>Add the user `freeside' to your system.
34 <li>Add the freeside database to your database engine. (with <a href="http://www.mysql.com/Manual_chapter/manual_Syntax.html#Create database">MySQL</a>) (with <a href="http://www.postgresql.org/docs/admin/manage-ag.htm#AEN854">PostgreSQL</a>)
35 <li>Allow the freeside user full access to the freeside database. (with <a href="http://www.mysql.com/Manual_chapter/manual_Privilege_system.html#Privilege system">MySQL</a>) (with <a href="http://www.postgresql.org/docs/admin/newuser.htm">PostgreSQL</a>)
36 <li>Unpack the tarball: <pre>gunzip -c fs-x.y.z.tar.gz | tar xvf -</pre>
37 <li>Copy or link fs-x.y.z/site_perl to FS in your site_perl directory. (try `<code>perl -V</code>' if unsure) <pre>mkdir /usr/local/lib/site_perl/FS
38 cp fs-x.y.z/site_perl/* /usr/local/lib/site_perl/FS</pre> or <pre>ln -s /full/path/to/fs-x.y.z/site_perl /usr/local/lib/site_perl/FS</pre>
39 <li>Copy or link fs-x.y.z/htdocs to your web server's document space. <pre>mkdir /usr/local/apache/htdocs/freeside
40 cp -r fs-x.y.z/htdocs/* /usr/local/apache/htdocs/freeside</pre> or <pre>ln -s /full/path/to/fs-x.y.z/htdocs /usr/local/apache/htdocs/freeside</pre>
41 <li>Restrict access to this web interface. (with <a href="http://www.apache.org/docs/misc/FAQ.html#user-authentication">Apache</a>)
42 <li>Enable CGI execution for files with the `.cgi' extension. (with <a href="http://www.apache.org/docs/mod/mod_mime.html#addhandler">Apache</a>)
43 <li>Set ownership and permissions for the web interface. The web interface needs to run as the freeside user - there are several ways to do this.
45 <li>Use Perl's setuid emulation: see the <a href="http://www.perl.com/CPAN-local/doc/manual/html/pod/perlsec.html#Security_Bugs">Security Bugs</a> section of the <a href="http://www.perl.com/CPAN-local/doc/manual/html/pod/perlsec.html">perlsec</a> manpage.
46 <pre>cd /usr/local/apache/htdocs/freeside
48 chmod 4755 browse/*.cgi edit/*.cgi edit/process/*.cgi misc/*.cgi misc/process/*.cgi search/*.cgi view/*.cgi</pre>
49 <li>Use Apache's <a href="http://www.apache.org/docs/suexec.html">suEXEC</a>.
50 <pre>cd /usr/local/apache/htdocs/freeside
52 chmod 755 browse/*.cgi edit/*.cgi edit/process/*.cgi misc/*.cgi misc/process/*.cgi search/*.cgi view/*.cgi</pre>
54 <li>Create the necessary <a href="config.html">configuration files</a>.
55 <li>Create the `/usr/local/etc/freeside/counters.<i>datasrc</i>', and
56 `/usr/local/etc/freeside/export.<i>datasrc</i>' directories for each <i>datasrc</i>.
57 <li>As the freeside user, run bin/fs-setup to create the database tables.