Merged changes form stable branch up to 2.3.13
[fa-stable.git] / update.html
index 4f7064e39347177dea839515cac042d4defc7a86..5a55293254809cde3a5bac4c7562c7e018112659 100644 (file)
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head>
-  <meta content="text/html; charset=ISO-8859-1" http-equiv="content-type" />
-
-
-  <title>FrontAccounting Update</title></head>
-<body>
-<div><strong><span style="font-size: 20pt;"><span style="color: rgb(204, 102, 0); font-style: italic;">Front</span>Accounting&nbsp;Update</span></strong></div>
-<br />
-<br /><h2>Important Notes</h2>
-
-<ul>
-  <li>You can easily upload all the files to your installation folder on the
-server overwriting the existing files. From 2.2 RC, your existing configuration files, - <span style="font-weight: bold;">config_db.php, config.php, /lang/installed_languages.inc and installed_extensions.php</span> - will nolonger be installed. They are created the first time you install FrontAccounting and don't need further updates.<br /><ol>
-      </ol><ul><li>Backup&nbsp; (download) the following files to another folder:
-        <ul><li>if you have made <em>changes to other files</em>, like themes or so, backup
-these files. </li></ul><ol>
-        </ol>
-
-      </li><li>Upload all the new files.
-      </li><li>Look into the file, <span style="font-weight: bold; font-style: italic;">config.default.php and compare with your own config.php</span> file. You should update the the following in your config.php:<br /><br /></li><ul><li><small>Change the $version in your <span style="font-weight: bold;">config.php</span> file, about line 59, from "2.X.X" to "2.2".</small></li><li><small>Copy these 2 lines from <span style="font-weight: bold;">config.default.php</span> about line 80-82 into <span style="font-weight: bold;">config.php</span> about line 80:<br /><br /><span style="font-family: monospace;">/* Show users online discretetely in the footer */</span><br style="font-family: monospace;" /><span style="font-family: monospace;">$show_users_online = 0;</span><br style="font-family: monospace;" /><span style="font-family: monospace;">Change this to 1 if you want to show users online.</span><br style="font-family: monospace;" /></small></li><li><small>Replace the 2 lines about line 110-111 in <span style="font-weight: bold;">config.php</span>:<br /><br /><span style="font-family: monospace;">$table_style &nbsp;&nbsp;&nbsp; = "cellpadding=3 border=1 bordercolor='#8cacbb' style='border-collapse: collapse'";</span><br style="font-family: monospace;" /><span style="font-family: monospace;">$table_style2 &nbsp;&nbsp; &nbsp;= "cellpadding=3 border=1 bordercolor='#cccccc' style='border-collapse: collapse'";</span><br style="font-family: monospace;" /></small></li><li><small>With these 4 lines from <span style="font-weight: bold;">config.default.php</span>:<br /><br /><span style="font-family: monospace;">if (!isset($_SESSION['bordercolor']))</span><br style="font-family: monospace;" /><span style="font-family: monospace;">&nbsp; &nbsp; $_SESSION['bordercolor'] = "#8cacbb";</span><br style="font-family: monospace;" /><span style="font-family: monospace;">$table_style &nbsp;&nbsp;&nbsp; = "cellpadding=3 border=1 bordercolor='".$_SESSION['bordercolor']."' class='tablestyle'";</span><br style="font-family: monospace;" /><span style="font-family: monospace;">$table_style2 &nbsp;&nbsp;&nbsp; = "cellpadding=3 border=1 bordercolor='#cccccc' class='tablestyle2'";</span><br style="font-family: monospace;" /></small></li><li><small>Remove these 2 lines from <span style="font-weight: bold;">config.php</span> about line 176-177:<br /><br /><span style="font-family: monospace;">/* default start-up tab (orders/AP/stock/manuf/proj/GL/system) */</span><br style="font-family: monospace;" /><span style="font-family: monospace;">$def_app = "orders";</span><br style="font-family: monospace;" /></small></li><li><small>Copy these 3 lines from config.default.php about line 113-115<br /><br /><span style="font-family: monospace;">// defalt dateformats and dateseps indexes used before user login</span></small><br style="font-family: monospace;" /><small style="font-family: monospace;">$dflt_date_fmt = 0;</small><br style="font-family: monospace;" /><small><span style="font-family: monospace;">$dflt_date_sep = 0;</span><br style="font-family: monospace;" /></small></li><li><small>Copy these 2 lines from <span style="font-weight: bold;">config.default.php</span> about line 211-212:<br /><br /><span style="font-family: monospace;">define("ICON_SUBMIT", "ok.gif");&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; // new in 2.2</span><br style="font-family: monospace;" /><span style="font-family: monospace;">define("ICON_ESCAPE", "escape.png");&nbsp;&nbsp;&nbsp; // new in 2.2</span><br style="font-family: monospace;" /></small></li><li><small>And paste them into <span style="font-weight: bold;">config.php</span> about line 209</small></li><li><small>If you use gregorian calendar and have non-workdays on Friday and first day of week = Saturday<br />then you &nbsp;should &nbsp;set this line in <span style="font-weight: bold;">config.php</span> about line&nbsp; 95.<br /></small><pre><small>$date_system = 3;</small></pre></li><li><small>If you want to use FrontAccounting help wiki then set this line in config.php about line 85<br /></small><pre><small>$help_base_url = "http://frontaccounting.net/fawiki?n=Help.";<br /></small></pre></li></ul><li>Rename or remove the /install folder (you have already performed the install
-process earlier).<br /></li></ul><ol>
-      
-      
-      
-    </ol>
-  </li><li><strong>You
-must immediately
-login on company 0, the first company you created, as&nbsp;admin
-(called the superadmin). If you use a theme other than the standard 3,
-aqua, cool or default, switch to one of these before going further. You
-can download a new one of the new themes on the download page
-later.&nbsp; Go
-to the 'Setup' tab and run 'Software
-Upgrade'.
-Mark the checkbox 'Install' and press 'Upgrade System'. &nbsp;You must
-also do this if you upgrade from 2.2 Beta to 2.2 RC. This will
-upgrade ALL your companies.<br /></strong></li><li style="font-weight: bold;">If something goes wrong during upgrade, you can enter here again and try 'Force Upgrade', and press 'Upgrade System' again.<br /></li><li><strong>There are no database changes during a major and minor release. Like from 2.2 to 2.2.1 - 2.2.X .<br /></strong></li><li style="font-weight: bold;">Enter
-'Setup' tab, 'System and Generel GL Setup'. &nbsp;Set the correct
-Accounts for Retained Earnings, Profit/Loss Year and Bank Charge.<br /></li><li style="font-weight: bold;">Enter
-'Setup' tab, 'Access Setup'. Check all the roles and change as you
-please. The roles have been converted from the former Access Roles and
-may need some changes.<br /></li><li style="font-weight: bold;">Enter
-'Setup' tab, 'Company Setup'. If you want Automatic Item Price
-Calculations from Standard&nbsp;Cost, add a percent to add and
-eventually round to the nearest XX Cent. Also check that Base for Auto
-Price calculations is set.<br /> </li></ul></body></html>
\ No newline at end of file
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html><head>\r
+       <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-2">\r
+       \r
+       <title>FrontAccounting Update</title><meta name="GENERATOR" content="OpenOffice.org 2.4  (Linux)">\r
+       <meta name="CREATED" content="0;0">\r
+       <meta name="CHANGED" content="20100902;19041400"></head>\r
+<body dir="ltr" lang="en-US">\r
+<h4><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\r
+Update</font></strong></h4><h2>Important Notes for release 2.3.13.</h2><h4>New global flags in config.php (config-default.php):</h4>/* No check on edit conflicts. Maybe needed to be set to 1 in certains Windows Servers */<br>&nbsp;&nbsp;&nbsp; <span style="font-weight: bold;">$no_check_edit_conflicts = 0;</span><br><h2>Important Notes for release 2.3.12.</h2><h4>New global flags in config.php (config-default.php):</h4>/* <br>&nbsp;&nbsp;&nbsp; Display a dropdown select box for choosing Company to login if false.<br>&nbsp;&nbsp;&nbsp; Show a blank editbox only if true where the Company NickName<br>&nbsp;&nbsp;&nbsp; will have to be manually entered. This is when privacy is needed.<br>*/<br>&nbsp; &nbsp; <span style="font-weight: bold;">$text_company_selection</span>&nbsp; = false;<br><br>/*&nbsp; Should FA hide menu items (Applications, Modules, and Actions) from the user if they don't have access to them? <br>&nbsp;&nbsp;&nbsp; 0 for no&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 1 for yes<br>*/<br><br>&nbsp;&nbsp;&nbsp; <span style="font-weight: bold;">$hide_inaccessible_menu_items</span> = 0;<br><br>/*<br>&nbsp;&nbsp;&nbsp; Brute force prevention.<br>&nbsp;&nbsp;&nbsp; $login_delay seconds delay is required between login attempts after $login_max_attemps failed logins.<br>&nbsp;&nbsp;&nbsp; Set $login_delay to 0 to disable the feature (not recommended)<br>*/<br>&nbsp; &nbsp; <span style="font-weight: bold;">$login_delay</span> = 30;<br>&nbsp; &nbsp; <span style="font-weight: bold;">$login_max_attempts</span> = 10;<h2><strong></strong>Important Notes for release 2.3.5.</h2>\r
+Change in the behaviour of <span style="font-weight: bold; font-style: italic;">Recurrent Invoices</span>.<br><ul><li>Now\r
+the Last Sent day is stamped with the former Last Sent (or Begin date\r
+the first time) + months + days. Before the Last Sent day was stamped\r
+with tthe creation date (today). The Invoice date is still todays date.\r
+</li><li>If you for some reason want to make a pause in the recurrent\r
+invoices, you can now edit the Last Sent day in the Management section\r
+of Sales tab.</li><li>Before the days value, together with a month\r
+value, decided which day in the month the invoice was due.. &nbsp;This\r
+does not&nbsp;work now. You can&nbsp;change the day in the month you\r
+want the recurrency to happen by setting the Last Sent day with the new\r
+day in the Management section.&nbsp;</li><li>If you create a new Recurrent Invoice the Beginning date can be set to the day in the month you want the recurrencies to be due.</li></ul>\r
+<h2>Important Notes</h2>\r
+<p>Upgrade process can be done only by administrator of the first\r
+company created during FrontAccounting installation. This person is\r
+considered as a site admin who have granted access to potentially\r
+dangerous setup options, like Setup/Software Upgrade.</p>\r
+<p>In the following description sections related to older FA versions are\r
+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;">\r
+. Y</span>ou can skip tagged fragment safely if currently FA\r
+application is newer than the version in tag.</p>\r
+<p>Upgrade process consists of up to four stages, some of them are\r
+optional:</p>\r
+<ol>\r
+       <li><p>Application source files update \r
+       </p>\r
+       </li><li><p>Database upgrade &#8211; this step is needed only during\r
+       upgrade which involves change in major application version number\r
+       (e.g. from 2.2.x to 2.3.x), and sometimes during upgrade from beta\r
+       release to stable version. Otherwise this step can be skipped.</p>\r
+       </li><li><p>Final cleanup &#8211; is needed when some old source files,\r
+       obsoleted by new release should be removed.</p>\r
+       </li><li><p>New features configuration &#8211; this is optional step\r
+       needed for most major releases and some minor ones. \r
+       </p>\r
+</li></ol>\r
+<p style="margin-bottom: 0cm;">Before starting upgrade ensure nobody\r
+is using the application and make database backup for all companies.\r
+To be on safe side backup also old source files, especially those\r
+locally customized (if any).</p>\r
+<p>Log into admin account of first company.<strong> </strong><strong><span style="">If\r
+you use a theme other than the standard 3 (aqua, cool or default),\r
+switch to one of these before going further.</span></strong></p>\r
+<h2><strong><b>1. Application files update</b></strong></h2>\r
+<p style="margin-top: 0.42cm; page-break-after: avoid;"><font face="Liberation Sans, sans-serif"><font size="4"><strong><span style="">a. Source\r
+files update</span></strong></font></font></p>\r
+<p><strong><span style="">Extract distribution\r
+zip/tar.gz file in empty directory, and copy all the files to your\r
+FrontAccounting directory overwriting old files. If it is major\r
+release upgrade you can skip next step and go directly to cleanup.</span></strong></p>\r
+<p style="margin-top: 0.42cm; page-break-after: avoid;"><strong><font face="Liberation Sans, sans-serif"><font size="4"><span style="">b. Configuration\r
+files update</span></font></font></strong></p>\r
+<p><strong><span style="">Compare new\r
+</span></strong><strong><i><b>config.default.php</b></i></strong><strong>\r
+</strong><strong><span style="">file with the old\r
+</span></strong><strong><i><b>config.php </b></i></strong><strong><span style="font-style: normal;"><span style="">and\r
+add all n</span></span></strong><strong><span style="">ew\r
+settings (if any). </span></strong>\r
+</p>\r
+<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\r
+2.2beta]</span></span></strong></p>\r
+<p><strong> <span style="">$show_users_online = 0;</span></strong></p>\r
+<p><strong> <span style="">$def_print_destination\r
+= 0;</span></strong></p>\r
+<p><strong><span style="">$dflt_date_fmt=0;</span></strong></p>\r
+<p><strong><span style="">$dflt_date_sep=0;</span></strong></p>\r
+<p><strong><span style="">$table_style,table_style2\r
+changed</span></strong></p>\r
+<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\r
+2.3beta]</span></span></strong></p>\r
+<p><strong> <span style="">$alternative_tax_include_on_doc=0;</span></strong></p>\r
+<p><strong><span style="">$suppress_tax_rates = 0;</span></strong></p>\r
+<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\r
+2.3RC1]</span></span></strong><strong> </strong>\r
+</p>\r
+<p><strong><span style="">Application version\r
+information and a couple of other private FA variables are stored in\r
+</span></strong><strong><i><b>version.php</b></i></strong><strong>\r
+</strong><strong><span style="">file. The\r
+application version displayed in footer is defined in $version\r
+variable unless this is set in config.php file. If you want current\r
+release version to be displayed on every FA update just remove or\r
+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>\r
+<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\r
+2.3RC2]</span></span></strong></p>\r
+<p><strong> <span style="">$save_report_selections &nbsp;= 0; &nbsp;// A value &gt; 0 means days to save the report selections.</span></strong></p><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\r
+2.3]</span></span></strong></p><p><strong> <span style="">$save_po_item_codes &nbsp;= 0; &nbsp;//&nbsp; show item codes on purchase order&nbsp;</span></strong></p><p><strong><span style="">$def_print_destination = 0; // &nbsp;default print destination. 0 = PDF/Printer, 1 = Excel</span></strong></p><p><strong><span style="">$alternative_tax_include_on_docs = 0; // &nbsp;1 = print Subtotal tax excluded, tax and Total tax included</span></strong></p><p><strong><span style="">$suppress_tax_rates = 0; // &nbsp;suppress tax rates on documents. 0 = no, 1 = yes.</span></strong></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;"></span></span></strong>\r
+\r
+<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>\r
+<p><strong><span style="">This step can be skipped\r
+for small version updates i.e. when you have already installed\r
+FrontAccounting version 2.3.1 or later. Before database upgrade is\r
+done on all company databases backup file is created automatically to\r
+enable database restore after failure.</span></strong></p>\r
+<p><strong><span style="">After major version\r
+upgrade overwriting files in first step makes the system unaccessible\r
+for all users but site admin, who have to run upgrade procedures to\r
+update all company databases to the new version provided with the\r
+release. After logging to administrator account of first installed\r
+company go directly to Setup/Software Upgrade screen, mark all\r
+subsequent 'Install' checkboxes and press 'Upgrade System'.</span></strong></p>\r
+<p style="">If something goes wrong during\r
+upgrade, you can eventually try forced upgrade option. Forced upgrade\r
+ignores some smaller errors which can arise during upgrade due to\r
+some exotic database configuration. This is depreciated option, so\r
+first read error messages if any, try to fix signalized problems,\r
+restore databases from backup and retry normal installation. To run\r
+upgrade in forced mode check box 'Force Upgrade', and press 'Upgrade\r
+System' again.</p>\r
+<h2>3. Final cleanup</h2>\r
+<p>Remove or rename install folder in main FrontAccounting directory.\r
+</p>\r
+<p>After upgrade is installed you can remove files obsoleted by new\r
+FrontAccounting version. Also old, unused settings <span style="font-style: normal;"><span style="">can\r
+be removed from  </span></span><i><b>config.php</b></i><span style="font-style: normal;"><span style="">\r
+file.</span></span></p>\r
+<p style="margin-top: 0.42cm; page-break-after: avoid;"><font face="Liberation Sans, sans-serif"><font size="4">a.\r
+Source files cleanup</font></font></p>\r
+<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\r
+2.2beta]</span></span></strong></p>\r
+<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\r
+&#8211; removed.</span></span></strong></p>\r
+<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\r
+2.1]</span></span></strong><strong> </strong>\r
+</p>\r
+<p><strong><span style="">/admin/db/v_banktrans.inc\r
+- removed</span></strong></p>\r
+<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.\r
+Config.php cleanup </span></span></font></font>\r
+</p>\r
+<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\r
+2.2RC1]</span></span></strong><strong> </strong>\r
+</p>\r
+<p><strong><span style="">$security_headings,\r
+$security_groups arrays &#8211; moved to database (see Access Setup) \r
+</span></strong>\r
+</p>\r
+<p><strong><span style="">$def_app &#8211; moved\r
+to user configuration in database.</span></strong></p>\r
+<p><strong><span style="font-style: normal;"><span style="">$version\r
+&#8211; moved to </span></span></strong><strong><i><b>version.php</b></i></strong><strong><span style="font-style: normal;"><span style="">\r
+file. Remove</span></span></strong></p>\r
+<h2>4. New features configuration</h2>\r
+<p>During upgrade process new features are initialized to default\r
+status, and sometimes old settings are also changed to conform with\r
+new security policy. This automatic process is designed to be as\r
+neutral for end users as possible, however sometimes site or company\r
+admin intervention can be necessary to set thing after changes to\r
+their best state. Below you will find description of new settings\r
+available after upgrade.</p>\r
+<p><br><br>\r
+</p>\r
+<p>----------------------</p>\r
+<ul></ul>\r
+</body></html>
\ No newline at end of file