X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=httemplate%2Fdocs%2Finstall.html;h=d4507a2a5dae86dac886dd5b37a21678f2b4d898;hp=1f271e6d2b730a201cbe74e12c6f5d0b28268aa5;hb=582e73e52fd2f0324e8836ee66ae69e7a82ed364;hpb=5bfc7cd4f5aac2905119ba076a23df1f13b58f7b diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html index 1f271e6d2..d4507a2a5 100644 --- a/httemplate/docs/install.html +++ b/httemplate/docs/install.html @@ -3,35 +3,37 @@

Installation

+Note: Install Freeside on a firewalled, private server, not a public (web, RADIUS, etc.) server.

Before installing, you need:

Perl Don't enable experimental features like threads or the PerlIO abstraction layer. +
Perl
Apache (mod_ssl or Apache-SSL highly recommended)
mod_perl (if compiling your own mod_perl, make sure you set the EVERYTHING=1 compile-time option)
SSH (OpenSSH is recommended. SSH Communications Security commercial SSH version 3 has been reported incompatible with Freeside.)
rsync
A transactional database engine supported by Perl's DBI.
- PostgreSQL (v7 or higher) is recommended. -
- MySQL has been reported to work. - MySQL's default MyISAM and ISAM table types are not supported. If you want to use MySQL, you must use one of the new transaction-safe table types such as BDB or InnoDB, and set it as the default table type when running fs-setup using the --default-table-type=BDB or --default-table-type=InnoDB mysqld command-line option or by setting default-table-type=BDB or --default-table-type=InnoDB in the my.cnf option file. +
- PostgreSQL is recommended (v7or later). +
- MySQL MINIMUM VERSION 4.1 is untested but may work. Versions before 4.1 do not support standard SQL subqueries and are NOT SUPPORTED. If you are a developer who wishes to contribute MySQL 3.x/4.0 support, see ticket #438 in the bug-tracking system and ask on the -devel mailing list. + + MySQL's default MyISAM and ISAM table types are not supported. If you want to use MySQL, you must use one of the new transaction-safe table types such as BDB or InnoDB, and set it as the default table type using the --default-table-type=BDB or --default-table-type=InnoDB mysqld command-line option or by setting default-table-type=BDB or default-table-type=InnoDB in the my.cnf option file.
-
Perl modules (CPAN will query, download and build perl modules automatically) +
Perl modules (CPAN will query, download and build perl modules automatically)
- Array-PrintCols -
- Term-Query (make test broken; install manually) +
- MIME-Base64
- Digest-MD5 -
- MD5 +
- URI
- HTML-Tagset
- HTML-Parser
- libnet
- Locale-Codes -
- Net-Whois +
- Net-Whois-Raw
- libwww-perl
- Business-CreditCard -
- Data-ShowTable +
- MailTools
- TimeDate
- DateManip @@ -46,22 +48,26 @@ Before installing, you need:
- Net-SSH
- String-ShellQuote
- Net-SCP -
- Apache::ASP or HTML::Mason +
- HTML::Mason (recommended, enables full functionality) or Apache::ASP (deprecated, integrated RT ticketing will not be available)
- Tie-IxHash
- Time-Duration
- HTML-Widgets-SelectLayers
- Storable + +
- NetAddr-IP +
- Chart +
- Crypt::PasswdMD5
- Apache::DBI (optional but recommended for better webinterface performance)

Install the Freeside distribution:

Add the user `freeside' to your system. +
Add the user and group `freeside' to your system.

Allow the freeside user full access to the freeside database.

with PostgreSQL:

-$ su postgres
+$ su postgres (pgsql on some distributions)
 $ createuser -P freeside
 Enter password for user "freeside": 
 Enter it again: 
@@ -77,7 +83,7 @@ mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP on freeside.* T
 
   Edit the top-level Makefile:
     
-      Set DATASOURCE to your DBI data source, for example, DBI:Pg:host=localhost;dbname=freeside for PostgresSQL or DBI:mysql:freeside for MySQL.  See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.
+      
Set DATASOURCE to your DBI data source, for example, DBI:Pg:dbname=freeside for PostgresSQL or DBI:mysql:freeside for MySQL.  See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.
       
Set DB_PASSWORD to the freeside database user's password.
     
   
Add the freeside database to your database engine:
@@ -109,7 +115,10 @@ $ su
   
     
       Run make aspdocs
-      
Copy aspdocs/ to your web server's document space.
+      
Copy aspdocs/ to your web server's document space:
++cp aspdocs /usr/local/apache/htdocs/freeside-asp
+
       
Create a Global directory, such as /usr/local/etc/freeside/asp-global/:
  mkdir /usr/local/etc/freeside/asp-global/
