X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=httemplate%2Fdocs%2Finstall.html;h=c95b41f5d6323af3c06c2e5009e9a4ec1193e734;hb=a496b337f8a6946cd100e4daea9f2692536ea9ce;hp=35caa0023ef8fc8f9bbc2505b6c70242906e0869;hpb=30f31aae2dee3bdbec04f107e9d8cbb96442852e;p=freeside.git
diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html
index 35caa0023..c95b41f5d 100644
--- a/httemplate/docs/install.html
+++ b/httemplate/docs/install.html
@@ -3,32 +3,37 @@
Installation
+Note: Install Freeside on a firewalled, private server, not a public (web, RADIUS, etc.) server.
Before installing, you need:
- - A web server, such as Apache-SSL or Apache
-
- mod_perl
-
- SSH (OpenSSH is recommended. SSH Communications Security commercial SSH version 3 has been reported incompatible with Freeside.)
-
- Perl Don't enable experimental features like threads or the PerlIO abstraction layer.
-
- A transactional database engine supported by Perl's DBI.
+
- 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 really want to use MySQL, you need to use one of the new transaction-safe table types such as BDB, and set it as the default table type using the
--default-table-type=BDB
mysqld command-line option or by setting default-table-type=BDB
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)
Install the Freeside distribution:
Apache::ASP | Mason |
-
- - Run make aspdocs
-
- Copy aspdocs/ to your web server's document space.
-
- Create a Global directory, such as /usr/local/etc/freeside/asp-global/
-
- Copy htetc/global.asa to the Global directory:
+
+ - Configure Apache:
-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
+PerlModule Apache::ASP
+# 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.
-
- 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
+PerlModule HTML::Mason
+# your freeside docuemnt root
+<Directory /var/www/freeside>
+<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>
@@ -141,10 +155,10 @@ 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/
+#your freeside document root
+<Directory /var/www/freeside>
AuthName Freeside
AuthType Basic
AuthUserFile /usr/local/etc/freeside/htpasswd
@@ -160,13 +174,20 @@ $ 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
- As the freeside UNIX user, run bin/fs-setup username to create the database tables, passing the username of a Freeside user you created above:
+ (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
+$ 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
-$ bin/fs-setup username
+$ 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.
+ 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.