X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Finstall.html;h=f2db59f88668f06f6a8dd10c74c60d3ab2ff6363;hb=edda09a317f5dfef05fb8906f28531ec6f4b0927;hp=63c39d682e13414487ff63ebc4be8624e90e5056;hpb=68d4bb2e760eb96a05753ad0abac78921edb47e1;p=freeside.git
diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html
index 63c39d682..f2db59f88 100644
--- a/httemplate/docs/install.html
+++ b/httemplate/docs/install.html
@@ -38,6 +38,7 @@ Before installing, you need:
Text-Template
DBI
DBD for your database engine
+ DBIx-DataSource
DBIx-DBSchema
Net-SSH
String-ShellQuote
@@ -50,20 +51,35 @@ 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 freeside
+$ createuser -P freeside
+ - 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 -
+ 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_ADMIN_PASSWORD to the freeside database user's password.
+
+ Add the freeside database to your database engine:
+
+$ su
+# make create-database
Build and install the Perl libraries:
-$ cd FS/
-$ perl Makefile.PL
-$ make
+$ make perl-modules
+$ su
+# make install-perl-modules
+ Create the necessary configuration files:
$ su
-# make install UNINST=1
+# make create-config
+
You should run a separate iteration of Apache[-SSL] with mod_perl enabled as the freeside user.
@@ -112,13 +128,32 @@ 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; they're not UNIX user accounts. For example, using mod_auth (flat files):
+
+ - First user:
+
$ su
+$ freeside-adduser -h /usr/local/etc/freeside/htpasswd -c /usr/local/etc/freeside/secrets username
+ - Additional users:
+
$ su
+$ freeside-adduser -h /usr/local/etc/freeside/htpasswd /usr/local/etc/freeside/secrets username
+
+ (using other auth types, add each user to your Apache authentication yand then run: freeside-adduser /usr/local/etc/freeside/secrets 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:
+
+$ su freeside
+$ bin/fs-setup username
+
+ - freeside-queued was installed with the Perl modules. Start it now and ensure that is run upon system startup.
- Now proceed to the initial administration of your installation.