X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=httemplate%2Fdocs%2Finstall.html;h=56cee80e5cf5c9109dc5bb940a1b414203bff345;hb=fcc3d1c712ed1f50e9aaa79b764392e31359a825;hp=c99a0f91133450781e0ebf7abf3bcea595a2fc4c;hpb=04ac51dff5dd29a1c674168f5d3396acbb158dbc;p=freeside.git
diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html
index c99a0f911..56cee80e5 100644
--- a/httemplate/docs/install.html
+++ b/httemplate/docs/install.html
@@ -5,17 +5,24 @@
Installation
Before installing, you need:
Install the Freeside distribution:
@@ -46,21 +59,48 @@ Install the Freeside distribution:
Add the user `freeside' to your system.
Allow the freeside user full access to the freeside database.
- - with MySQL:
$ mysqladmin -u root password 'set_a_root_database_password'
+
- with PostgreSQL:
+
+$ su postgres
+$ createuser -P freeside
+Enter password for user "freeside":
+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
+ - with MySQL:
+
+$ mysqladmin -u root password 'set_a_root_database_password'
$ mysql -u root -p
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP on freeside.* TO freeside@localhost IDENTIFIED BY 'set_a_freeside_database_password';
- - with PostgreSQL
- Add the freeside database to your database engine. (with MySQL) (with PostgreSQL)
- Unpack the tarball: gunzip -c fs-x.y.z.tar.gz | tar xvf -
- Build and install the Perl libraries:
+
+ Edit the top-level Makefile:
+
+ - Set DATASOURCE to your DBI data source, for example, DBI:Pg:host=localhost;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 a 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:)
+
+$ su freeside
+$ createdb freeside
+ (with MySQL:)
+
+$ mysqladmin -u freeside -p create freeside
+ Build and install the Perl modules:
-$ cd FS/
-$ perl Makefile.PL
-$ make
+$ make perl-modules
$ su
-# make install UNINST=1
- You should run a separate iteration of Apache[-SSL] with mod_perl enabled as the freeside user.
+# make install-perl-modules
+ Create the necessary configuration files:
+$ su
+# make create-config
+
+ Run a separate iteration of Apache[-SSL] with mod_perl enabled as the freeside user.
@@ -70,11 +110,18 @@ $ su
- 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.
+
- 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:
-<Directory /usr/local/apache/htdocs/freeside-asp>
+<Directory /usr/local/apache/htdocs/freeside-asp>
<Files ~ (\.cgi)>
AddHandler perl-script .cgi
PerlHandler Apache::ASP
@@ -82,25 +129,25 @@ PerlHandler Apache::ASP
<Perl>
$MLDBM::RemoveTaint = 1;
</Perl>
-PerlSetVar Global /usr/local/etc/freeside/asp-global/
+PerlSetVar Global /usr/local/etc/freeside/asp-global/
+PerlSetVar Debug 2
</Directory>
|
- - NOTE: Mason support is still a bit buggy in the 1.4.0 prereleases. This will be fixed before 1.4.0. You have been warned.
- 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:
-<Directory /usr/local/apache/htdocs/freeside-mason>
+<Directory /usr/local/apache/htdocs/freeside-mason>
<Files ~ (\.cgi)>
AddHandler perl-script .cgi
PerlHandler HTML::Mason
</Files>
<Perl>
-require "/usr/local/apache/conf/handler.pl";
+require "/usr/local/apache/conf/handler.pl";
</Perl>
</Directory>
@@ -108,13 +155,39 @@ require "/usr/local/apache/conf/handler.pl";
|
-- Restrict access to this web interface. (with Apache)
-
- Create the necessary configuration files.
-
- Create the `/usr/local/etc/freeside/counters.datasrc',
- `/usr/local/etc/freeside/cache.datasrc', and
- `/usr/local/etc/freeside/export.datasrc' directories for each datasrc (owned by the freeside user).
-
- As the freeside user, run bin/fs-setup to create the database tables.
-
- freeside-queued was installed with the Perl modules. Start it now and ensure that is run upon system startup.
+
- Restrict access to this web interface - see the Apache documentation on user authentication. For example, to configure user authentication with mod_auth (flat files):
+
+<Directory /usr/local/apache/htdocs/freeside-asp>
+PerlSetVar Global /usr/local/etc/freeside/asp-global/
+AuthName Freeside
+AuthType Basic
+AuthUserFile /usr/local/etc/freeside/htpasswd
+require valid-user
+</Directory>
+
+ - Create one or more Freeside users (your internal sales/tech folks, not customer accounts). These users are setup using using Apache authentication, not UNIX user accounts. For example, using mod_auth (flat files):
+
+ - First user:
+
$ su
+$ freeside-adduser -c -h /usr/local/etc/freeside/htpasswd username
+ - Additional users:
+
$ 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 (in the untar'ed freeside directory) to create the database tables, passing the username of a Freeside user you created above:
+
+$ su freeside
+$ cd /path/to/freeside-1.4.0/
+$ bin/fs-setup 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
+$ cd /path/to/freeside-1.4.0/
+$ bin/populate-msgcat 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 system, and run make install-init)
- Now proceed to the initial administration of your installation.