New files from unstable branch
[fa-stable.git] / update.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html><head>
3         <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-2">
4         
5         <title>FrontAccounting Update</title><meta name="GENERATOR" content="OpenOffice.org 2.4  (Linux)">
6         <meta name="CREATED" content="0;0">
7         <meta name="CHANGED" content="20100902;19041400"></head>
8 <body dir="ltr" lang="en-US">
9 <p style="margin-bottom: 0cm;"><strong><font color="#cc6600"><font style="font-size: 20pt;" size="5"><i>Front</i></font></font></strong><strong><font style="font-size: 20pt;" size="5">Accounting
10 Update</font></strong></p>
11 <h2>Important Notes</h2>
12 <p>Upgrade process can be done only by administrator of the first
13 company created during FrontAccounting installation. This person is
14 considered as a site admin who have granted access to potentially
15 dangerous setup options, like Setup/Software Upgrade.</p>
16 <p>In the following description sections related to older FA versions are
17 prefixed with <span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[color tags]</span><span style="background: transparent none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">
18 . Y</span>ou can skip tagged fragment safely if currently FA
19 application is newer than the version in tag.</p>
20 <p>Upgrade process consists of up to four stages, some of them are
21 optional:</p>
22 <ol>
23         <li><p>Application source files update 
24         </p>
25         </li><li><p>Database upgrade &#8211; this step is needed only during
26         upgrade which involves change in major application version number
27         (e.g. from 2.2.x to 2.3.x), and sometimes during upgrade from beta
28         release to stable version. Otherwise this step can be skipped.</p>
29         </li><li><p>Final cleanup &#8211; is needed when some old source files,
30         obsoleted by new release should be removed.</p>
31         </li><li><p>New features configuration &#8211; this is optional step
32         needed for most major releases and some minor ones. 
33         </p>
34 </li></ol>
35 <p style="margin-bottom: 0cm;">Before starting upgrade ensure nobody
36 is using the application and make database backup for all companies.
37 To be on safe side backup also old source files, especially those
38 locally customized (if any).</p>
39 <p>Log into admin account of first company.<strong> </strong><strong><span style="">If
40 you use a theme other than the standard 3 (aqua, cool or default),
41 switch to one of these before going further.</span></strong></p>
42 <h2><strong><b>1. Application files update</b></strong></h2>
43 <p style="margin-top: 0.42cm; page-break-after: avoid;"><font face="Liberation Sans, sans-serif"><font size="4"><strong><span style="">a. Source
44 files update</span></strong></font></font></p>
45 <p><strong><span style="">Extract distribution
46 zip/tar.gz file in empty directory, and copy all the files to your
47 FrontAccounting directory overwriting old files. If it is major
48 release upgrade you can skip next step and go directly to cleanup.</span></strong></p>
49 <p style="margin-top: 0.42cm; page-break-after: avoid;"><strong><font face="Liberation Sans, sans-serif"><font size="4"><span style="">b. Configuration
50 files update</span></font></font></strong></p>
51 <p><strong><span style="">Compare new
52 </span></strong><strong><i><b>config.default.php</b></i></strong><strong>
53 </strong><strong><span style="">file with the old
54 </span></strong><strong><i><b>config.php </b></i></strong><strong><span style="font-style: normal;"><span style="">and
55 add all n</span></span></strong><strong><span style="">ew
56 settings (if any). </span></strong>
57 </p>
58 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA
59 2.2beta]</span></span></strong></p>
60 <p><strong> <span style="">$show_users_online = 0;</span></strong></p>
61 <p><strong> <span style="">$def_print_destination
62 = 0;</span></strong></p>
63 <p><strong><span style="">$dflt_date_fmt=0;</span></strong></p>
64 <p><strong><span style="">$dflt_date_sep=0;</span></strong></p>
65 <p><strong><span style="">$table_style,table_style2
66 changed</span></strong></p>
67 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA
68 2.3beta]</span></span></strong></p>
69 <p><strong> <span style="">$alternative_tax_include_on_doc=0;</span></strong></p>
70 <p><strong><span style="">$suppress_tax_rates = 0;</span></strong></p>
71 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA
72 2.3RC1]</span></span></strong><strong> </strong>
73 </p>
74 <p><strong><span style="">Application version
75 information and a couple of other private FA variables are stored in
76 </span></strong><strong><i><b>version.php</b></i></strong><strong>
77 </strong><strong><span style="">file. The
78 application version displayed in footer is defined in $version
79 variable unless this is set in config.php file. If you want current
80 release version to be displayed on every FA update just remove or
81 comment out $version variable in </span></strong><strong><span style="font-style: normal;"><span style="">config.php</span></span></strong><strong><span style="">.</span></strong></p>
82 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA
83 2.3RC2]</span></span></strong></p>
84 <p><strong> <span style="">$save_report_selections &nbsp;= 0; &nbsp;// A value &gt; 0 means days to save the report selections</span></strong></p>
85
86 <strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;"></span></span></strong><h2><strong><b>2. Database upgrade</b></strong></h2>
87 <p><strong><span style="">This step can be skipped
88 for small version updates i.e. when you have already installed
89 FrontAccounting version 2.3.1 or later. Before database upgrade is
90 done on all company databases backup file is created automatically to
91 enable database restore after failure.</span></strong></p>
92 <p><strong><span style="">After major version
93 upgrade overwriting files in first step makes the system unaccessible
94 for all users but site admin, who have to run upgrade procedures to
95 update all company databases to the new version provided with the
96 release. After logging to administrator account of first installed
97 company go directly to Setup/Software Upgrade screen, mark all
98 subsequent 'Install' checkboxes and press 'Upgrade System'.</span></strong></p>
99 <p style="">If something goes wrong during
100 upgrade, you can eventually try forced upgrade option. Forced upgrade
101 ignores some smaller errors which can arise during upgrade due to
102 some exotic database configuration. This is depreciated option, so
103 first read error messages if any, try to fix signalized problems,
104 restore databases from backup and retry normal installation. To run
105 upgrade in forced mode check box 'Force Upgrade', and press 'Upgrade
106 System' again.</p>
107 <h2>3. Final cleanup</h2>
108 <p>Remove or rename install folder in main FrontAccounting directory.
109 </p>
110 <p>After upgrade is installed you can remove files obsoleted by new
111 FrontAccounting version. Also old, unused settings <span style="font-style: normal;"><span style="">can
112 be removed from  </span></span><i><b>config.php</b></i><span style="font-style: normal;"><span style="">
113 file.</span></span></p>
114 <p style="margin-top: 0.42cm; page-break-after: avoid;"><font face="Liberation Sans, sans-serif"><font size="4">a.
115 Source files cleanup</font></font></p>
116 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA
117 2.2beta]</span></span></strong></p>
118 <p><strong><span style=""><span style="background: transparent none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">/includes/reserved.inc
119 &#8211; removed.</span></span></strong></p>
120 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA
121 2.1]</span></span></strong><strong> </strong>
122 </p>
123 <p><strong><span style="">/admin/db/v_banktrans.inc
124 - removed</span></strong></p>
125 <p style="margin-top: 0.42cm; page-break-after: avoid;"><font face="Liberation Sans, sans-serif"><font size="4"><span style="font-style: normal;"><span style="">b.
126 Config.php cleanup </span></span></font></font>
127 </p>
128 <p><strong><span style=""><span style="background: rgb(235, 97, 61) none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">[&lt;FA
129 2.2RC1]</span></span></strong><strong> </strong>
130 </p>
131 <p><strong><span style="">$security_headings,
132 $security_groups arrays &#8211; moved to database (see Access Setup) 
133 </span></strong>
134 </p>
135 <p><strong><span style="">$def_app &#8211; moved
136 to user configuration in database.</span></strong></p>
137 <p><strong><span style="font-style: normal;"><span style="">$version
138 &#8211; moved to </span></span></strong><strong><i><b>version.php</b></i></strong><strong><span style="font-style: normal;"><span style="">
139 file. Remove</span></span></strong></p>
140 <h2>4. New features configuration</h2>
141 <p>During upgrade process new features are initialized to default
142 status, and sometimes old settings are also changed to conform with
143 new security policy. This automatic process is designed to be as
144 neutral for end users as possible, however sometimes site or company
145 admin intervention can be necessary to set thing after changes to
146 their best state. Below you will find description of new settings
147 available after upgrade.</p>
148 <p><br><br>
149 </p>
150 <p>----------------------</p>
151 <ul></ul>
152 </body></html>