diff options
Diffstat (limited to 'httemplate/docs')
| -rw-r--r-- | httemplate/docs/billing.html | 2 | ||||
| -rw-r--r-- | httemplate/docs/cvv2.html | 25 | ||||
| -rw-r--r-- | httemplate/docs/ieak.html | 75 | ||||
| -rw-r--r-- | httemplate/docs/index.html | 6 | ||||
| -rw-r--r-- | httemplate/docs/install.html | 70 | ||||
| -rwxr-xr-x | httemplate/docs/legacy.html | 5 | ||||
| -rw-r--r-- | httemplate/docs/man/FS/part_export/.cvs_is_on_crack | 0 | ||||
| -rw-r--r-- | httemplate/docs/schema.dia | bin | 14414 -> 14438 bytes | |||
| -rw-r--r-- | httemplate/docs/schema.html | 37 | ||||
| -rw-r--r-- | httemplate/docs/session.html | 7 | ||||
| -rw-r--r-- | httemplate/docs/signup.html | 6 | ||||
| -rwxr-xr-x | httemplate/docs/ssh.html | 5 | ||||
| -rw-r--r-- | httemplate/docs/upgrade-1.4.2.html | 20 | ||||
| -rw-r--r-- | httemplate/docs/upgrade10.html | 204 | ||||
| -rw-r--r-- | httemplate/docs/upgrade4.html | 27 | ||||
| -rw-r--r-- | httemplate/docs/upgrade5.html | 34 | ||||
| -rw-r--r-- | httemplate/docs/upgrade6.html | 66 | ||||
| -rw-r--r-- | httemplate/docs/upgrade8.html | 2 | ||||
| -rw-r--r-- | httemplate/docs/upgrade9.html | 28 |
19 files changed, 435 insertions, 184 deletions
diff --git a/httemplate/docs/billing.html b/httemplate/docs/billing.html index c78a87f04..1d6f8c4fc 100644 --- a/httemplate/docs/billing.html +++ b/httemplate/docs/billing.html @@ -11,7 +11,7 @@ <li>Credit card decline alerts: Customize the <a href="../config/config.cgi#declinetemplate">declinetemplate</a> configuration option and set the <a href="../config/config.cgi#emaildecline">emaildecline</a> configuration option. <li>Optional: Invoice template customization <ul> - <li>See the <a href="http://search.cpan.org/doc/MJD/Text-Template-1.42/Template.pm">Text::Template</a> documentation for details on the substitution language. + <li>See the <a href="http://search.cpan.org/~mjd/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the substitution language. <li>You <b>must</b> call the invoice_lines() function at least once - pass it a number of lines, and it returns a list of array references, each of two elements: a service description column, and a price column. Alternatively, call invoice_lines() with no arguments, and pagination will be disabled - all invoice line items will print on one page, with no padding (recommended for email invoices). <li>In addition, the following variables are available: <ul> diff --git a/httemplate/docs/cvv2.html b/httemplate/docs/cvv2.html new file mode 100644 index 000000000..fe8a17f6f --- /dev/null +++ b/httemplate/docs/cvv2.html @@ -0,0 +1,25 @@ +<HTML> + <HEAD> + <TITLE> + CVV2 information + </TITLE> + </HEAD> + <BODY BGCOLOR="#e8e8e8"> + The CVV2 number (also called CVC2 or CID) is a three- or four-digit + security code used to reduce credit card fraud.<BR><BR> + <TABLE BORDER=0 CELLSPACING=4> + <TR> + <TH>Visa / MasterCard / Discover</TH> + <TH>American Express</TH> + </TR> + <TR> + <TD> + <IMG BORDER=0 ALT="Visa/MasterCard/Discover" SRC="../images/cvv2.png"> + </TD> + <TD> + <IMG BORDER=0 ALT="American Express" SRC="../images/cvv2_amex.png"> + </TD> + </TABLE> + <CENTER><A HREF="javascript:close()">(close window)</A></CENTER> + </BODY> +</HTML> diff --git a/httemplate/docs/ieak.html b/httemplate/docs/ieak.html new file mode 100644 index 000000000..00c53423c --- /dev/null +++ b/httemplate/docs/ieak.html @@ -0,0 +1,75 @@ +<pre> +this is incomplete +mostly it should be merged into signup.html and fs_signup/ieak.template + +- download and install the IEAK from + http://www.microsoft.com/windows/ieak/default.asp + +- Good examples may be found in + C:\Program Files\IEAK\toolkit\isp\server\ICW\signup\perl\signup08.pl + C:\Program Files\IEAK\toolkit\isp\server\ICW\reconfig\perl\reconfig04.pl + C:\Program Files\IEAK6\toolkit\isp\servless\basic\sample.ins + C:\Program Files\IEAK6\toolkit\isp\servless\advanced\4567.ins + C:\Program Files\IEAK6\toolkit\isp\servless\advanced\4568.ins + C:\Program Files\IEAK6\toolkit\isp\servless\advanced\7890.ins + C:\Program Files\IEAK6\toolkit\isp\servless\advanced\7891.ins + +- Full documentation on all the settings available in .INS files is + avaialble under Program Files | Microsoft IEAK 6 | IEAK Help + | Reference | Internet Settings (.ins) Files + +- Freeside will make the following substitutions before sending the file + to the user: + + { $ac } - area code of selected POP + { $exch } - exchange of selected POP + { $loc } - local part of selected POP + { $username } + { $password } + { $email_name } - first and last name + { $pkg } - package name + +- Simple example follows: + +[Entry] +Entry Name = IEAK Sample +[Phone] +Dial_As_Is = No +Phone_Number = { $exch }{ $loc } +Area_Code = { $ac } +Country_Code = 1 +Country_Id = 1 +[Server] +Type = PPP +SW_Compress = Yes +PW_Encrypt = Yes +Negotiate_TCP/IP = Yes +Disable_LCP = No +[TCP/IP] +Specity_IP_Address = No +Specity_Server_Address = No +IP_Header_Compress = Yes +Gateway_On_Remote = Yes +[User] +Name = { $username } +Passowrd = { $password } +Display_Password = Yes +[Internet_Mail] +Email_Name = { $email_name } +Email_Address = { $username }@example.com +POP_Server = mail.example.com +POP_Server_Port_Number = 110 +POP_Logon_Password = { $password } +SMTP_Server = mail.example.com +SMTP_Server_Port_Number = 25 +Install_Mail = 1 +[URL] +Help_Page = http://www.ieaksample.net/helpdesk +Home_Page = http://www.ieaksample.net +Search_Page = http://www.ieaksample,net/search +[Favorites] +IEAK Sample \\ IEAK Sample Home Page.url = http://acme.ieaksample.net/ +[Branding] +Window_Title = Internet Explorer from Acme Internet Services + +</pre> diff --git a/httemplate/docs/index.html b/httemplate/docs/index.html index 00c863b0c..648cb985b 100644 --- a/httemplate/docs/index.html +++ b/httemplate/docs/index.html @@ -6,11 +6,11 @@ <img src="overview.png"> <ul> <li><a href="install.html">New Installation</a> - <li><a href="upgrade4.html">Upgrading from 1.2.x to 1.2.2</a> - <li><a href="upgrade5.html">Upgrading from 1.2.2 to 1.2.3</a> - <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="upgrade-1.4.2.html">Upgrading from 1.4.1 to 1.4.2</a> + <li><a href="upgrade10.html">Upgrading from 1.4.1 (or 1.4.2?) to 1.5.0</a> <!-- <li><a href="config.html">Configuration files</a> !--> diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html index 75f039dd1..ed306f2d3 100644 --- a/httemplate/docs/install.html +++ b/httemplate/docs/install.html @@ -3,21 +3,22 @@ </head> <body> <h1>Installation</h1> +<i>Note: Install Freeside on a firewalled, private server, not a public (web, RADIUS, etc.) server.</i><br><br> Before installing, you need: <ul> - <li><a href="http://www.perl.com/">Perl</a> Don't enable experimental features like threads or the PerlIO abstraction layer. + <li><a href="http://www.perl.com/">Perl</a> <li><a href="http://www.apache.org">Apache</a> (<a href="http://www.modssl.org/">mod_ssl</a> or <a href="http://www.apache-ssl.org">Apache-SSL</a> highly recommended) <li><a href="http://perl.apache.org/">mod_perl</a> (if compiling your own mod_perl, make sure you set the <a href="http://perl.apache.org/guide/install.html#EVERYTHING">EVERYTHING</a>=1 compile-time option) <li><a href="http://www.openssh.com/">SSH</a> (<a href="http://www.openssh.com//">OpenSSH</a> is recommended. SSH Communications Security <a href="http://www.ssh.com/products/ssh/download.cfm">commercial SSH version 3</a> has been reported incompatible with Freeside.) <li><a href="http://rsync.samba.org/">rsync</a> <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 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>. --> + <li><a href="http://www.postgresql.org/">PostgreSQL</a> is recommended (v7or later). + <li><a href="http://www.mysql.com/">MySQL</a> <b>MINIMUM VERSION 4.1</b> is untested but may work. 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) + <li>Perl modules (<a href="http://search.cpan.org/~andk/CPAN/lib/CPAN.pm">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) --> @@ -41,18 +42,20 @@ 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> (use version 1.0x - Freeside is not yet compatible with version 1.1x) + <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://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=NetAddr-IP">NetAddr-IP</a> + <li><a href="http://search.cpan.org/search?dist=Chart">Chart</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> @@ -63,24 +66,23 @@ Install the Freeside distribution: <ul> <li> with <a href="http://www.postgresql.org/users-lounge/docs/7.1/postgres/user-manag.html#DATABASE-USERS">PostgreSQL</a>: <pre> -$ su postgres +$ 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</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: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: @@ -91,10 +93,9 @@ $ 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 @@ -113,7 +114,10 @@ $ su <tr> <td><ul> <li>Run <tt>make aspdocs</tt> - <li>Copy <tt>aspdocs/</tt> to your web server's document space. + <li>Copy <tt>aspdocs/</tt> to your web server's document space: +<font size="-1"><pre> +cp aspdocs /usr/local/apache/htdocs/freeside-asp +</pre></font> <li>Create a <a href="http://www.apache-asp.org/config.html#Global">Global</a> directory, such as <tt>/usr/local/etc/freeside/asp-global/</tt>: <font size="-1"><pre> mkdir /usr/local/etc/freeside/asp-global/ @@ -125,34 +129,41 @@ cp htetc/global.asa /usr/local/etc/freeside/asp-global/global.asa </pre></font> <li>Configure Apache for the Global directory and to execute .cgi files using Apache::ASP. For example: <font size="-1"><pre> +PerlModule Apache::ASP <Directory /usr/local/apache/htdocs/freeside-asp> -<Files ~ (\.cgi)> -AddHandler perl-script .cgi +<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 Debug 2 +PerlSetVar RequestBinaryRead Off </Directory> </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. - <li>Edit <tt>handler.pl</tt> and set an appropriate <tt>data_dir</tt>, such as <tt>/usr/local/etc/freeside/mason-data</tt> + <li>Copy <tt>masondocs/</tt> to your web server's document space. (For example: <tt>/usr/local/apache/htdocs/freeside-mason</tt>) + <li>Copy <tt>htetc/handler.pl</tt> to <tt>/usr/local/etc/freeside</tt> + <li>Edit <tt>handler.pl</tt> and: + <ul> + <li> set an appropriate <tt>comp_root</tt>, such as <tt>/usr/local/apache/htdocs/freeside-mason</tt> + <li> set an appropriate <tt>data_dir</tt>, such as <tt>/usr/local/etc/freeside/masondata</tt> + </ul> + <li>Configure Apache to use the <tt>handler.pl</tt> file and to execute .cgi files using HTML::Mason. For example: <font size="-1"><pre> +PerlModule HTML::Mason <Directory /usr/local/apache/htdocs/freeside-mason> -<Files ~ (\.cgi)> -AddHandler perl-script .cgi +<Files ~ (\.cgi|.html)> +SetHandler perl-script PerlHandler HTML::Mason </Files> <Perl> -require "/usr/local/apache/conf/handler.pl"; +require "/usr/local/etc/freeside/handler.pl"; </Perl> </Directory> </pre></font> @@ -163,7 +174,6 @@ require "/usr/local/apache/conf/handler.pl"; <li>Restrict access to this web interface - see the <a href="http://httpd.apache.org/docs/misc/FAQ.html#user-authentication">Apache documentation on user authentication</a>. For example, to configure user authentication with <a href="http://httpd.apache.org/docs/mod/mod_auth.html">mod_auth</a> (flat files): <pre> <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 @@ -180,16 +190,16 @@ $ <a href="man/bin/freeside-adduser.html">freeside-adduser</a> -c -h /usr/local/ $ <a href="man/bin/freeside-adduser.html">freeside-adduser</a> -h /usr/local/etc/freeside/htpasswd <i>username</i></pre></font> </ul> <i>(using other auth types, add each user to your <a href="http://httpd.apache.org/docs/misc/FAQ.html#user-authentication">Apache authentication</a> and then run: <tt>freeside-adduser <b>username</b></tt></i> - <li>As the freeside UNIX user, run <tt>bin/fs-setup <b>username</b></tt> (in the untar'ed freeside directory) to create the database tables, passing the username of a Freeside user you created above: + <li>As the freeside UNIX user, run <tt>freeside-setup <b>username</b></tt> to create the database tables, passing the username of a Freeside user you created above: <pre> $ su freeside -$ cd <b>/path/to/freeside-1.4.0/</b> -$ bin/fs-setup <b>username</b> +$ freeside-setup <b>username</b> </pre> + Alternately, use the -s option to enable shipping addresses: <tt>freeside-setup -s <b>username</b></tt> <li>As the freeside UNIX user, run <tt>bin/populate-msgcat <b>username</b></tt> (in the untar'ed freeside directory) to populate the message catalog, passing the username of a Freeside user you created above: <pre> $ su freeside -$ cd <b>/path/to/freeside-1.4.0/</b> +$ cd <b>/path/to/freeside/</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 systemand QUEUED_USER with the username of a Freeside user you created above, and run <tt>make install-init</tt>) diff --git a/httemplate/docs/legacy.html b/httemplate/docs/legacy.html index 2db9edb0f..94efe53af 100755 --- a/httemplate/docs/legacy.html +++ b/httemplate/docs/legacy.html @@ -3,7 +3,7 @@ </head> <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> +<font size="+2">In almost all cases, legacy data import will require writing custom code to deal with your particular legacy data. The example scripts here will probably <b>not</b> work "out-of-the-box", and are provided <b>as a starting point only</b>.</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 @@ -17,11 +17,12 @@ <li>POP mail accounts have entries in passwd only, and have a particular shell. <li>Everything else in passwd is a shell account. </ul> - <li><a name="svc_acct_sm">bin/svc_acct_sm.import</a> - Import qmail ( `virtualdomains' and `rcpthosts' ), or sendmail ( `virtusertable' and `sendmail.cw' ) files. Before running bin/svc_acct_sm.import, you need <a href="../browse/part_svc.cgi">services</a> as follows: +<!-- <li><a name="svc_acct_sm">bin/svc_acct_sm.import</a> - Import qmail ( `virtualdomains' and `rcpthosts' ), or sendmail ( `virtusertable' and `sendmail.cw' ) files. Before running bin/svc_acct_sm.import, you need <a href="../browse/part_svc.cgi">services</a> as follows: <ul> <li>Domain (table svc_acct) <li>Mail alias (table svc_acct_sm) </ul> +--> <li><a name="cust_main">Importing customer data</a> <ul> <li>Manually diff --git a/httemplate/docs/man/FS/part_export/.cvs_is_on_crack b/httemplate/docs/man/FS/part_export/.cvs_is_on_crack new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/httemplate/docs/man/FS/part_export/.cvs_is_on_crack diff --git a/httemplate/docs/schema.dia b/httemplate/docs/schema.dia Binary files differindex 092d2f88b..746561550 100644 --- a/httemplate/docs/schema.dia +++ b/httemplate/docs/schema.dia diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html index 2b8b3a132..b38031777 100644 --- a/httemplate/docs/schema.html +++ b/httemplate/docs/schema.html @@ -12,6 +12,9 @@ <li>typenum - <a href="#agent_type">agent type</a> <li>prog - (unimplemented) <li>freq - (unimplemented) + <li>disabled - Disabled flag, empty or 'Y' + <li>username - Username for the Agent interface + <li>_password - Password for the Agent interface </ul> <li><a name="agent_type" href="man/FS/agent_type.html">agent_type</a> - Agent types define groups of packages that you can then assign to particular agents. <ul> @@ -39,7 +42,7 @@ <li><a name="part_bill_event" href="man/FS/part_bill_event.html">part_bill_event</a> - Invoice event definitions <ul> <li>eventpart - primary key - <li>payby - CARD, BILL, or COMP + <li>payby - CARD, DCRD, CHEK, DCHK, LECB, BILL, or COMP <li>event - event name <li>eventcode - event action <li>seconds - how long after the invoice date (<a href="#cust_bill">cust_bill</a>._date) events of this type are triggered @@ -57,6 +60,14 @@ <li>recur - recurring fee <li>sdate - starting date <li>edate - ending date + <li>itemdesc - Line item description (currently used only when pkgnum is 0) + </ul> + <li><a name="cust_bill_pkg_detail" href="man/FS/cust_bill_pkg_detail.html">cust_bill_pkg_detail</a> - Invoice line items detail + <ul> + <li>detailnum - primary key + <li>pkgnum - + <li>invnum - + <li>detail - Detail description </ul> <li><a name="cust_credit" href="man/FS/cust_credit.html">cust_credit</a> - Credits. The equivalent of a negative <a href="#cust_bill">cust_bill</a> record. <ul> @@ -108,8 +119,9 @@ <li><i>ship_daytime</i> <li><i>ship_night</i> <li><i>ship_fax</i> - <li>payby - CARD, BILL, or COMP + <li>payby - CARD, DCHK, CHEK, DCHK, LECB, BILL, or COMP <li>payinfo - card number, P.O.#, or comp issuer + <li>paycvv - Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card <li>paydate - expiration date <li>payname - billing name (name on card) <li>tax - tax exempt, Y or null @@ -133,6 +145,9 @@ <li>tax - % rate <li>taxclass <li>exempt_amount + <li>taxname - if defined, printed on invoices instead of "Tax" + <li>setuptax - if 'Y', this tax does not apply to setup fees + <li>recurtax - if 'Y', this tax does not apply to recurring fees </ul> <li><a name="cust_tax_exempt" href="man/FS/cust_tax_exempt.html">cust_tax_exempt</a> - Tax exemption record <ul> @@ -148,7 +163,7 @@ <li>custnum - <a href="#cust_main">customer</a> <li>paid - amount <li>_date - <li>payby - CARD, BILL, or COMP + <li>payby - CARD, CHEK, LECB, BILL, or COMP <li>payinfo - card number, P.O.#, or comp issuer <li>paybatch - text field for tracking card processor batches <li>closed - books closed flag, empty or `Y' @@ -186,6 +201,7 @@ <li>pkgpart - <a href="#part_pkg">Package definition</a> <li>setup - date <li>bill - next bill date + <li>last_bill - last bill date <li>susp - (past) suspension date <li>expire - (future) cancellation date <li>cancel - (past) cancellation date @@ -198,7 +214,7 @@ <li>custnum - <a href="#cust_main">customer</a> <li>refund - amount <li>_date - <li>payby - CARD, BILL or COMP + <li>payby - CARD, CHEK, LECB, BILL or COMP <li>payinfo - card number, P.O.#, or comp issuer <li>otaker - order taker <li>closed - books closed flag, empty or `Y' @@ -248,7 +264,7 @@ <ul> <li>svcpart - primary key <li>svc - name of this service - <li>svcdb - table used for this service: svc_acct, svc_acct_sm, svc_forward, svc_domain, svc_charge or svc_wo + <li>svcdb - table used for this service: svc_acct, svc_forward, svc_domain, svc_charge or svc_wo <li>disabled - Disabled flag, empty or `Y' <!-- <li><i>table</i>__<i>field</i> - Default or fixed value for <i>field</i> in <i>table</i> <li><i>table</i>__<i>field</i>_flag - null, D or F @@ -267,6 +283,7 @@ <li>pkgpart - <a href="#part_pkg">Package definition</a> <li>svcpart - <a href="#part_svc">Service definition</a> <li>quantity - quantity of this service that this package includes + <li>primary_svc - blank or Y: primary service </ul> <li><a name="export_svc" href="man/FS/export_svc.html">export_svc</a> <ul> @@ -347,13 +364,6 @@ <li>npa - area code <li>nxx - exchange </ul> - <li><a name="svc_acct_sm" href="man/FS/svc_acct_sm.html">svc_acct_sm</a> - <b>DEPRECIATED</b> Domain mail aliases - <ul> - <li>svcnum - <a href="#cust_svc">primary key</a> - <li>domsvc - <a href="#svc_domain">Domain</a> (by svcnum) - <li>domuid - <a href="#svc_acct">Account</a> (by uid) - <li>domuser - domuser @ <a href="#svc_domain">Domain</a> forwards to <a href="#svc_acct">Account</a> - </ul> <li><a name="svc_domain" href="man/FS/svc_domain.html">svc_domain</a> - Domains <ul> <li>svcnum - <a href="#cust_svc">primary key</a> @@ -363,8 +373,9 @@ <ul> <li>svcnum - <a href="#cust_svc">primary key</a> <li>srcsvc - <a href="#svc_acct">svcnum of the source of this forward</a> + <li>src - literal source (username or full email address) <li>dstsvc - <a href="#svc_acct">svcnum of the destination of this forward</a> - <li>dst - foreign destination (email address) - forward not local to freeside + <li>dst - literal destination (username or full email address) </ul> <li><a name="domain_record" href="man/FS/domain_record.html">domain_record</a> - Domain zone detail <ul> diff --git a/httemplate/docs/session.html b/httemplate/docs/session.html index 7dac5fdf7..72e16424e 100644 --- a/httemplate/docs/session.html +++ b/httemplate/docs/session.html @@ -38,9 +38,14 @@ freeside-logout username ( portnum | ip | nasnum nasport )</pre> <li><i>username</i> is a customer username from the svc_acct table <li><i>portnum</i>, <i>ip</i> or <i>nasport</i> and <i>nasnum</i> uniquely identify a port in the <a href="schema.html#port">port</a> database table. </ul> - <li>RADIUS + <li>RADIUS - One of: <ul> + <li>Run the <b>freeside-sqlradius-radacctd</b> daemon to import radacct + records from all configured sqlradius exports: + <tt>freeside-sqlradius-radacctd username</tt> <li>Configure your RADIUS server's login and logout callbacks to use the command-line <tt>freeside-login</tt> and <tt>freeside-logout</tt> utilites. + <li> <i>(incomplete)</i>Use the <b>fs_radlog/fs_radlogd</b> tool to + import records from a text radacct file. </ul> </ul> <h2>Callbacks</h2> diff --git a/httemplate/docs/signup.html b/httemplate/docs/signup.html index 5168f47d6..97d7aa794 100644 --- a/httemplate/docs/signup.html +++ b/httemplate/docs/signup.html @@ -12,7 +12,7 @@ webserver. On this machine, install: <li><a href="http://search.cpan.org/search?dist=Text-Template">Text::Template</a> <li><a href="http://search.cpan.org/search?dist=Storable">Storable</a> <li><a href="http://search.cpan.org/search?dist=Business-CreditCard">Business-CreditCard</a> - <li><a href="http://www.sisd.com/useragent">HTTP::Headers::UserAgent</a> (version 2.0 or higher; not yet indexed correctly on CPAN) + <li><a href="http://search.cpan.org/search?dist=HTTP-BrowserDetect">HTTP::BrowserDetect</a> <li><a href="man/FS/SignupClient.html">FS::SignupClient</a> (copy the fs_signup/FS-SignupClient directory to the external machine, then: perl Makefile.PL; make; make install) </ul> @@ -36,9 +36,7 @@ Then: Optional: <ul> <li>If you create a <b>/usr/local/freeside/ieak.template</b> file on the external machine, it will be sent to IE users with MIME type <i>application/x-Internet-signup</i>. This file will be processed with <a href="http://search.cpan.org/doc/MJD/Text-Template-1.23/Template.pm">Text::Template</a> with the variables listed below available. - (an example file is included as <b>fs_signup/ieak.template</b>) See the <a href="http://www.microsoft.com/windows/ieak/techinfo/deploy/60/en/toc.asp">IEAK documentation</a> for more information. - <li>If you create a <b>/usr/local/freeside/cck.template</b> file on the external machine, the variables defined will be sent to Netscape users with MIME type <i>application/x-netscape-autoconfigure-dialer-v2</i>. This file will be processed with <a href="http://search.cpan.org/doc/MJD/Text-Template-1.23/Template.pm">Text::Template</a> with the variables listed below available. - (an example file is included as <b>fs_signup/cck.template</b>). See the <a href="http://help.netscape.com/products/client/mc/acctproc4.html">Netscape documentation</a> for more information. + (an example file is included as <b>fs_signup/ieak.template</b>) See the section on <a href="http://www.microsoft.com/windows/ieak/techinfo/deploy/60/en/INS.HTM">internet settings files</a> in the <a href="http://www.microsoft.com/windows/ieak/techinfo/deploy/60/en/toc.asp">IEAK documentation</a> for more information. <li>If you create a <b>/usr/local/freeside/success.html</b> file on the external machine, it will be used as the success HTML page. Although template substiutions are available, a regular HTML file will work fine here, unlike signup.html. An example file is included as <b>fs_signup/FS-SignupClient/cgi/success.html</b> <li>Variable substitutions available in <b>ieak.template</b>, <b>cck.template</b> and <b>success.html</b>: <ul> diff --git a/httemplate/docs/ssh.html b/httemplate/docs/ssh.html index 5503a242e..d2c501e35 100755 --- a/httemplate/docs/ssh.html +++ b/httemplate/docs/ssh.html @@ -6,9 +6,10 @@ <br><a name=ssh>Unattended remote login</a> - Freeside can login to remote machines unattended using SSH. This can pose a security risk if not configured correctly, and will allow an intruder who breaks into your freeside machine full access to your remote machines. <b>Do not use this feature unless you understand what you are doing!</b> <ul> <li>As the freeside user (on your freeside machine), generate an authentication key using <a href="http://www.tac.eu.org/cgi-bin/man-cgi?ssh-keygen+1">ssh-keygen</a>. Since this is for unattended operation, use a blank passphrase. - <li>Append the newly-created <code>identity.pub</code> file to <code>~root/.ssh/authorized_keys</code> on the remote machine(s). - <li>Some new SSH v2 implementation accept v2 style keys only. Use the <code>-t</code> option to <a href="http://www.tac.eu.org/cgi-bin/man-cgi?ssh-keygen+1">ssh-keygen</a>, and append the created <code>id_dsa.pub</code> or <code>id_rsa.pub</code> to <code>~root/.ssh/authorized_keys2</code> on the remote machine(s). + <li>Append the newly-created <code>identity.pub</code> file to <code>~root/.ssh/authorized_keys</code> (or the appopriate <code>~username/.ssh/authorized_keys</code>) on the remote machine(s). + <li>Some new SSH v2 implementation accept v2 style keys only. Use the <code>-t</code> option to <a href="http://www.tac.eu.org/cgi-bin/man-cgi?ssh-keygen+1">ssh-keygen</a>, and append the created <code>id_dsa.pub</code> or <code>id_rsa.pub</code> to <code>~root/.ssh/authorized_keys2</code> (or the appopriate <code>~username/.ssh/authorized_keys</code>) on the remote machine(s). <li>You may need to set <code>PermitRootLogin without-password</code> (meaning with keys only) in your <code>sshd_config</code> file on the remote machine(s). + <li>You may want to set <code>ForwardX11 = no</code> in <code>~root/.ssh/config</code> to prevent spurious errors if your distribution turns on X11 forwarding by default. </ul> </body> diff --git a/httemplate/docs/upgrade-1.4.2.html b/httemplate/docs/upgrade-1.4.2.html new file mode 100644 index 000000000..1feaa803a --- /dev/null +++ b/httemplate/docs/upgrade-1.4.2.html @@ -0,0 +1,20 @@ +<head> + <title>Upgrading to 1.4.2</title> +</head> +<body> +<h1>Upgrading to 1.4.2 from 1.4.1</h1> +<ul> + <li>If migrating from less than 1.4.1, see these <a href="upgrade9.html">instructions</a> first. + <li>Back up your data and current Freeside installation. + <li>Install <a href="http://search.cpan.org/search?dist=Locale-SubCountry">Locale::SubCountry</a> + <li>Install <a href="http://search.cpan.org/search?dist=IPC-ShareLite">IPC::ShareLite</a> + <li>Install <a href="http://search.cpan.org/search?dist=HTML-Widgets-SelectLayers">HTML::Widgets::SelectLayers</a> 0.03. + <li>CGI.pm minimum version 2.47 is required. You will probably need to install a current CGI.pm from CPAN if you are using Perl 5.005 or earlier. + <li>If using Apache::ASP, add <code>PerlSetVar RequestBinaryRead Off</code> to your Apache configuration and make sure you are using Apache::ASP minimum version 2.55. + <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>The signup server and password server are deprecated in 1.4.2. Their functionality has been incorperated into the self-service server. Edit or reinstall your init script, and set the "signup_server-default_agentnum" and "signup_server-default_refnum" configuration options. The FS::SignupClient interface is still available as a compatibility wrapper, so you should be able to continue to use your current signup.cgi. + <li>Optional: To use typeset invoices, install tetex and ghostscript, and copy conf/invoice_latex, conf/invoice_latexnotes, and conf/invoice_latexfooter to /usr/local/etc/freeside/conf.<datasrc>/ + <li>Restart Apache and freeside-queued. +</body> diff --git a/httemplate/docs/upgrade10.html b/httemplate/docs/upgrade10.html new file mode 100644 index 000000000..774babb9e --- /dev/null +++ b/httemplate/docs/upgrade10.html @@ -0,0 +1,204 @@ +<pre> +this is incomplete + +install DBIx::DBSchema 0.22 + +install NetAddr::IP, Chart::Base, IPC::ShareLite and Locale::SubCountry + +CREATE TABLE cust_bill_pkg_detail ( + detailnum serial, + pkgnum int NOT NULL, + invnum int NOT NULL, + detail varchar(80), + PRIMARY KEY (detailnum) +); +CREATE INDEX cust_bill_pkg_detail1 ON cust_bill_pkg_detail ( pkgnum, invnum ); + +CREATE TABLE part_virtual_field ( + vfieldpart int NOT NULL, + dbtable varchar(32) NOT NULL, + name varchar(32) NOT NULL, + check_block text, + list_source text, + length integer, + label varchar(80), + PRIMARY KEY (vfieldpart) +); + +CREATE TABLE virtual_field ( + recnum integer NOT NULL, + vfieldpart integer NOT NULL, + value varchar(128) NOT NULL, + PRIMARY KEY (vfieldpart, recnum) +); + +CREATE TABLE router ( + routernum serial, + routername varchar(80), + svcnum int, + PRIMARY KEY (routernum) +); + +CREATE TABLE part_svc_router ( + svcpart int NOT NULL, + routernum int NOT NULL +); + +CREATE TABLE addr_block ( + blocknum serial, + routernum int NOT NULL, + ip_gateway varchar(15) NOT NULL, + ip_netmask int NOT NULL, + PRIMARY KEY (blocknum) +); +CREATE UNIQUE INDEX addr_block1 ON addr_block ( blocknum, routernum ); + +CREATE TABLE svc_broadband ( + svcnum int NOT NULL, + blocknum int NOT NULL, + speed_up int NOT NULL, + speed_down int NOT NULL, + ip_addr varchar(15), + PRIMARY KEY (svcnum) +); + +CREATE TABLE acct_snarf ( + snarfnum serial, + svcnum int NOT NULL, + machine varchar(255) NULL, + protocol varchar(80) NULL, + username varchar(80) NULL, + _password varchar(80) NULL, + PRIMARY KEY (snarfnum) +); +CREATE INDEX acct_snarf1 ON acct_snarf ( svcnum ); + +CREATE TABLE svc_external ( + svcnum int NOT NULL, + id int NOT NULL, + title varchar(80), + PRIMARY KEY (svcnum) +); + +CREATE TABLE part_pkg_temp ( + pkgpart serial NOT NULL, + pkg varchar(80) NOT NULL, + "comment" varchar(80) NOT NULL, + setup text NULL, + freq varchar(80) NOT NULL, + recur text NULL, + setuptax char(1) NULL, + recurtax char(1) NULL, + plan varchar(80) NULL, + plandata text NULL, + disabled char(1) NULL, + taxclass varchar(80) NULL, + PRIMARY KEY (pkgpart), +); +INSERT INTO part_pkg_temp SELECT * from part_pkg; +DROP TABLE part_pkg; +ALTER TABLE part_pkg_temp RENAME TO part_pkg; +ALTER TABLE part_pkg DROP CONSTRAINT part_pkg_temp_pkey; +ALTER TABLE part_pkg ADD PRIMARY KEY (pkgpart); +CREATE INDEX part_pkg1 ON part_pkg(disabled); +select setval('public.part_pkg_temp_pkgpart_seq', ( select max(pkgpart) from part_pkg) ); #? + +CREATE TABLE h_part_pkg_temp ( + historynum serial NOT NULL, + history_date int, + history_user varchar(80) NOT NULL, + history_action varchar(80) NOT NULL, + pkgpart int NOT NULL, + pkg varchar(80) NOT NULL, + "comment" varchar(80) NOT NULL, + setup text NULL, + freq varchar(80) NOT NULL, + recur text NULL, + setuptax char(1) NULL, + recurtax char(1) NULL, + plan varchar(80) NULL, + plandata text NULL, + disabled char(1) NULL, + taxclass varchar(80) NULL, + PRIMARY KEY (historynum) +); +INSERT INTO h_part_pkg_temp SELECT * from h_part_pkg; +DROP TABLE h_part_pkg; +ALTER TABLE h_part_pkg_temp RENAME TO h_part_pkg; +ALTER TABLE h_part_pkg DROP CONSTRAINT h_part_pkg_temp_pkey; +ALTER TABLE h_part_pkg ADD PRIMARY KEY (historynum); +CREATE INDEX h_part_pkg1 ON h_part_pkg(disabled); +select setval('public.h_part_pkg_temp_historynum_seq', ( select max(historynum) from h_part_pkg) ); + + +DROP INDEX cust_bill_pkg1; + +ALTER TABLE cust_bill_pkg ADD itemdesc varchar(80) NULL; +ALTER TABLE h_cust_bill_pkg ADD itemdesc varchar(80) NULL; +ALTER TABLE cust_main_county ADD taxname varchar(80) NULL; +ALTER TABLE h_cust_main_county ADD taxname varchar(80) NULL; +ALTER TABLE cust_main_county ADD setuptax char(1) NULL; +ALTER TABLE h_cust_main_county ADD setuptax char(1) NULL; +ALTER TABLE cust_main_county ADD recurtax char(1) NULL; +ALTER TABLE h_cust_main_county ADD recurtax char(1) NULL; +ALTER TABLE cust_pkg ADD last_bill int NULL; +ALTER TABLE h_cust_pkg ADD last_bill int NULL; +ALTER TABLE agent ADD disabled char(1) NULL; +ALTER TABLE h_agent ADD disabled char(1) NULL; +ALTER TABLE agent ADD username varchar(80) NULL; +ALTER TABLE h_agent ADD username varchar(80) NULL; +ALTER TABLE agent ADD _password varchar(80) NULL; +ALTER TABLE h_agent ADD _password varchar(80) NULL; +ALTER TABLE cust_main ADD paycvv varchar(4) NULL; +ALTER TABLE h_cust_main ADD paycvv varchar(4) NULL; +ALTER TABLE part_referral ADD disabled char(1) NULL; +ALTER TABLE h_part_referral ADD disabled char(1) NULL; +CREATE INDEX part_referral1 ON part_referral ( disabled ); +ALTER TABLE pkg_svc ADD primary_svc char(1) NULL; +ALTER TABLE h_pkg_svc ADD primary_svc char(1) NULL; +ALTER TABLE svc_forward ADD src varchar(255) NULL; +ALTER TABLE h_svc_forward ADD src varchar(255) NULL; + +On recent Pg versions: + +ALTER TABLE svc_forward ALTER COLUMN srcsvc DROP NOT NULL; +ALTER TABLE h_svc_forward ALTER COLUMN srcsvc DROP NOT NULL; +ALTER TABLE svc_forward ALTER COLUMN dstsvc DROP NOT NULL; +ALTER TABLE h_svc_forward ALTER COLUMN dstsvc DROP NOT NULL; + +Or on Pg versions that don't support DROP NOT NULL (tested only on 7.2 so far): +UPDATE pg_attribute SET attnotnull = FALSE WHERE ( attname = 'srcsvc' OR attname = 'dstsvc' ) AND ( attrelid = ( SELECT oid FROM pg_class WHERE relname = 'svc_forward' ) OR attrelid = ( SELECT oid FROM pg_class WHERE relname = 'h_svc_forward' ) ); + +dump database, edit: +- cust_main: increase otaker from 8 to 32 +- cust_main: change ss from char(11) to varchar(11) +- cust_credit: increase otaker from 8 to 32 +- cust_pkg: increase otaker from 8 to 32 +- cust_refund: increase otaker from 8 to 32 +- domain_record: increase reczone from 80 to 255 +- domain_record: change rectype from char to varchar +- domain_record: increase recdata from 80 to 255 +then reload + +optionally: + + CREATE INDEX cust_main6 ON cust_main ( daytime ); + CREATE INDEX cust_main7 ON cust_main ( night ); + CREATE INDEX cust_main8 ON cust_main ( fax ); + CREATE INDEX cust_main9 ON cust_main ( ship_daytime ); + CREATE INDEX cust_main10 ON cust_main ( ship_night ); + CREATE INDEX cust_main11 ON cust_main ( ship_fax ); + CREATE INDEX agent2 ON agent ( disabled ); + CREATE INDEX part_bill_event2 ON part_bill_event ( disabled ); + + serial columns + +mandatory again: + +dbdef-create username +create-history-tables username cust_bill_pkg_detail router part_svc_router addr_block svc_broadband acct_snarf svc_external +dbdef-create username + +apache - fix <Files> sections to include .html also + +</pre> diff --git a/httemplate/docs/upgrade4.html b/httemplate/docs/upgrade4.html deleted file mode 100644 index 1d70f8b73..000000000 --- a/httemplate/docs/upgrade4.html +++ /dev/null @@ -1,27 +0,0 @@ -<head> - <title>Upgrading to 1.2.2</title> -</head> -<body> -<h1>Upgrading to 1.2.2 from 1.2.x</h1> -<ul> - <li>If migrating from 1.0.0, see these <a href="upgrade.html">instructions</a> first. - <li>If migrating from less than 1.1.4, see these <a href="upgrade2.html">instructions</a> first. - <li>If migrating from less than 1.2.0, see these <a href="upgrade3.html">instructions</a> first. - <li>Back up your data and current Freeside installation. - <li>Install the Perl modules <a href="http://www.perl.com/CPAN/modules/by-module/Locale/">Locale-Codes</a> and <a href="http://www.perl.com/CPAN/modules/by-module/Net/">Net-Whois</a>. - <li>Apply the following changes to your database: -<pre> -ALTER TABLE cust_pay_batch CHANGE exp exp VARCHAR(11); -</pre> - <li>Copy or symlink htdocs to the new copy. - <li>Remove the symlink or directory <i>(your_site_perl_directory)</i>/FS. - <li>Change to the FS directory in the new tarball, and build and install the - Perl modules: - <pre> -$ cd FS/ -$ perl Makefile.PL -$ make -$ su -# make install</pre> - <li>Run bin/dbdef-create. This file uses MySQL-specific syntax. If you are running a different database engine you will need to modify it slightly. -</body> diff --git a/httemplate/docs/upgrade5.html b/httemplate/docs/upgrade5.html deleted file mode 100644 index 3f3431653..000000000 --- a/httemplate/docs/upgrade5.html +++ /dev/null @@ -1,34 +0,0 @@ -<head> - <title>Upgrading to 1.3.0</title> -</head> -<body> -<h1>Upgrading to 1.2.3 from 1.2.2</h1> -<ul> - <li>If migrating from 1.0.0, see these <a href="upgrade.html">instructions</a> first. - <li>If migrating from less than 1.1.4, see these <a href="upgrade2.html">instructions</a> first. - <li>If migrating from less than 1.2.0, see these <a href="upgrade3.html">instructions</a> first. - <li>If migrating from less than 1.2.2, see these <a href="upgrade4.html">instructions</a> first. - <li>Back up your data and current Freeside installation. - <li>Apply the following changes to your database: -<pre> -ALTER TABLE svc_acct_pop ADD loc CHAR(4); -CREATE TABLE prepay_credit ( - prepaynum int NOT NULL, - identifier varchar(80) NOT NULL, - amount decimal(10,2) NOT NULL, - PRIMARY KEY (prepaynum), - INDEX (identifier) -); -</pre> - <li>Copy or symlink htdocs to the new copy. - <li>Remove the symlink or directory <i>(your_site_perl_directory)</i>/FS. - <li>Change to the FS directory in the new tarball, and build and install the - Perl modules: - <pre> -$ cd FS/ -$ perl Makefile.PL -$ make -$ su -# make install</pre> - <li>Run bin/dbdef-create. This file uses MySQL-specific syntax. If you are running a different database engine you will need to modify it slightly. -</body> diff --git a/httemplate/docs/upgrade6.html b/httemplate/docs/upgrade6.html deleted file mode 100644 index dc82975f3..000000000 --- a/httemplate/docs/upgrade6.html +++ /dev/null @@ -1,66 +0,0 @@ -<head> - <title>Upgrading to 1.3.0</title> -</head> -<body> -<h1>Upgrading to 1.3.0 from 1.2.3</h1> -<ul> - <li>If migrating from 1.0.0, see these <a href="upgrade.html">instructions</a> first. - <li>If migrating from less than 1.1.4, see these <a href="upgrade2.html">instructions</a> first. - <li>If migrating from less than 1.2.0, see these <a href="upgrade3.html">instructions</a> first. - <li>If migrating from less than 1.2.2, see these <a href="upgrade4.html">instructions</a> first. - <li>If migrating from less than 1.2.3, see these <a href="upgrade5.html">instructions</a> first. - <li>Back up your data and current Freeside installation. - <li>As 1.3.0 requires transactions, <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 no longer supported</b>. Converting to <a href="http://www.postgresql.org/">PostgreSQL</a> is recommended. If you really want to use MySQL, convert your tables to one of the <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>. - <li>Copy the <i>invoice_template</i> file from the <i>conf/</i> directory in the distribution to your <a href="config.html">configuration directory</a>. - <li>Install the <a href="http://search.cpan.org/search?dist=Text-Template">Text-Template</a>, <a href="http://search.cpan.org/search?dist=DBIx-DBSchema">DBIx-DBSchema</a>, <a href="http://search.cpan.org/search?dist=Net-SSH">Net-SSH</a>, <a href="http://search.cpan.org/search?dist=String-ShellQuote">String-ShellQuote</a> and <a href="http://search.cpan.org/search?dist=Net-SCP">Net-SCP</a> Perl modules. - <li>Apply the following changes to your database: -<pre> -CREATE TABLE domain_record ( - recnum int NOT NULL, - svcnum int NOT NULL, - reczone varchar(80) NOT NULL, - recaf char(2) NOT NULL, - rectype char(5) NOT NULL, - recdata varchar(80) NOT NULL, - PRIMARY KEY (recnum) -); -CREATE TABLE svc_www ( - svcnum int NOT NULL, - recnum int NOT NULL, - usersvc int NOT NULL, - PRIMARY KEY (svcnum) -); -ALTER TABLE part_svc ADD svc_www__recnum varchar(80) NULL; -ALTER TABLE part_svc ADD svc_www__recnum_flag char(1) NULL; -ALTER TABLE part_svc ADD svc_www__usersvc varchar(80) NULL; -ALTER TABLE part_svc ADD svc_www__uesrsvc_flag char(1) NULL; -ALTER TABLE svc_acct CHANGE _password _password varchar(50) NULL; -ALTER TABLE svc_acct ADD seconds integer NULL; -ALTER TABLE part_svc ADD svc_acct__seconds integer NULL; -ALTER TABLE part_svc ADD svc_acct__seconds_flag char(1) NULL; -ALTER TABLE prepay_credit ADD seconds integer NULL; - -</pre> - <li>If your database supports dropping columns: -<pre> -ALTER TABLE cust_bill DROP owed; -ALTER TABLE cust_credit DROP credited; -</pre> - Or, if your database does not support dropping columns, you can do this: -<pre> -ALTER TABLE cust_bill CHANGE owed depriciated decimal(10,2); -ALTER TABLE cust_credit CHANGE credited depriciated2 decimal(10,2); -</pre> - - <li>Copy or symlink htdocs to the new copy. - <li>Remove the symlink or directory <i>(your_site_perl_directory)</i>/FS. - <li>Change to the FS directory in the new tarball, and build and install the - Perl modules: - <pre> -$ cd FS/ -$ perl Makefile.PL -$ make -$ su -# make install</pre> - <li>Run bin/dbdef-create. -</body> diff --git a/httemplate/docs/upgrade8.html b/httemplate/docs/upgrade8.html index 0210430ef..cf60a8582 100644 --- a/httemplate/docs/upgrade8.html +++ b/httemplate/docs/upgrade8.html @@ -369,7 +369,7 @@ ALTER TABLE cust_refund DROP COLUMN crednum; <li><b>IMPORTANT: After running bin/create-history-tables</b>, run <tt>bin/dbdef-create <i>username</i></tt> again. <li>As the freeside UNIX user, run <tt>bin/populate-msgcat <i>username</i></tt > to populate the message catalog - <li>set the <a href="../config/config.cgi#username_policy">user_policy configuration value</a> as appropriate for your site. +<!-- <li>set the <a href="../config/config.cgi#username_policy">user_policy configuration value</a> as appropriate for your site. --> <li>set the <a href="../config/config.cgi#locale">locale configuration value</a> to en_US. <li>the mxmachines, nsmachines, arecords and cnamerecords configuration values have been deprecated. Set the <a href="../config/config.cgi#defaultrecords">defaultrecords configuration value</a> instead. <li>Create the `/usr/local/etc/freeside/cache.<i>datasrc</i>' directory diff --git a/httemplate/docs/upgrade9.html b/httemplate/docs/upgrade9.html new file mode 100644 index 000000000..6a8fd965d --- /dev/null +++ b/httemplate/docs/upgrade9.html @@ -0,0 +1,28 @@ +<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>Install <a href="http://search.cpan.org/search?dist=Net-SSH">Net::SSH</a> minimum version 0.07 + <li>Apply the following changes to your database: +<pre> +INSERT INTO msgcat ( msgnum, msgcode, locale, msg ) VALUES ( 18, 'daytime', 'en_US', 'Day Phone' ); +INSERT INTO msgcat ( msgnum, msgcode, locale, msg ) VALUES ( 19, 'night', 'en_US', 'Night Phone' ); +</pre> + <li>Optionally, apply the following changes to your database (performance improvements): +<pre> +CREATE INDEX part_pkg1 ON part_pkg ( disabled ); +CREATE INDEX part_svc1 ON part_svc ( disabled ); +CREATE INDEX cust_bill2 ON cust_bill ( _date ); +</pre> + <li>If you want to use ACH (electronic checks), you will need to make changes to your database. The easiest way to make these changes is to dump your database (with pg_dump), change the payinfo field in the cust_pay, cust_refund, h_cust_pay and h_cust_refund tables from varchar(16) to varchar(80), reload the database from the dump. + <li>If you will be doing bind exports you should make additional changes to your database. Follow the directions above to dump the database and change the reczone and recdata fields in the domain_record and h_domain_record tables from varchar(80) to varchar(255). + <li>If you made changes to your db schema from a dump as listed above run dbdef-create. + <li>Restart Apache and freeside-queued. +</body> |