X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Finstall.html;h=c95b41f5d6323af3c06c2e5009e9a4ec1193e734;hb=a496b337f8a6946cd100e4daea9f2692536ea9ce;hp=54614ccb322e54eceb8262895bb1021b5e83584b;hpb=0ebeec96313dd7edfca340f01f8fbbbac1f4aa1d;p=freeside.git diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html index 54614ccb3..c95b41f5d 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,7 +48,7 @@ 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 @@ -55,6 +56,7 @@ Before installing, you need:
NetAddr-IP
Chart +
Crypt::PasswdMD5
Apache::DBI (optional but recommended for better webinterface performance)

@@ -105,59 +107,43 @@ $ 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

Apache::ASP	Mason
- Run `make aspdocs` - 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/ -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: +	+ Configure Apache: PerlModule Apache::ASP -<Directory /usr/local/apache/htdocs/freeside-asp> -<Files ~ (\.cgi)> -AddHandler perl-script .cgi +# your freeside document root +<Directory /var/www/freeside> +<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 /var/www/freeside </Directory>	- Run `make masondocs` - 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: +	+ Configure Apache: PerlModule HTML::Mason -<Directory /usr/local/apache/htdocs/freeside-mason> -<Files ~ (\.cgi)> -AddHandler perl-script .cgi +# your freeside docuemnt root +<Directory /var/www/freeside> +<Files ~ (\.cgi\|\.html)> +AddHandler perl-script .cgi .html PerlHandler HTML::Mason </Files> <Perl> @@ -169,9 +155,10 @@ require "/usr/local/etc/freeside/handler.pl";

Run make aspdocs -

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/
-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: +

Configure Apache:

 PerlModule Apache::ASP
-<Directory /usr/local/apache/htdocs/freeside-asp>
-<Files ~ (\.cgi)>
-AddHandler perl-script .cgi
+# your freeside document root
+<Directory /var/www/freeside>
+<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 /var/www/freeside
 </Directory>

Run make masondocs -
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: +

Configure Apache:

 PerlModule HTML::Mason
-<Directory /usr/local/apache/htdocs/freeside-mason>
-<Files ~ (\.cgi)>
-AddHandler perl-script .cgi
+# your freeside docuemnt root
+<Directory /var/www/freeside>
+<Files ~ (\.cgi|\.html)>
+AddHandler perl-script .cgi .html
 PerlHandler HTML::Mason
 </Files>
 <Perl>
@@ -169,9 +155,10 @@ require "/usr/local/etc/freeside/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>
+#your freeside document root
+<Directory /var/www/freeside>
 AuthName Freeside
 AuthType Basic
 AuthUserFile /usr/local/etc/freeside/htpasswd
@@ -187,7 +174,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