@@ -119,35 +128,46 @@ chown freeside /usr/local/etc/freeside/asp-global/
  cp htetc/global.asa /usr/local/etc/freeside/asp-global/global.asa
 
-      Configure Apache for the Global directory and to execute .cgi files using Apache::ASP.  For example:
+      
Configure Apache for the Global directory and to execute .cgi files using Apache::ASP.  For example, add something like the following to your Apache httpd.conf file, adjusting for your actual paths:
 +PerlModule Apache::ASP
+# your freeside document root
 <Directory /usr/local/apache/htdocs/freeside-asp>
-<Files ~ (\.cgi)>
-AddHandler perl-script .cgi
+<Files ~ (\.cgi|\.html)>
+AddHandler perl-script .cgi .html
 PerlHandler Apache::ASP
 </Files>
 <Perl>
 $MLDBM::RemoveTaint = 1;
 </Perl>
 PerlSetVar Global /usr/local/etc/freeside/asp-global/
-PerlSetVar Debug 2
+PerlSetVar Debug 2
+PerlSetVar RequestBinaryRead Off
+# your freeside document root
+PerlSetVar IncludesDir /usr/local/apache/htdocs/freeside-asp
 </Directory>
 
     

     
       Run make masondocs
-      
Copy masondocs/ to your web server's document space.
-      
Copy htetc/handler.pl to your web server's configuration directory.
-      
Edit handler.pl and set an appropriate data_dir, such as /usr/local/etc/freeside/mason-data
-      
Configure Apache to use the handler.pl file and to execute .cgi files using HTML::Mason.  For example:
+      
Copy masondocs/ to your web server's document space. (For example: /usr/local/apache/htdocs/freeside-mason)
+      
Copy htetc/handler.pl to /usr/local/etc/freeside
+      
Edit handler.pl and:
+      
+         set an appropriate comp_root, such as /usr/local/apache/htdocs/freeside-mason
+        
 set an appropriate data_dir, such as /usr/local/etc/freeside/masondata
+      
+
+      Configure Apache to use the handler.pl file and to execute .cgi files using HTML::Mason.  For example, add something like the following to your Apache httpd.conf file, adjusting for your actual paths:
 +PerlModule HTML::Mason
 <Directory /usr/local/apache/htdocs/freeside-mason>
-<Files ~ (\.cgi)>
-AddHandler perl-script .cgi
+<Files ~ (\.cgi|\.html)>
+AddHandler perl-script .cgi .html
 PerlHandler HTML::Mason
 </Files>
 <Perl>
-require "/usr/local/apache/conf/handler.pl";
+require "/usr/local/etc/freeside/handler.pl";
 </Perl>
 </Directory>
 
@@ -155,10 +175,9 @@ require "/usr/local/apache/conf/handler.pl";
   
 
 
-Restrict access to this web interface - see the Apache documentation on user authentication.    For example, to configure user authentication with mod_auth (flat files):
+Restrict access to this web interface - see the Apache documentation on user authentication.    For example, to configure user authentication with mod_auth (flat files), add something like the following to your Apache httpd.conf file, adjusting for your actual paths:
  <Directory /usr/local/apache/htdocs/freeside-asp>
-PerlSetVar Global /usr/local/etc/freeside/asp-global/
 AuthName Freeside
 AuthType Basic
 AuthUserFile /usr/local/etc/freeside/htpasswd
@@ -175,19 +194,19 @@ $ freeside-adduser -c -h /usr/local/
 $ freeside-adduser -h /usr/local/etc/freeside/htpasswd username
     
   (using other auth types, add each user to your Apache authentication and then run: freeside-adduser username
-  
As the freeside UNIX user, run bin/fs-setup username (in the untar'ed freeside directory) to create the database tables, passing the username of a Freeside user you created above:
+  
As the freeside UNIX user, run freeside-setup username to create the database tables, passing the username of a Freeside user you created above:
  $ su freeside
-$ cd /path/to/freeside-1.4.0/
-$ bin/fs-setup username
+$ freeside-setup username
 
+  Alternately, use the -s option to enable shipping addresses: freeside-setup -s username
   
As the freeside UNIX user, run bin/populate-msgcat username (in the untar'ed freeside directory) to populate the message catalog, passing the username of a Freeside user you created above:
  $ su freeside
-$ cd /path/to/freeside-1.4.0/
+$ cd /path/to/freeside/
 $ bin/populate-msgcat username
 
-  
freeside-queued 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 system, and run make install-init)
+  
freeside-queued 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 make install-init)
   
Now proceed to the initial administration of your installation.