From 022491d9d2723ca4d7d0718cdb1fd67e7652428e Mon Sep 17 00:00:00 2001 From: cvs2git Date: Wed, 7 Apr 2004 09:08:35 +0000 Subject: This commit was manufactured by cvs2svn to create tag 'NET_WHOIS_RAW_0_31'. --- httemplate/docs/install.html | 212 ------------------------------------------- 1 file changed, 212 deletions(-) delete mode 100644 httemplate/docs/install.html (limited to 'httemplate/docs/install.html') diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html deleted file mode 100644 index 41aacc51b..000000000 --- a/httemplate/docs/install.html +++ /dev/null @@ -1,212 +0,0 @@ - - Installation - - -

Installation

-Note: Install Freeside on a firewalled, private server, not a public (web, RADIUS, etc.) server.

-Before installing, you need: -

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 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) -
- MIME-Base64 -
- Digest-MD5 - -
- URI -
- HTML-Tagset -
- HTML-Parser -
- libnet -
- Locale-Codes -
- Net-Whois-Raw -
- libwww-perl -
- Business-CreditCard - -
- MailTools -
- TimeDate -
- DateManip -
- File-CounterFile -
- FreezeThaw -
- String-Approx -
- 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 -
- Tie-IxHash -
- Time-Duration -
- HTML-Widgets-SelectLayers -
- Storable - -
- NetAddr-IP -
- Chart -
- Crypt::PasswdMD5 -
- Apache::DBI (optional but recommended for better webinterface performance) -
-

-Install the Freeside distribution: -

Add the user and group `freeside' to your system. -

Allow the freeside user full access to the freeside database. -

with PostgreSQL: -

-$ su postgres (pgsql on some distributions)
-$ 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';

- -

Edit the top-level Makefile: -
- Set DATASOURCE to your DBI data source, for example, DBI:Pg: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 your 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: -

-$ make perl-modules
-$ su
-# 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. -

- - - - - - - - -

Apache::ASP Mason

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 -# your freeside document root -<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 -PerlSetVar RequestBinaryRead Off -# your freeside document root -PerlSetVar IncludesDir /usr/local/apache/htdocs/freeside-asp -</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: - -PerlModule HTML::Mason -<Directory /usr/local/apache/htdocs/freeside-mason> -<Files ~ (\.cgi\|.html)> -SetHandler perl-script -PerlHandler HTML::Mason -</Files> -<Perl> -require "/usr/local/etc/freeside/handler.pl"; -</Perl> -</Directory> - -

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
-# your freeside document root
-<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
-PerlSetVar RequestBinaryRead Off
-# your freeside document root
-PerlSetVar IncludesDir /usr/local/apache/htdocs/freeside-asp
-</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: -

-PerlModule HTML::Mason
-<Directory /usr/local/apache/htdocs/freeside-mason>
-<Files ~ (\.cgi|.html)>
-SetHandler perl-script
-PerlHandler HTML::Mason
-</Files>
-<Perl>
-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): -
```
-<Directory /usr/local/apache/htdocs/freeside-asp>
-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 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
-$ 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 (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. -

- -- cgit v1.2.1