INSTALLATION
============


Requirements
------------
In order to be able to install and use NJsql, you will need:
- To have write access to the machine on which you want to install NJsql (the
  target machine).
- An HTTP server running on the target machine.
- PHP >= 4.3.0 (PHP 5 is OK) enabled on the target machine.
- A running "DB server". A "DB server" is a RDBMS (Relational database
  management system) understanding SQL.
  Note: Although on most sites the "DB server" will be local (i.e. running
  on the target machine), it can also be running on a remote machine.
  Current supported RDBMS:
    - MySQL >= 3.23 (4 & 4.1 are OK, 5 has not been tested yet)
    - PostgreSQL 7.4 & 8.0 (7.3 might work but has not been tested)
  Will be supported very soon (probably in version 0.9): SQLite.
  Might be supported in the future: Oracle and MS SQL.


Download NJsql
--------------
- Last version of NJsql is freely available from http://herve.pages.free.fr/
- Download the last tarball (njsql-X.Y.Z.tgz) and save it somewhere on your
  local hard drive.


Install NJsql
-------------
If you have "command line" access (via SSH, telnet, rlogin etc...) to the
target machine:
  a) Transfer (via FTP) njsql-X.Y.Z.tgz somewhere under the DocumentRoot
     directory of the HTTP server.
  b) Untar it:
       tar zxvf njsql-X.Y.Z.tgz
     This will create the directory njsql-X.Y.Z and extract all the NJsql
     files and subdirectories under it.
  c) If there is already a symlink or directory called njsql (which should
     be the case if you are updating NJsql), you MUST delete it before to
     continue.
  d) If the target machine file system supports symbolic links, do:
       ln -s njsql-X.Y.Z njsql
  e) If the target machine file system does NOT support symlinks, just
     rename the njsql-X.Y.Z directory to njsql:
       mv njsql-X.Y.Z njsql

If you DON'T have "command line" access to the target machine (most providers
don't allow "command line" access to their HTTP server):
  a) Untar njsql-X.Y.Z.tgz on your local hard drive.
     This will create the directory njsql-X.Y.Z and extract all the NJsql
     files and subdirectories under it.
  b) Rename the njsql-X.Y.Z directory to njsql.
  c) Transfer the njsql tree (i.e. the njsql directory + all files and
     subdirectories under it) to some place under the DocumentRoot directory
     of the HTTP server.

In both case, you shoud end up with the NJsql files and subdirectories
located under the "NJsql base directory". Starting from now, the absolute
path to this directory will be referred as
    /abolute_path_to_the_njsql_basedir/
Following this convention, the absolute path to the INSTALL.TXT file (this
file) will be referred as:
    /abolute_path_to_the_njsql_basedir/Doc/INSTALL.TXT
The absolute path to the NJ_constants.inc.php file will be referred as:
    /abolute_path_to_the_njsql_basedir/inc/NJ_constants.inc.php


Configure NJsql
---------------
Edit the config-default.inc.php file located under
    /abolute_path_to_the_njsql_basedir/inc/config/
and set the PHP constants according to your site.
 

Getting started
---------------
See
    /abolute_path_to_the_njsql_basedir/clients/SimpleNJclient/README.TXT
for how to use NJsql in your application.


I hope you like it!

If you need help, want to report a bug or make comments/suggestions
about NJsql, please send me an email at herve.pages@free.fr