X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Finstall.html;h=78172e8e47bd52accab486a6a011b89b80c05f24;hb=29644d5921c99520965b884b25800ed084891e94;hp=c223394e9f5f146c4321158c3936e25c12668bd0;hpb=e386fc15be6edadc7068dcb3e48fc81e37b3774b;p=freeside.git
diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html
index c223394e9..78172e8e4 100644
--- a/httemplate/docs/install.html
+++ b/httemplate/docs/install.html
@@ -6,57 +6,74 @@
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'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.
+ - PostgreSQL is recommended (v7.2 or later, 7.4 or later recommended).
+
- 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.
+
+ Note: the above only applies to the database used by the Freeside software itself. Freeside can integrate with RADIUS and other servers running MySQL or any other DBI-supported database.
- Perl modules (CPAN will query, download and build perl modules automatically)
Install the Freeside distribution:
@@ -86,16 +103,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,59 +122,15 @@ $ su
# make create-config
Run a separate iteration of Apache[-SSL] with mod_perl enabled as the freeside user.
-
-
-
- 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:
-
-PerlModule Apache::ASP
-<Directory /usr/local/apache/htdocs/freeside-asp>
-<Files ~ (\.cgi|\.html)>
-SetHandler perl-script
-PerlHandler Apache::ASP
-</Files>
-<Perl>
-$MLDBM::RemoveTaint = 1;
-</Perl>
-PerlSetVar Global /usr/local/etc/freeside/asp-global/
-PerlSetVar Debug 2
-</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:
+
- Edit the Makefile and set TEMPLATE to asp or mason. Also set FREESIDE_DOCUMENT_ROOT.
+
- Run make install-docs.
+
- 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>
@@ -166,13 +138,10 @@ require "/usr/local/etc/freeside/handler.pl";
</Perl>
</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
@@ -183,23 +152,20 @@ require valid-user
- (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:
+ (using other auth types, add each user to your Apache authentication and then run: freeside-adduser username)
+
- Create the Freeside system users:
+
$ su
+# freeside-adduser fs_queue
+# freeside-adduser fs_selfservice
+ - As the freeside UNIX user, run freeside-setup -d domain.name username to create the database tables and initial data, passing the username of a Freeside user you created above:
$ su freeside
-$ cd /path/to/freeside/
-$ bin/populate-msgcat username
+$ freeside-setup -d example.com 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)
- Now proceed to the initial administration of your installation.