X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=httemplate%2Fdocs%2Finstall.html;h=52d992dbcb7154bb25bd860747fd71f17f186080;hp=3c48a746f2aaa523f9116773ea373e3d2ebb00ed;hb=b2790f150672ee966a02bfb3fe81c7b6a235cfa8;hpb=c4d2226e0cc4bdd6d9f689b061b5f4f5b9609b0b diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html index 3c48a746f..52d992dbc 100644 --- a/httemplate/docs/install.html +++ b/httemplate/docs/install.html @@ -3,58 +3,70 @@

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, minimum version 5.005_03. (5.8.3 for the integrated RT ticketing)
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 +
Optional, enables typeset invoices: teTeX and Ghostscript (included with most distributions).
A transactional database engine supported by Perl's DBI.
- PostgreSQL is recommended (v7.1.x or later, not 7.0.x). -
- MySQL 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. +
- PostgreSQL is recommended (v7.2 or later). +
- MySQL is not currently supported. Developers intersted in maintaining MySQL support are welcome to ask on the -devel mailing list; many things work, but MySQL support needs a maintainer to update it for recent (and future) changes. + + MySQL's default MyISAM and ISAM table types are not supported. You must use one of the new transaction-safe table types such as InnoDB. Set it as the default table type using the --default-table-type=InnoDB mysqld command-line option or by setting 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)
- MIME-Base64 -
- Digest-MD5 - -
- URI -
- HTML-Tagset -
- HTML-Parser -
- libnet -
- Locale-Codes -
- Net-Whois -
- libwww-perl -
- Business-CreditCard - -
- MailTools -
- TimeDate -
- DateManip -
- File-CounterFile -
- FreezeThaw -
- String-Approx -
- Text-Template -
- DBI -
- DBD for your database engine (DBD::Pg for PostgreSQL) -
- DBIx-DataSource -
- DBIx-DBSchema -
- Net-SSH -
- String-ShellQuote -
- Net-SCP -
- Apache::ASP or HTML::Mason (use version 1.0x - Freeside is not yet compatible with version 1.1x) -
- Tie-IxHash -
- Time-Duration -
- HTML-Widgets-SelectLayers -
- Storable - -
- NetAddr-IP -
- Apache::DBI (optional but recommended for better webinterface performance) + +
- MIME-Base64 +
- Digest-MD5 + +
- URI +
- HTML-Tagset +
- HTML-Parser +
- libnet +
- Locale-Codes +
- Net-Whois-Raw +
- libwww-perl +
- Business-CreditCard + +
- MailTools +
- TimeDate +
- DateManip +
- File-CounterFile +
- FreezeThaw +
- String-Approx +
- Text-Template +
- DBI +
- DBD for your database engine (DBD::Pg for PostgreSQL) + +
- DBIx-DBSchema +
- Net-SSH +
- String-ShellQuote +
- Net-SCP +
- 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 +
- Cache::Cache +
- NetAddr-IP +
- Chart +
- Crypt::PasswdMD5 +
- JavaScript::RPC (JavaScript::RPC::Server::CGI) +
- Frontier::RPC +
- Text::CSV_XS +
- Spreadsheet::WriteExcel +
- IO-stringy (IO::Scalar) + +
- Apache::DBI (optional but recommended for better webinterface performance)

Install the Freeside distribution: @@ -71,31 +83,28 @@ Enter it again: Shall the new user be allowed to create databases? (y/n) y Shall the new user be allowed to create more new users? (y/n) n CREATE USER -

Edit the top-level Makefile:

Set DATASOURCE to your DBI data source, for example, DBI:Pg:dbname=freeside for PostgresSQL. 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: -

-$ su
-# make create-database

- (or manually, with Postgres:) -

+    
+      with Postgres:
+         $ su freeside
-$ createdb freeside
-
+    
   Build and install the Perl modules:
      $ make perl-modules
@@ -106,64 +115,61 @@ $ su
 # make create-config
 
     
Run a separate iteration of Apache[-SSL] with mod_perl enabled as the freeside user.
+    
Edit the Makefile and set TEMPLATE to asp or mason.  Also set FREESIDE_DOCUMENT_ROOT.
+    
Run  make install-docs.
 
 
-    
+    
-    
-    
+
   
   Apache::ASP Mason Mason (recommended) Apache::ASP (deprecated)
   
   
-      Run make aspdocs
-      
Copy aspdocs/ to your web server's document space.
-      
Create a Global directory, such as /usr/local/etc/freeside/asp-global/:
+
+    
+      Configure Apache:
 -mkdir /usr/local/etc/freeside/asp-global/
-chown freeside /usr/local/etc/freeside/asp-global/
-
-      
Copy htetc/global.asa to the Global directory:
--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:
--<Directory /usr/local/apache/htdocs/freeside-asp>
-<Files ~ (\.cgi)>
-AddHandler perl-script .cgi
-PerlHandler Apache::ASP
+PerlModule HTML::Mason
+# your freeside docuemnt root
+<Directory /var/www/freeside>
+<Files ~ (\.cgi|\.html)>
+AddHandler perl-script .cgi .html
+PerlHandler HTML::Mason
 </Files>
 <Perl>
-$MLDBM::RemoveTaint = 1;
+require "/usr/local/etc/freeside/handler.pl";
 </Perl>
-PerlSetVar Global /usr/local/etc/freeside/asp-global/
-PerlSetVar Debug 2
 </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:
+
+    
+      Configure Apache:
 -<Directory /usr/local/apache/htdocs/freeside-mason>
-<Files ~ (\.cgi)>
-AddHandler perl-script .cgi
-PerlHandler HTML::Mason
+PerlModule Apache::ASP
+# your freeside document root
+<Directory /var/www/freeside>
+<Files ~ (\.cgi|\.html)>
+AddHandler perl-script .cgi .html
+PerlHandler Apache::ASP
 </Files>
 <Perl>
-require "/usr/local/apache/conf/handler.pl";
+$MLDBM::RemoveTaint = 1;
 </Perl>
+PerlSetVar Global /usr/local/etc/freeside/asp-global/
+PerlSetVar Debug 2
+PerlSetVar RequestBinaryRead Off
+# your freeside document root
+PerlSetVar IncludesDir /var/www/freeside
 </Directory>
 
     
 
 
-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>
+#your freeside document root
+<Directory /var/www/freeside>
 AuthName Freeside
 AuthType Basic
 AuthUserFile /usr/local/etc/freeside/htpasswd
@@ -179,7 +185,7 @@ $ freeside-adduser -c -h /usr/local/
 $ su
 $ 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
+  (using other auth types, add each user to your Apache authentication and then run: freeside-adduser username)
   
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