X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=httemplate%2Fdocs%2Finstall.html;h=76c3d3b93c6b1a61463a3531db5786090f518d68;hb=f1e32f75485b6764253009bf90b3bd49b54814bc;hp=4d723119d4bb7070347b433e1f66d940ccac2440;hpb=547368c36357ea54ec634b9b019240c1278326b7;p=freeside.git diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html index 4d723119d..76c3d3b93 100644 --- a/httemplate/docs/install.html +++ b/httemplate/docs/install.html @@ -3,9 +3,10 @@

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.) @@ -17,7 +18,7 @@ Before installing, you need: 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)

HTML-Parser
libnet
Locale-Codes -
Net-Whois +
Net-Whois-Raw
libwww-perl
Business-CreditCard @@ -47,12 +48,13 @@ Before installing, you need:
Net-SSH
String-ShellQuote
Net-SCP -
Apache::ASP or HTML::Mason (use version 1.0x - Freeside is not yet compatible with version 1.1x) +
Apache::ASP or HTML::Mason
Tie-IxHash
Time-Duration
HTML-Widgets-SelectLayers
Storable +
Crypt::PasswdMD5
Apache::DBI (optional but recommended for better webinterface performance)

@@ -63,7 +65,7 @@ Install the Freeside distribution:

with PostgreSQL:

-$ su postgres
+$ su postgres (pgsql on some distributions)
 $ createuser -P freeside
 Enter password for user "freeside": 
 Enter it again: 
@@ -79,7 +81,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:
@@ -124,7 +126,7 @@ 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
 <Directory /usr/local/apache/htdocs/freeside-asp>
@@ -136,17 +138,22 @@ PerlHandler Apache::ASP
 $MLDBM::RemoveTaint = 1;
 </Perl>
 PerlSetVar Global /usr/local/etc/freeside/asp-global/
-PerlSetVar Debug 2
+PerlSetVar Debug 2
+PerlSetVar RequestBinaryRead Off
 </Directory>

(use version 1.0x - Freeside is not yet compatible with version 1.1x)
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 (use htetc/handler.pl-1.0x for Mason versions before 1.10). +
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>
@@ -155,7 +162,7 @@ AddHandler perl-script .cgi
 PerlHandler HTML::Mason
 </Files>
 <Perl>
-require "/usr/local/apache/conf/handler.pl";
+require "/usr/local/etc/freeside/handler.pl";
 </Perl>
 </Directory>
 
```
@@ -163,10 +170,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
@@ -183,16 +189,16 @@ $ 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/
-$ 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 systemand QUEUED_USER with the username of a Freeside user you created above, and run make install-init)