httemplate/docs/upgrade8.html

   1 <head>
   2   <title>Upgrading to 1.4.0</title>
   3 </head>
   4 <body>
   5 <h1>Upgrading to 1.4.0 from 1.3.1</h1>
   6 <ul>
   7   <li>If migrating from less than 1.3.1, see these <a href="upgrade7.html">instructions</a> first.
   8   <li><font size="+2" color="#ff0000">Backup your database and current Freeside installation.</font> (with&nbsp;<a href="http://www.ca.postgresql.org/devel-corner/docs/postgres/backup.html">PostgreSQL</a>) (with&nbsp;<a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Backup">MySQL</a>)
   9   <li>Install <a href="http://www.apache-asp.org/">Apache::ASP</a> or <a href="http://www.masonhq.com/">HTML::Mason</a>.
  10 </ul>
  11 <table>
  12   <tr>
  13     <th>Apache::ASP</th><th>Mason</th>
  14   </tr>
  15   <tr>
  16     <td><ul>
  17       <li>Run <tt>make aspdocs</tt>
  18       <li>Copy <tt>aspdocs/</tt> to your web server's document space.
  19       <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>
  20       <li>Copy <tt>htetc/global.asa</tt> to the Global directory.
  21       <li>Configure Apache for the Global directory and to execute .cgi files using Apache::ASP.  For example:
  22 <font size="-1"><pre>
  23 &lt;Directory /usr/local/apache/htdocs/freeside-asp&gt;
  24 &lt;Files ~ (\.cgi)&gt;
  25 AddHandler perl-script .cgi
  26 PerlHandler Apache::ASP
  27 &lt;/Files&gt;
  28 &lt;Perl&gt;
  29 $MLDBM::RemoveTaint = 1;
  30 &lt;/Perl&gt;
  31 PerlSetVar Global /usr/local/etc/freeside/asp-global/
  32 &lt;/Directory&gt;
  33 </pre></font>
  34     </ul></td>
  35     <td><ul>
  36       <li>Run <tt>make masondocs</tt>
  37       <li>Copy <tt>masondocs/</tt> to your web server's document space.
  38       <li>Copy <tt>htetc/handler.pl</tt> to your web server's configuration directory.
  39       <li>Edit <tt>handler.pl</tt> and set an appropriate <tt>data_dir</tt>, such as <tt>/usr/local/etc/freeside/mason-data</tt>
  40       <li>Configure Apache to use the <tt>handler.pl</tt> file and to execute .cgi files using HTML::Mason.  For example:
  41 <font size="-1"><pre>
  42 &lt;Directory /usr/local/apache/htdocs/freeside-mason&gt;
  43 &lt;Files ~ (\.cgi)&gt;
  44 AddHandler perl-script .cgi
  45 PerlHandler HTML::Mason
  46 &lt;/Files&gt;
  47 &lt;Perl&gt;
  48 require "/usr/local/apache/conf/handler.pl";
  49 &lt;/Perl&gt;
  50 &lt;/Directory&gt;
  51 </pre></font>
  52     </ul></td>
  53   </tr>
  54 </table>
  55 <ul>
  56   <li>Change to the FS directory in the new tarball, and build and install the
  57       Perl modules:
  58     <pre>
  59 $ cd FS/
  60 $ perl Makefile.PL
  61 $ make
  62 $ su
  63 # make install UNINST=1</pre>
  64    <li>Apply the following changes to your database:
  65 <pre>
  66 CREATE TABLE svc_forward (
  67   svcnum int NOT NULL,
  68   srcsvc int NOT NULL,
  69   dstsvc int NOT NULL,
  70   dst varchar(80),
  71   PRIMARY KEY (svcnum)
  72 );
  73
  74 CREATE TABLE cust_credit_bill (
  75   creditbillnum int primary key,
  76   crednum int not null,
  77   invnum int not null,
  78   _date int not null,
  79   amount decimal(10,2) not null
  80 );
  81
  82 CREATE TABLE cust_bill_pay (
  83   billpaynum int primary key,
  84   invnum int not null,
  85   paynum int not null,
  86   _date int not null,
  87   amount decimal(10,2) not null
  88 );
  89
  90 CREATE TABLE cust_credit_refund (
  91   creditrefundnum int primary key,
  92   crednum int not null,
  93   refundnum int not null,
  94   _date int not null,
  95   amount decimal(10,2) not null
  96 );
  97
  98 CREATE TABLE part_svc_column (
  99   columnnum int primary key,
 100   svcpart int not null,
 101   columnname varchar(64) not null,
 102   columnvalue varchar(80) null,
 103   columnflag char(1) null
 104 );
 105
 106 CREATE TABLE queue (
 107   jobnum int primary key,
 108   job varchar not null,
 109   _date int not null,
 110   status varchar(80) not null
 111 );
 112
 113 CREATE TABLE queue_arg (
 114   argnum int primary key,
 115   jobnum int not null,
 116   arg varchar null
 117 );
 118 CREATE INDEX queue_arg1 ON queue_arg ( jobnum );
 119
 120 ALTER TABLE svc_acct ADD domsvc integer NOT NULL;
 121 ALTER TABLE svc_domain ADD catchall integer NULL;
 122 ALTER TABLE cust_main ADD referral_custnum integer NULL;
 123 ALTER TABLE cust_pay ADD custnum integer;
 124 ALTER TABLE cust_refund ADD custnum integer;
 125 CREATE INDEX cust_main3 ON cust_main ( referral_custnum );
 126 CREATE INDEX cust_credit_bill1 ON cust_credit_bill ( crednum );
 127 CREATE INDEX cust_credit_bill2 ON cust_credit_bill ( invnum );
 128 CREATE INDEX cust_bill_pay1 ON cust_bill_pay ( invnum );
 129 CREATE INDEX cust_bill_pay2 ON cust_bill_pay ( paynum );
 130 CREATE INDEX cust_credit_refund1 ON cust_credit_refund ( crednum );
 131 CREATE INDEX cust_credit_refund2 ON cust_credit_refund ( refundnum );
 132 CREATE UNIQUE INDEX part_svc_column1 ON part_svc_column ( svcpart, columnname );
 133 </pre>
 134
 135   <li>If you are using PostgreSQL, apply the following changes to your database:
 136 <pre>
 137 CREATE UNIQUE INDEX agent_pkey ON agent ( agentnum );
 138 CREATE UNIQUE INDEX agent_type_pkey agent_type ( typenum );
 139 CREATE UNIQUE INDEX cust_bill_pkey ON cust_bill ( invnum );
 140 CREATE UNIQUE INDEX cust_credit_pkey ON cust_credit ( crednum );
 141 CREATE UNIQUE INDEX cust_main_pkey ON cust_main ( custnum );
 142 CREATE UNIQUE INDEX cust_main_county_pkey ON cust_main_county ( taxnum );
 143 CREATE UNIQUE INDEX cust_main_invoice_pkey ON cust_main_invoice ( destnum );
 144 CREATE UNIQUE INDEX cust_pay_pkey ON cust_pay ( paynum );
 145 CREATE UNIQUE INDEX cust_pkg_pkey ON cust_pkg ( pkgnum );
 146 CREATE UNIQUE INDEX cust_refund_pkey ON cust_refund ( refundnum );
 147 CREATE UNIQUE INDEX cust_svc_pkey ON cust_svc ( svcnum );
 148 CREATE UNIQUE INDEX domain_record_pkey ON domain_record ( recnum );
 149 CREATE UNIQUE INDEX nas_pkey ON nas ( nasnum );
 150 CREATE UNIQUE INDEX part_pkg_pkey ON part_pkg ( pkgpart );
 151 CREATE UNIQUE INDEX part_referral_pkey ON part_referral ( refnum );
 152 CREATE UNIQUE INDEX part_svc_pkey ON part_svc ( svcpart );
 153 CREATE UNIQUE INDEX port_pkey ON port ( portnum );
 154 CREATE UNIQUE INDEX prepay_credit_pkey ON prepay_credit ( prepaynum );
 155 CREATE UNIQUE INDEX session_pkey ON session ( sessionnum );
 156 CREATE UNIQUE INDEX svc_acct_pkey ON svc_acct ( svcnum );
 157 CREATE UNIQUE INDEX svc_acct_pop_pkey ON svc_acct_pop ( popnum );
 158 CREATE UNIQUE INDEX svc_acct_sm_pkey ON svc_acct_sm ( svcnum );
 159 CREATE UNIQUE INDEX svc_domain_pkey ON svc_domain ( svcnum );
 160 CREATE UNIQUE INDEX svc_www_pkey ON svc_www ( svcnum );
 161 CREATE UNIQUE INDEX type_pkgs_pkey ON type_pkgs ( typenum );
 162 </pre>
 163   <li>If you wish to enable service/shipping addresses, apply the following
 164       changes to your database:
 165 <pre>
 166 ALTER TABLE cust_main ADD COLUMN ship_last varchar(80) NULL;
 167 ALTER TABLE cust_main ADD COLUMN ship_first varchar(80) NULL;
 168 ALTER TABLE cust_main ADD COLUMN ship_company varchar(80) NULL;
 169 ALTER TABLE cust_main ADD COLUMN ship_address1 varchar(80) NULL;
 170 ALTER TABLE cust_main ADD COLUMN ship_address2 varchar(80) NULL;
 171 ALTER TABLE cust_main ADD COLUMN ship_city varchar(80) NULL;
 172 ALTER TABLE cust_main ADD COLUMN ship_county varchar(80) NULL;
 173 ALTER TABLE cust_main ADD COLUMN ship_state varchar(80) NULL;
 174 ALTER TABLE cust_main ADD COLUMN ship_zip varchar(10) NULL;
 175 ALTER TABLE cust_main ADD COLUMN ship_country char(2) NULL;
 176 ALTER TABLE cust_main ADD COLUMN ship_daytime varchar(20) NULL;
 177 ALTER TABLE cust_main ADD COLUMN ship_night varchar(20) NULL;
 178 ALTER TABLE cust_main ADD COLUMN ship_fax varchar(12) NULL;
 179 CREATE INDEX cust_main1 ON cust_main ( ship_last );
 180 CREATE INDEX cust_main2 ON cust_main ( ship_company );
 181 </pre>
 182   <li>If you wish to enable customer comments, apply the following change to
 183       your database:
 184 <pre>
 185 ALTER TABLE cust_main ADD COLUMN comments varchar NULL;
 186 </pre>
 187   <li>If you are using the signup server, reinstall it according to the <a href="signup.html">instructions</a>.  The 1.3.x signup server is not compatible with 1.4.x.
 188   <li>Run bin/dbdef-create.
 189   <li>create a service based on svc_forward
 190   <li>Run bin/fs-migrate-svc_acct_sm
 191   <li>Run bin/fs-migrate-payref
 192   <li>Run bin/fs-migrate-part_svc
 193   <li><b>After running bin/fs-migrate-payref</b>, apply the following changes to your database:
 194   <table border><tr><th>PostgreSQL</th><th>MySQL, others</th></tr>
 195 <tr><td>
 196 <font size=-1><pre>
 197 CREATE TABLE cust_pay_temp (
 198   paynum int primary key,
 199   custnum int not null,
 200   paid decimal(10,2) not null,
 201   _date int null,
 202   payby char(4) not null,
 203   payinfo varchar(16) null,
 204   paybatch varchar(80) null
 205 );
 206 INSERT INTO cust_pay_temp SELECT * from cust_pay;
 207 DROP TABLE cust_pay;
 208 ALTER TABLE cust_pay_temp RENAME TO cust_pay;
 209 CREATE UNIQUE INDEX cust_pay1 ON cust_pay paynum;
 210 CREATE TABLE cust_refund_temp (
 211   refundnum int primary key,
 212   custnum int not null,
 213   _date int null,
 214   refund decimal(10,2) not null,
 215   otaker varchar(8) not null,
 216   reason varchar(80) not null,
 217   payby char(4) not null,
 218   payinfo varchar(16) null,
 219   paybatch varchar(80) null
 220 );
 221 INSERT INTO cust_refund_temp SELECT * from cust_refund;
 222 DROP TABLE cust_refund;
 223 ALTER TABLE cust_refund_temp RENAME TO cust_refund;
 224 CREATE UNIQUE INDEX cust_refund1 ON cust_refund refundnum;
 225 </pre></font>
 226 </td><td>
 227 <font size=-1><pre>
 228 ALTER TABLE cust_pay DROP COLUMN invnum;
 229 ALTER TABLE cust_refund DROP COLUMN crednum;
 230 </pre></font>
 231 </td></tr></table>
 232   <li><b>IMPORTANT: After applying the second set of database changes</b>, run bin/dbdef-create again.
 233   <li>create the <a href="config.html#username_policy">user_policy configuration file</a> as appropriate for your site.
 234   <li>Create the `/usr/local/etc/freeside/cache.<i>datasrc</i>' directory
 235       (ownded by the freeside user).
 236   <li>freeside-queued was installed with the Perl modules.  Start it now and ensure that is run upon system startup.
 237 </ul>
 238 </body>