/**************************************************************
 * File: 	Documentation: Installation
 * Author:	Mike Lansberry (http://phpCOIN.com)
 * Date:	2004-01-04 (V1.2.0)
 * License:	DO NOT Remove this text block. See /docs/license.txt
 *			Copyright © 2003-2004 phpCOIN.com
 * Schema:	See sql file for schema reference
 * Notes:
 *			- installation instructions
**************************************************************/

/**************************************************************
 * Important stuff
**************************************************************/
Some items to resolve right away:
	- Tab-spaces for all files is:	4-char (spaces / tab)
	  (may need to adjust editor program preferences)

	- Unix type text file. All files are created and edited
	  as "unix text" files. Be careful of editors saving in
	  DOS, or MAC type files- always use unix.
	  (may need to adjust editor program preferences)

	- Where to install?
	  Make the decision to either run phpcoin as a website
	  or as an addon to existing website. Basically you need
	  to decide on a folder or directory to plop the files in.

	- File: atroot.php is very important !!
	  If you change the default folder from phpcoin, then
	  be sure to read the directions in the file and to make
	  the correct setting. ALL site references are built from
	  this setting.

	- Backup your database before giving me a whack at it.


/**************************************************************
 * Installation- Short method (feeling lucky)
**************************************************************/
- Download zip file, extract files.

- Edit:
	atroot.php					- path / directory setting
	config.php					- misc site parameters
	database/db_config.php		- database settings

- Upload everything to desired folder.

- Make sure required database and user are created.

- Move file atroot.php to root directory of your site.
	(if phpcoin is not installed in root)

- Run: http://www.your-site.com/phpcoin_dir/setup/setup.php
	(requires database password for performing)

- Go to site and start (continue) setup.
	Admin URL:			http://your-domain.com/phpcoin_dir/admin.php
	Default Admin Name:	webmaster
	Default Password:	your database password entered for install

/**************************************************************
 * Installation- Normal method (better choice)
**************************************************************/
- Download latest zip file from website and when prompted,
  click "save as" to save file to your computer (desktop OK).

  	Typically filename will be like: phpcoin_Vxxx.zip
	  
- Using WinZip (or equal) extract the contents of the zip file.
  The extracted result should be a folder, named something like:
	  
  	Typically extracted folder will be: phpcoin

- Decide where to install:
	- As a WebSite:		
		ex. httpdocs/ or public_html/

	- As an addon to existing website:		
		ex. httpdocs/phpcoin/ or public_html/phpcoin/

- Important Parameter File Editing:
  SEE FOLLOWING SECTION on required configuration file settings.
  
  	- Make all required configuration settings

- Upload files to your server as follows:
	- ASCII (all files except images)
	- BIN	(all image files- .gif, .jpg, etc..

	As a website:
	- Copy all files in the phpcoin folder, note- all files
	  in folder not actual folder, to the root folder of your
		ex. httpdocs/ or public_html/

	As an addon to a website:
	- Copy the entire phpcoin folder to the root folder of your
	  website (ex. httpdocs, public_html) and rename if desired.
		ex. httpdocs/phpcoin/ or public_html/phpcoin/

	- Move the file atroot.php from the phpcoin folder to the
	  website root directory.	  

- Set permissions- none special, all must be readable and
  executable as required by your host.
  
  Only <database>db_config.php directory contains database
  username and password. So- may want to make sure not readable
  or even pasword protect directory (in case php fails).

- Make sure required database and user are created.

- Run: http://www.your-site.com/phpcoin_dir/setup/setup.php
	(requires database password for performing)

- Go to site and start (continue) setup.
	Admin URL:			http://your-domain.com/phpcoin_dir/admin.php
	Default Admin Name:	webmaster
	Default Password:	your database password entered

- See additional documents for more info on phpCOIN


/**************************************************************
 * Configuration: (pre-installatiion)
**************************************************************/
Important Parameter File Editing:

- Required Pre-Installation Parameter Descriptions:
  The following configuration items need to be set / verified
  prior to installation.
  
	- File: <site_root>ATROOT.PHP
		- Set package install path from root.
		- Parameter:
		  $_PACKAGE_DIR = '';			// If as website.
		  $_PACKAGE_DIR = 'phpcoin/';	// If in subdir /phpcoin/.


	- File: <site_root><phpcoin_dir><database>DB_CONFIG.PHP
		- Database configuration file
		- Parameters:

		/****************************************************
		 * Database Configuration Array
		****************************************************/
		- Database Server (type) (only "mysql")
		- Default "mysql"- do not change
			$_DBCFG['dbms'] 			= "mysql";

		- Database Host
		- Default "localhost"- should not need to change
			$_DBCFG['dbhost'] 			= "localhost";

		- Database User
		- The database user name
		- Change "username" to your correct value
			$_DBCFG['dbuname'] 			= "username";

		- Database Password
		- The database user password
		- Change "userpassword" to your correct value
			$_DBCFG['dbpass'] 			= "userpassword";

		- Database Name
		- The database name
		- Change "databasename" to your correct value
			$_DBCFG['dbname'] 			= "databasename";

		- Database Table Prefix
		- The database table prefix to prefix table names.
			$_DBCFG['table_prefix'] 	= "phpcoin_";