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