X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=httemplate%2Fdocs%2Finstall.html;h=86e2a6b8c765cd8dfbe9574d247e3d88f23b7c02;hb=3485c34d9374892c3e4d6a56c7dd5f47f480f024;hp=c223394e9f5f146c4321158c3936e25c12668bd0;hpb=e386fc15be6edadc7068dcb3e48fc81e37b3774b;p=freeside.git
diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html
index c223394e9..86e2a6b8c 100644
--- a/httemplate/docs/install.html
+++ b/httemplate/docs/install.html
@@ -6,17 +6,18 @@
Note: Install Freeside on a firewalled, private server, not a public (web, RADIUS, etc.) server.
Before installing, you need:
- - Perl
+
- 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 (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 MINIMUM VERSION 4.1 is untested but may work. Versions before 4.1 do not support standard SQL subqueries and are NOT SUPPORTED.
- 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.
+ 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)
@@ -30,7 +31,7 @@ Before installing, you need:
- HTML-Parser
- libnet
- Locale-Codes
-
- Net-Whois
+
- Net-Whois-Raw
- libwww-perl
- Business-CreditCard
@@ -43,12 +44,12 @@ Before installing, you need:
- Text-Template
- DBI
- DBD for your database engine (DBD::Pg for PostgreSQL, DBD::mysql for MySQL)
-
- DBIx-DataSource
+
- DBIx-DBSchema
- 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
@@ -56,6 +57,7 @@ Before installing, you need:
- NetAddr-IP
- Chart
+
- Crypt::PasswdMD5
- Apache::DBI (optional but recommended for better webinterface performance)
@@ -86,16 +88,15 @@ mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP on freeside.* T
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
- (with MySQL:)
-
+$ createdb -E sql_ascii freeside
+ - with MySQL:
+
$ mysqladmin -u freeside -p create freeside
+
Build and install the Perl modules:
$ make perl-modules
@@ -106,33 +107,22 @@ $ 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 |
-
- - 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>
+# your freeside document root
+<Directory /var/www/freeside>
<Files ~ (\.cgi|\.html)>
-SetHandler perl-script
+AddHandler perl-script .cgi .html
PerlHandler Apache::ASP
</Files>
<Perl>
@@ -140,25 +130,20 @@ $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>
|
-
- - 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
-
- 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|.html)>
-SetHandler perl-script
+# your freeside docuemnt root
+<Directory /var/www/freeside>
+<Files ~ (\.cgi|\.html)>
+AddHandler perl-script .cgi .html
PerlHandler HTML::Mason
</Files>
<Perl>
@@ -170,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
@@ -188,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