diff options
Diffstat (limited to 'httemplate/docs')
| -rw-r--r-- | httemplate/docs/index.html | 1 | ||||
| -rw-r--r-- | httemplate/docs/install.html | 31 | ||||
| -rwxr-xr-x | httemplate/docs/legacy.html | 1 | ||||
| -rw-r--r-- | httemplate/docs/schema.dia | bin | 11452 -> 14414 bytes | |||
| -rw-r--r-- | httemplate/docs/schema.png | bin | 496268 -> 681043 bytes | |||
| -rw-r--r-- | httemplate/docs/upgrade8.html | 3 | ||||
| -rw-r--r-- | httemplate/docs/upgrade9.html | 13 |
7 files changed, 35 insertions, 14 deletions
diff --git a/httemplate/docs/index.html b/httemplate/docs/index.html index 00c863b0c..eaa5b9b92 100644 --- a/httemplate/docs/index.html +++ b/httemplate/docs/index.html @@ -11,6 +11,7 @@ <li><a href="upgrade6.html">Upgrading from 1.2.3 to 1.3.0</a> <li><a href="upgrade7.html">Upgrading from 1.3.0 to 1.3.1</a> <li><a href="upgrade8.html">Upgrading from 1.3.1 to 1.4.0</a> + <li><a href="upgrade9.html">Upgrading from 1.4.0 to 1.4.1</a> <!-- <li><a href="config.html">Configuration files</a> !--> diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html index 1f271e6d2..75f039dd1 100644 --- a/httemplate/docs/install.html +++ b/httemplate/docs/install.html @@ -13,16 +13,17 @@ Before installing, you need: <li>A <b>transactional</b> database engine <a href="http://search.cpan.org/search?mode=module&query=DBD%3A%3A">supported</a> by Perl's <a href="http://dbi.perl.org">DBI</a>. <ul> <li><a href="http://www.postgresql.org/">PostgreSQL</a> (v7 or higher) is recommended. - <li>MySQL has been reported to work. - <b>MySQL's default <a href="http://www.mysql.com/doc/M/y/MyISAM.html">MyISAM</a> and <a href="http://www.mysql.com/doc/I/S/ISAM.html">ISAM</a> table types are not supported</b>. If you want to use MySQL, you <b>must</b> use one of the new <a href="http://www.mysql.com/doc/T/a/Table_types.html">transaction-safe table types</a> such as <a href="http://www.mysql.com/doc/B/D/BDB.html">BDB</a> or <a href="http://www.mysql.com/doc/I/n/InnoDB.html">InnoDB</a>, and set it as the default table type when running fs-setup using the <code>--default-table-type=BDB</code> or <code>--default-table-type=InnoDB</code> <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Command-line_options">mysqld command-line option</a> or by setting <code>default-table-type=BDB</code> or <code>--default-table-type=InnoDB</code> in the <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Option_files">my.cnf option file</a>. + <li>MySQL versions before 4.1 do not support standard SQL subqueries and are <b>NOT SUPPORTED</b>. If you are a developer who wishes to contribute MySQL 3.x/4.0 support, see <a href="http://pouncequick.420.am/rt/Ticket/Display.html?id=438">ticket #438</a> in the bug-tracking system and ask on the -devel mailing list. +<!-- <li>MySQL has been reported to work. + <b>MySQL's default <a href="http://www.mysql.com/doc/M/y/MyISAM.html">MyISAM</a> and <a href="http://www.mysql.com/doc/I/S/ISAM.html">ISAM</a> table types are not supported</b>. If you want to use MySQL, you <b>must</b> use one of the new <a href="http://www.mysql.com/doc/T/a/Table_types.html">transaction-safe table types</a> such as <a href="http://www.mysql.com/doc/B/D/BDB.html">BDB</a> or <a href="http://www.mysql.com/doc/I/n/InnoDB.html">InnoDB</a>, and set it as the default table type using the <code>--default-table-type=BDB</code> or <code>--default-table-type=InnoDB</code> <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Command-line_options">mysqld command-line option</a> or by setting <code>default-table-type=BDB</code> or <code>default-table-type=InnoDB</code> in the <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Option_files">my.cnf option file</a>. --> </ul> <li>Perl modules (<a href="http://theoryx5.uwinnipeg.ca/CPAN/perl/CPAN.html">CPAN</a> will query, download and build perl modules automatically) <ul> - <li><a href="http://search.cpan.org/search?dist=Array-PrintCols">Array-PrintCols</a> - <li><a href="http://search.cpan.org/search?dist=Term-Query">Term-Query</a> (make test broken; install manually) +<!-- <li><a href="http://search.cpan.org/search?dist=Array-PrintCols">Array-PrintCols</a> + <li><a href="http://search.cpan.org/search?dist=Term-Query">Term-Query</a> (make test broken; install manually) --> <li><a href="http://search.cpan.org/search?dist=MIME-Base64">MIME-Base64</a> <li><a href="http://search.cpan.org/search?dist=Digest-MD5">Digest-MD5</a> - <li><a href="http://search.cpan.org/search?dist=MD5">MD5</a> +<!-- <li><a href="http://search.cpan.org/search?dist=MD5">MD5</a> --> <li><a href="http://search.cpan.org/search?dist=URI">URI</a> <li><a href="http://search.cpan.org/search?dist=HTML-Tagset">HTML-Tagset</a> <li><a href="http://search.cpan.org/search?dist=HTML-Parser">HTML-Parser</a> @@ -31,7 +32,7 @@ Before installing, you need: <li><a href="http://search.cpan.org/search?dist=Net-Whois">Net-Whois</a> <li><a href="http://search.cpan.org/search?dist=libwww-perl">libwww-perl</a> <li><a href="http://search.cpan.org/search?dist=Business-CreditCard">Business-CreditCard</a> - <li><a href="http://search.cpan.org/search?dist=Data-ShowTable">Data-ShowTable</a> +<!-- <li><a href="http://search.cpan.org/search?dist=Data-ShowTable">Data-ShowTable</a> --> <li><a href="http://search.cpan.org/search?dist=MailTools">MailTools</a> <li><a href="http://search.cpan.org/search?dist=TimeDate">TimeDate</a> <li><a href="http://search.cpan.org/search?dist=DateManip">DateManip</a> @@ -40,23 +41,24 @@ Before installing, you need: <li><a href="http://search.cpan.org/search?dist=String-Approx">String-Approx</a> <li><a href="http://search.cpan.org/search?dist=Text-Template">Text-Template</a> <li><a href="http://search.cpan.org/search?dist=DBI">DBI</a> - <li><a href="http://search.cpan.org/search?mode=module&query=DBD">DBD for your database engine</a> (<a href="http://search.cpan.org/search?dist=DBD-Pg">DBD::Pg</a> for PostgreSQL, <a href="http://search.cpan.org/search?dist=DBD-mysql">DBD::mysql</a> for MySQL) + <li><a href="http://search.cpan.org/search?mode=module&query=DBD">DBD for your database engine</a> (<a href="http://search.cpan.org/search?dist=DBD-Pg">DBD::Pg</a> for PostgreSQL<!--, <a href="http://search.cpan.org/search?dist=DBD-mysql">DBD::mysql</a> for MySQL-->) <li><a href="http://search.cpan.org/search?dist=DBIx-DataSource">DBIx-DataSource</a> <li><a href="http://search.cpan.org/search?dist=DBIx-DBSchema">DBIx-DBSchema</a> <li><a href="http://search.cpan.org/search?dist=Net-SSH">Net-SSH</a> <li><a href="http://search.cpan.org/search?dist=String-ShellQuote">String-ShellQuote</a> <li><a href="http://search.cpan.org/search?dist=Net-SCP">Net-SCP</a> - <li><a href="http://www.apache-asp.org/">Apache::ASP</a> or <a href="http://www.masonhq.com/">HTML::Mason</a> + <li><a href="http://www.apache-asp.org/">Apache::ASP</a> or <a href="http://www.masonhq.com/">HTML::Mason</a> (use version 1.0x - Freeside is not yet compatible with version 1.1x) <li><a href="http://search.cpan.org/search?dist=Tie-IxHash">Tie-IxHash</a> <li><a href="http://search.cpan.org/search?dist=Time-Duration">Time-Duration</a> <li><a href="http://search.cpan.org/search?dist=HTML-Widgets-SelectLayers">HTML-Widgets-SelectLayers</a> <li><a href="http://search.cpan.org/search?dist=Storable">Storable</a> +<!-- MyAccounts, maybe only for dev <li><a href="http://search.cpan.org/search?dist=Cache-Cache">Cache::Cache</a> --> <li><a href="http://search.cpan.org/search?dist=ApacheDBI">Apache::DBI</a> <i>(optional but recommended for better webinterface performance)</i> </ul> </ul> Install the Freeside distribution: <ul> - <li>Add the user `freeside' to your system. + <li>Add the user and group `freeside' to your system. <li>Allow the freeside user full access to the freeside database. <ul> <li> with <a href="http://www.postgresql.org/users-lounge/docs/7.1/postgres/user-manag.html#DATABASE-USERS">PostgreSQL</a>: @@ -68,16 +70,17 @@ 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</pre> - <li> with <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#User_Account_Management">MySQL</a>: +<!-- <li> with <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#User_Account_Management">MySQL</a>: <pre> $ mysqladmin -u root password '<i>set_a_root_database_password</i>' $ mysql -u root -p mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP on freeside.* TO freeside@localhost IDENTIFIED BY '<i>set_a_freeside_database_password</i>';</pre> +--> </ul> <!-- <li>Unpack the tarball: <pre>gunzip -c fs-x.y.z.tar.gz | tar xvf -</pre>--> <li>Edit the top-level Makefile: <ul> - <li>Set <tt>DATASOURCE</tt> to your <a href="http://search.cpan.org/doc/TIMB/DBI-1.28/DBI.pm">DBI data source</a>, for example, <tt>DBI:Pg:host=localhost;dbname=freeside</tt> for PostgresSQL or <tt>DBI:mysql:freeside</tt> for MySQL. See the <a href="http://search.cpan.org/doc/TIMB/DBI-1.28/DBI.pm">DBI manpage</a> and the <a href="http://search.cpan.org/search?mode=module&query=DBD%3A%3A">manpage for your DBD</a> for the exact syntax of your DBI data source. + <li>Set <tt>DATASOURCE</tt> to your <a href="http://search.cpan.org/doc/TIMB/DBI-1.28/DBI.pm">DBI data source</a>, for example, <tt>DBI:Pg:host=localhost;dbname=freeside</tt> for PostgresSQL<!-- or <tt>DBI:mysql:freeside</tt> for MySQL-->. See the <a href="http://search.cpan.org/doc/TIMB/DBI-1.28/DBI.pm">DBI manpage</a> and the <a href="http://search.cpan.org/search?mode=module&query=DBD%3A%3A">manpage for your DBD</a> for the exact syntax of your DBI data source. <li>Set <tt>DB_PASSWORD</tt> to the freeside database user's password. </ul> <li>Add the freeside database to your database engine: @@ -88,9 +91,10 @@ $ su <pre> $ su freeside $ createdb freeside</pre> - (with MySQL:) +<!-- (with MySQL:) <pre> $ mysqladmin -u freeside -p create freeside </pre> +--> <li>Build and install the Perl modules: <pre> $ make perl-modules @@ -135,6 +139,7 @@ PerlSetVar Debug 2 </pre></font> </ul></td> <td><ul> + <li>(use version 1.0x - Freeside is not yet compatible with version 1.1x) <li>Run <tt>make masondocs</tt> <li>Copy <tt>masondocs/</tt> to your web server's document space. <li>Copy <tt>htetc/handler.pl</tt> to your web server's configuration directory. @@ -187,7 +192,7 @@ $ su freeside $ cd <b>/path/to/freeside-1.4.0/</b> $ bin/populate-msgcat <b>username</b> </pre> - <li><tt>freeside-queued</tt> 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 <tt>make install-init</tt>) + <li><tt>freeside-queued</tt> 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 <tt>make install-init</tt>) <li>Now proceed to the initial <a href="admin.html">administration</a> of your installation. </ul> </body> diff --git a/httemplate/docs/legacy.html b/httemplate/docs/legacy.html index 161690b62..2db9edb0f 100755 --- a/httemplate/docs/legacy.html +++ b/httemplate/docs/legacy.html @@ -4,6 +4,7 @@ <body> <h1>Importing legacy data</h1> <font size="+2">In most cases, legacy data import all cases will require writing custom code to deal with your particular legacy data. The example scripts here will not work "out-of-the-box". Importing your legacy data will most probably involve some hacking on the example scripts noted below. Contributions to the import process are welcome.</font> +<br><br><i>Some import scripts may require installation of the <a href="http://search.cpan.org/search?dist=Array-PrintCols">Array-PrintCols</a> and <a href="http://search.cpan.org/search?dist=Term-Query">Term-Query</a> (make test broken; install manually) modules.</i><br> <ul> <li><a name="bind">bin/bind.import</a> - Import domain information from BIND named <li><a name="passwd">bin/passwd.import</a> - Just import `passwd' and `shadow' or `master.passwd', no RADIUS import. diff --git a/httemplate/docs/schema.dia b/httemplate/docs/schema.dia Binary files differindex c22a470e0..092d2f88b 100644 --- a/httemplate/docs/schema.dia +++ b/httemplate/docs/schema.dia diff --git a/httemplate/docs/schema.png b/httemplate/docs/schema.png Binary files differindex ba22f59c2..d0392e76f 100644 --- a/httemplate/docs/schema.png +++ b/httemplate/docs/schema.png diff --git a/httemplate/docs/upgrade8.html b/httemplate/docs/upgrade8.html index 75155407c..0210430ef 100644 --- a/httemplate/docs/upgrade8.html +++ b/httemplate/docs/upgrade8.html @@ -8,7 +8,7 @@ <li><font size="+2" color="#ff0000">Backup your database and current Freeside installation.</font> (with <a href="http://www.ca.postgresql.org/devel-corner/docs/postgres/backup.html">PostgreSQL</a>) (with <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Backup">MySQL</a>) <li><a href="http://perl.apache.org/">mod_perl</a> is now required. <li>Install <a href="http://search.cpan.org/search?dist=Time-Duration">Time-Duration</a>, <a href="http://search.cpan.org/search?dist=Tie-IxHash">Tie-IxHash</a> and <a href="http://search.cpan.org/search?dist=HTML-Widgets-SelectLayers">HTML-Widgets-SelectLayers</a> (minimum version 0.02). - <li>Install <a href="http://www.apache-asp.org/">Apache::ASP</a> or <a href="http://www.masonhq.com/">HTML::Mason</a>. + <li>Install <a href="http://www.apache-asp.org/">Apache::ASP</a> or <a href="http://www.masonhq.com/">HTML::Mason</a> (use version 1.0x - Freeside is not yet compatible with version 1.1x). <li>Install <a href="http://rsync.samba.org/">rsync</a> </ul> <table> @@ -36,6 +36,7 @@ PerlSetVar Global /usr/local/etc/freeside/asp-global/ </pre></font> </ul></td> <td><ul> + <li>(use version 1.0x - Freeside is not yet compatible with version 1.1x) <li>Run <tt>make masondocs</tt> <li>Copy <tt>masondocs/</tt> to your web server's document space. <li>Copy <tt>htetc/handler.pl</tt> to your web server's configuration directory. diff --git a/httemplate/docs/upgrade9.html b/httemplate/docs/upgrade9.html new file mode 100644 index 000000000..fff1d8690 --- /dev/null +++ b/httemplate/docs/upgrade9.html @@ -0,0 +1,13 @@ +<head> + <title>Upgrading to 1.4.1</title> +</head> +<body> +<h1>Upgrading to 1.4.1 from 1.4.0</h1> +<ul> + <li>If migrating from less than 1.4.0, see these <a href="upgrade8.html">instructions</a> first. + <li>Back up your data and current Freeside installation. + <li>Run <code>make aspdocs</code> or <code>make masondocs</code>. + <li>Copy <code>aspdocs/</code> or <code>masondocs/</code> to your web server's document space. + <li>Run <code>make install-perl-modules</code>. + <li>Restart Apache and freeside-queued. +</body> |
