install.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><title>FrontAccounting</title></head>
   3 <body>
   4 <div><strong><span style="font-size: 20pt;"><span style="color: rgb(204, 102, 0); font-style: italic;">Front</span>Accounting
   5 Installation</span></strong></div>
   6 <h2>Pre-requisites</h2>
   7 <ul style="margin-top: 0pt;" type="disc">
   8 <li>A working HTTP web server eg. <em><strong>Apache,
   9 IIS</strong></em>. </li>
  10 <li><strong><em>PHP</em></strong>
  11 installed on the web server. </li>
  12 <li>A working <strong><em>MySQL</em></strong>
  13 server - with <strong><em>innodb</em></strong>
  14 tables enabled (see notes below) </li>
  15 <li><strong><em>Adobe Acrobat Reader</em></strong>
  16 - for viewing the PDF reports before printing them out. </li>
  17 </ul>
  18 <h2>Important Notes</h2>
  19 <ul>
  20 <li>One critical aspect of the PHP installation is the setting
  21 of <strong><em>session.auto_start</em></strong>
  22 in the php.ini file. Some rpm distributions of PHP have the default
  23 setting of <strong><em>session.auto_start = 1</em></strong>.
  24 This starts a new session at the beginning of each script. However,
  25 this makes it impossible to instantiate any class objects that the
  26 system relies on. Classes are used extensively by this system. When
  27 sessions are required they are started by the system and this setting
  28 of <strong><em>session.auto_start</em></strong>
  29 can and should be set to 0. </li>
  30 <li><strong><em>Innodb</em></strong>
  31 tables must be enabled in the MySQL server. These tables allow database
  32 transactions which are a critical component of the software. This is
  33 enabled by default in the newer versions of MySQL. If you need to
  34 enable it yourself, consult the MySQL manual. </li>
  35 <li>FrontAccounting is implemented and tested with MySQL.
  36 Generally
  37 it should work with other databases, but this is not supported in any
  38 way at the moment. </li>
  39 </ul>
  40 <h2>Copying all the project files to the correct directory</h2>
  41 <ul>
  42 <li>You must obviously have downloaded the project archive to
  43 be reading this file. </li>
  44 <li>All the files inside this archive should be copied to a
  45 directory under the web server root directory. </li>
  46 <li>For example, create a folder called <strong>/account</strong>,
  47 and extract the archive into this folder. </li>
  48 </ul>
  49 <h2>Installation Steps (automatic, recommended)</h2>
  50 <ol>
  51 <li>If you have the option to create multiple databases on your
  52 host, create one, fi. <strong>frontacc</strong>, otherwise
  53 write down the database name for your account. At the same time look up
  54 the username and password for the database. You will need these
  55 informations during the wizard install. </li>
  56 <li>Enter <strong><em>your_url/account/install</em></strong>
  57 (or whatever directory you entered). This will run the install wizard,
  58 setup a drill company and populating with initial data. You can later
  59 on create your own real company. It is a good idea to get familiar with
  60 the system before starting your own company.&nbsp; </li>
  61 <li>After successfully install, remove or rename your install
  62 directory for safety reasons. You don't need it any more.</li>
  63 </ol>
  64 <h2>Installation Steps (manuel, for advanced users, not
  65 recommended)</h2>
  66 <p><br />
  67 </p>
  68 <ol>
  69 <li>
  70 <h3>Creating the Database</h3>
  71 <ol>
  72 <li>NOTE : As FrontAccounting is still heavily under
  73 development, the database structure will ALWAYS change between
  74 releases, so if you have a database that you created for a previous
  75 release of FrontAccounting, it WILL NOT WORK after installing a new
  76 release.&nbsp;<br />Please look in the file <span style="font-weight: bold; font-style: italic;">Update.html</span> for how to handle this. </li>
  77 <li>We strongly suggest using a GUI to manage your
  78 database(s) and database users. If you don&#8217;t have any, download <a href="http://www.phpmyadmin.net/"><strong>phpMyAdmin</strong></a>.
  79 </li>
  80 <li>Create a database with a name of your choice. The
  81 default in config_db.php is &#8216;<strong><em>frontacc</em></strong>&#8217;,
  82 but of course you can select whatever name you desire. </li>
  83 <li>Populate the database you have created. There are two
  84 scripts
  85 are provided to populate the database (both inside the folder /sql) :
  86 <ol>
  87 <li><strong><em>en_US-demo.sql</em></strong>.
  88 This has a minimal amount of demonstration data set up so that
  89 transactions can be tried to see how the system works. </li>
  90 <li><strong><em>en_US-new.sql</em></strong>.
  91 This script has
  92 only the basic data necessary to start a new company system off. If you
  93 wish to set up your company on FrontAccounting then this is the script
  94 to use. </li>
  95 </ol>
  96 </li>
  97 <li>Now that the database is created you will need to set
  98 up a database user to access this database. DO NOT USE THE USER &#8216;ROOT&#8217;.
  99 Set up a new user and give that user full privileges over the database
 100 &#8216;frontacc&#8217;. </li>
 101 <li>After successfully install, remove or rename your
 102 install directory <strong><em>your_url/account/install</em></strong>
 103 (or
 104 whatever directory you entered) for safety reasons. You don't need it
 105 any more.</li>
 106 </ol>
 107 </li>
 108 <li>
 109 <h3>Editing config_db.php</h3>
 110 <ol>
 111 <li><strong><em>config_db.php</em></strong>
 112 contains connection information for the database. These must be set to
 113 your local settings or you will not be able to access FrontAccounting. </li>
 114 <li>FrontAccounting allows multiple connections, you can
 115 enter as many connections as you have separate entities (most people
 116 will use only one). </li>
 117 <li><strong>$db_connections</strong> is an
 118 array of connections &#8211; for each connection : </li>
 119 <li>&#8220;<strong>name</strong>&#8221; is the name of the
 120 connection, this is the name that will be displayed to the user </li>
 121 <li>&#8220;<strong>host</strong>&#8221; is the computer IP
 122 address or name where the database is. The default is localhost
 123 assuming that the web server is also the sql server. </li>
 124 <li>&#8220;<strong>dbuse</strong>r&#8221; is the user name
 125 under which the database should be accessed. NB, again, do not use the
 126 user ROOT. A user with appropriate privileges must be set up. </li>
 127 <li>&#8220;<strong>dbpassword</strong>&#8221; is the
 128 password for &#8220;dbuser&#8221;. You would have entered this when you created
 129 &#8220;dbuser&#8221;. </li>
 130 <li>&#8220;<strong>dbname</strong>&#8221; is the name of
 131 the database. The provided scripts use the name OpenAccounting. </li>
 132 <li>&#8220;<strong>tbpref</strong>&#8221; is the table
 133 prefix for
 134 the tables. If you only have access to one database, you must use table
 135 prefix to separate the companies. Table prefix is set by a table prefix
 136 counter inside config_db.php, fi. 0_ for the first company.</li>
 137 </ol>
 138 </li>
 139 </ol>
 140 <h2>&nbsp;Logging In For the First Time</h2>
 141 <ol>
 142 <li>Pleae ensure that the folder <strong>/company/0</strong>
 143 on the server is <strong>writable</strong>. </li>
 144 <li>Open a browser and enter the URL for the web server
 145 directory where FrontAccounting is installed. </li>
 146 <li>Enter the user name:&nbsp; '<strong>admin</strong>'
 147 </li>
 148 <li>Enter the password: '<strong>password</strong>'
 149 </li>
 150 <li>(NB : enter without quotation marks). </li>
 151 <li>
 152 <div>You can set up additional user accounts from the System
 153 Setup
 154 tab. Be careful not to delete the demonstration user until a new user
 155 has been set up. If there are no users defined the next time you try to
 156 login you won't be able to. The only way then to create a user to login
 157 with is to manually edit the SQL table "users" to insert a user.</div>
 158 </li>
 159 </ol>
 160 <h2>Setting Up Company Specific Data</h2>
 161 <ol>
 162 <li>All the standing configuration data is defined from the
 163 Setup tab
 164 and each link should be reviewed to enter appropriate data for the
 165 business. Setup wizards that guide you through this process has been
 166 implemented and we strongly recommend you to use this approach, see <strong><em>Installation
 167 steps (automatic, recommended)</em></strong> . </li>
 168 </ol>
 169 <h2>Troubleshooting</h2>
 170 <ol>
 171 <li>If FrontAccounting is installed locally, you may have the <strong><em>session
 172 save path</em></strong> not set correctly. Normally this is
 173 set in your php.ini (for Windows). The entry is called <strong><em>session.save_path</em></strong>.
 174 Make sure this is set to a directory that actually exists. The default
 175 is set to /tmp, which may not be valid. </li>
 176 <li>If you are installing FrontAccounting onto a shared server,
 177 you may have to set the session save path within FrontAccounting. At
 178 the top of&nbsp;
 179 /includes/session.inc you will find this line : </li>
 180 <li>Uncomment this line and set the path to a directory that
 181 exists
 182 on your server. Make sure that you have read/write privileges on this
 183 directory. </li>
 184 </ol>
 185 <p>&nbsp;</p>
 186 </body></html>