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="http://www.openssh.com//">SSH</a>
  10   <li><a href="http://www.perl.com/">Perl</a>  Don't enable experimental features like threads or the PerlIO abstraction layer.
  11   <li>A <b>transactional</b> database engine supported by Perl's <a href="http://www.hermetica.com/technologia/DBI/">DBI</a>.  <a href="http://www.postgresql.org/">PostgreSQL</a> is recommended.  (see the <a href="postgresql.html">PostgreSQL notes</a>)  <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 really want to use MySQL, you need to 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>.
  12   <li>Perl modules (<a href="http://theoryx5.uwinnipeg.ca/CPAN/perl/CPAN.html">CPAN</a> will query, download and build perl modules automatically)
  13     <ul>
  14       <li><a href="http://search.cpan.org/search?dist=Array-PrintCols">Array-PrintCols</a>
  15       <li><a href="http://search.cpan.org/search?dist=Term-Query">Term-Query</a> (make test broken; install manually)
  16       <li><a href="http://search.cpan.org/search?dist=MIME-Base64">MIME-Base64</a>
  17       <li><a href="http://search.cpan.org/search?dist=Digest-MD5">Digest-MD5</a>
  18       <li><a href="http://search.cpan.org/search?dist=URI">URI</a>
  19       <li><a href="http://search.cpan.org/search?dist=HTML-Tagset">HTML-Tagset</a>
  20       <li><a href="http://search.cpan.org/search?dist=HTML-Parser">HTML-Parser</a>
  21       <li><a href="http://search.cpan.org/search?dist=libnet">libnet</a>
  22       <li><a href="http://search.cpan.org/search?dist=Locale-Codes">Locale-Codes</a>
  23       <li><a href="http://search.cpan.org/search?dist=Net-Whois">Net-Whois</a>
  24       <li><a href="http://search.cpan.org/search?dist=libwww-perl">libwww-perl</a>
  25       <li><a href="http://search.cpan.org/search?dist=Business-CreditCard">Business-CreditCard</a>
  26       <li><a href="http://search.cpan.org/search?dist=Data-ShowTable">Data-ShowTable</a>
  27       <li><a href="http://search.cpan.org/search?dist=MailTools">MailTools</a>
  28       <li><a href="http://search.cpan.org/search?dist=TimeDate">TimeDate</a>
  29       <li><a href="http://search.cpan.org/search?dist=DateManip">DateManip</a>
  30       <li><a href="http://search.cpan.org/search?dist=File-CounterFile">File-CounterFile</a>
  31       <li><a href="http://search.cpan.org/search?dist=FreezeThaw">FreezeThaw</a>
  32       <li><a href="http://search.cpan.org/search?dist=String-Approx">String-Approx</a>
  33       <li><a href="http://search.cpan.org/search?dist=Text-Template">Text-Template</a>
  34       <li><a href="http://search.cpan.org/search?dist=DBI">DBI</a>
  35       <li><a href="http://search.cpan.org/search?mode=module&query=DBD">DBD for your database engine</a>
  36       <li><a href="http://search.cpan.org/search?dist=DBIx-DBSchema">DBIx-DBSchema</a>
  37       <li><a href="http://search.cpan.org/search?dist=Net-SSH">Net-SSH</a>
  38       <li><a href="http://search.cpan.org/search?dist=String-ShellQuote">String-ShellQuote</a>
  39       <li><a href="http://search.cpan.org/search?dist=Net-SCP">Net-SCP</a>
  40     </ul>
  41 </ul>
  42 Install the Freeside distribution:
  43 <ul>
  44   <li>Add the user `freeside' to your system.
  45   <li>Allow the freeside user full access to the freeside database.
  46     <ul>
  47       <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>'
  48 $ mysql -u root -p
  49 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>
  50       <li> with <a href="http://postgresql.readysetnet.com/users-lounge/docs/7.1/postgres/user-manag.html#DATABASE-USERS">PostgreSQL</a>
  51     </ul>
  52   <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://postgresql.readysetnet.com/users-lounge/docs/7.1/postgres/managing-databases.html#MANAGE-AG-CREATEDB">PostgreSQL</a>)
  53   <li>Unpack the tarball: <pre>gunzip -c fs-x.y.z.tar.gz | tar xvf -</pre>
  54   <li>Build and install the Perl libraries:
  55     <pre>
  56 $ cd FS/
  57 $ perl Makefile.PL
  58 $ make
  59 $ su
  60 # make install UNINST=1</pre>
  61   <li>Copy or link fs-x.y.z/htdocs to your web server's document space.  <pre>mkdir /usr/local/apache/htdocs/freeside
  62 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>
  63   <li>Restrict access to this web interface.  (with <a href="http://httpd.apache.org/docs/misc/FAQ.html#user-authentication">Apache</a>)
  64   <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>)
  65   <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.
  66     <ul>
  67       <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.
  68 <pre>cd /usr/local/apache/htdocs/freeside
  69 chown -R freeside .
  70 chmod 4755 browse/*.cgi edit/*.cgi edit/process/*.cgi misc/*.cgi misc/process/*.cgi search/*.cgi view/*.cgi</pre>
  71       <li>Use Apache's <a href="http://www.apache.org/docs/suexec.html">suEXEC</a>.
  72 <pre>cd /usr/local/apache/htdocs/freeside
  73 chown -R freeside .
  74 chmod 755 browse/*.cgi edit/*.cgi edit/process/*.cgi misc/*.cgi misc/process/*.cgi search/*.cgi view/*.cgi</pre>
  75       <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.)
  76 <pre>cd /usr/local/apache/htdocs/freeside
  77 chown -R root .
  78 chmod 755 browse/*.cgi edit/*.cgi edit/process/*.cgi misc/*.cgi misc/process/*.cgi search/*.cgi view/*.cgi</pre>
  79     </ul>
  80 <li>Create the necessary <a href="config.html">configuration files</a>.
  81 <li>Create the `/usr/local/etc/freeside/counters.<i>datasrc</i>', and
  82   `/usr/local/etc/freeside/export.<i>datasrc</i>' directories for each <i>datasrc</i> (owned by the freeside user).
  83   <li>As the freeside user, run bin/fs-setup to create the database tables.
  84   <li>Now proceed to the initial <a href="admin.html">administration</a> of your installation.
  85 </ul>
  86 </body>