htdocs/docs/install.html

   1 <head>
   2   <title>Installation</title>
   3 </head>
   4 <body>
   5 <h1>Installation</h1>
   6 Before installing, you need:
   7 <ul>
   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_05 for the 5.004 series or 5.005_03 for the 5.005 series.  Don't enable experimental features like threads or the PerlIO abstraction layer.)
  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> (verstion 6.5 or higher) (see the <a href="postgresql.html">PostgreSQL notes</a>)
  12   <li>Perl modules (<a href="http://www.perl.com/CPAN/doc/manual/html/lib/CPAN.html">CPAN</a> will query, download and build perl modules automatically)
  13     <ul>
  14       <li><a href="http://www.perl.com/CPAN/modules/by-module/Array/">Array-PrintCols</a>
  15       <li><a href="http://www.perl.com/CPAN/modules/by-module/Term/">Term-Query</a> (make test broken; install manually)
  16       <li><a href="http://www.perl.com/CPAN/modules/by-module/MIME/">MIME-Base64</a>
  17       <li><a href="http://www.perl.com/CPAN/modules/by-module/Data">Data-Dumper</a>
  18       <li><a href="http://www.perl.com/CPAN/modules/by-module/MD5">Digest-MD5</a>
  19       <li><a href="http://www.perl.com/CPAN/modules/by-module/URI">URI</a>
  20       <li><a href="http://www.perl.com/CPAN/modules/by-module/HTTP">HTML-Parser</a>
  21       <li><a href="http://www.perl.com/CPAN/modules/by-module/Net">libnet</a>
  22       <li><a href="http://www.perl.com/CPAN/modules/by-module/Locale">Locale-Codes</a>
  23       <li><a href="http://www.perl.com/CPAN/modules/by-module/Net">Net-Whois</a>
  24       <li><a href="http://www.perl.com/CPAN/modules/by-module/LWP/">libwww-perl</a>
  25       <li><a href="http://www.perl.com/CPAN/modules/by-module/Business/">Business-CreditCard</a>
  26       <li><a href="http://www.perl.com/CPAN/modules/by-module/Data/">Data-ShowTable</a>
  27       <li><a href="http://www.perl.com/CPAN/modules/by-module/Mail/">MailTools</a>
  28       <li><a href="http://www.perl.com/CPAN/modules/by-module/Time/">TimeDate</a>
  29       <li><a href="http://www.perl.com/CPAN/modules/by-module/Date/">DateManip</a>
  30       <li><a href="http://www.perl.com/CPAN/modules/by-module/File/">File-CounterFile</a>
  31       <li><a href="http://www.perl.com/CPAN/modules/by-module/FreezeThaw/">FreezeThaw</a>
  32       <li><a href="http://www.perl.com/CPAN/modules/by-module/String/">String-Approx</a>
  33       <li><a href="http://www.perl.com/CPAN/modules/by-module/DBI/">DBI
  34       <li><a href="http://www.perl.com/CPAN/modules/by-module/DBD/">DBD for your database engine</a>
  35     </ul>
  36 </ul>
  37 Install the Freeside distribution:
  38 <ul>
  39   <li>Add the user `freeside' to your system.
  40   <li>Add the freeside database to your database engine.  (with <a href="http://www.mysql.com/Manual_chapter/manual_Reference.html#CREATE_DATABASE">MySQL</a>) (with <a href="http://www.postgresql.org/docs/admin/manage-ag.htm#AEN854">PostgreSQL</a>)
  41   <li>Allow the freeside user full access to the freeside database.
  42     <ul>
  43       <li> with <a href="http://www.mysql.com/Manual_chapter/manual_Privilege_system.html#Privilege_system">MySQL</a>:<pre>$ mysqladmin -u root password '<i>set_a_root_database_password</i>'
  44 $ mysql -u root -p
  45 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>
  46       <li> with <a href="http://www.postgresql.org/docs/admin/newuser.htm">PostgreSQL</a>
  47     </ul>
  48   <li>Unpack the tarball: <pre>gunzip -c fs-x.y.z.tar.gz | tar xvf -</pre>
  49   <li>Build and install the Perl libraries:
  50     <pre>
  51 $ cd FS/
  52 $ perl Makefile.PL
  53 $ make
  54 $ su
  55 # make install</pre>
  56   <li>Copy or link fs-x.y.z/htdocs to your web server's document space.  <pre>mkdir /usr/local/apache/htdocs/freeside
  57 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>
  58   <li>Restrict access to this web interface.  (with <a href="http://www.apache.org/docs/misc/FAQ.html#user-authentication">Apache</a>)
  59   <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>)
  60   <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.
  61     <ul>
  62       <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.
  63 <pre>cd /usr/local/apache/htdocs/freeside
  64 chown -R freeside .
  65 chmod 4755 browse/*.cgi edit/*.cgi edit/process/*.cgi misc/*.cgi misc/process/*.cgi search/*.cgi view/*.cgi</pre>
  66       <li>Use Apache's <a href="http://www.apache.org/docs/suexec.html">suEXEC</a>.
  67 <pre>cd /usr/local/apache/htdocs/freeside
  68 chown -R freeside .
  69 chmod 755 browse/*.cgi edit/*.cgi edit/process/*.cgi misc/*.cgi misc/process/*.cgi search/*.cgi view/*.cgi</pre>
  70       <li>Use <a href="http://perl.apache.org/">mod_perl</a>.  You should run a separate iteration of Apache[-SSL] as the freeside user.  (Warning:  The redirect method of CGI.pm 2.36 [as distributed with Perl 5.004_04] is broken under mod_perl.  Downlaod the current version from <a href="http://www.perl.com/CPAN/modules/by-module/CGI">CPAN</a>.  Apache 1.3.6 is also highly recommended because of signal handling problems in earlier versions.)
  71 <pre>cd /usr/local/apache/htdocs/freeside
  72 chown -R root .
  73 chmod 755 browse/*.cgi edit/*.cgi edit/process/*.cgi misc/*.cgi misc/process/*.cgi search/*.cgi view/*.cgi</pre>
  74     </ul>
  75 <li>Create the necessary <a href="config.html">configuration files</a>.
  76 <li>Create the `/usr/local/etc/freeside/counters.<i>datasrc</i>', and
  77   `/usr/local/etc/freeside/export.<i>datasrc</i>' directories for each <i>datasrc</i> (owned by the freeside user).
  78   <li>As the freeside user, run bin/fs-setup to create the database tables.
  79 </ul>
  80 </body>