Copyright (c) 2003-2006 Barnraiser. All rights reserved.
http://www.barnraiser.org/


>> UPGRADING
   Please see 'doc/upgrade.txt'.
   

>> PRE-INSTALL
   Please check you have a PHP4.x version installed. We have not tested on 
   PHP5.x yet. You are welcome to try. GDLib 2.x needs to be installed. You 
   will see errors on a 1.x version. You are welcome to modify the 
   File.class.php file to cope with a v1.x version. FreeType needs to be 
   installed.
   
   Spell checking
   You can enable spell checking support (recommended) if your server supports
   Aspell. To Install Aspell follow the instructions at 
   http://aspell.sourceforge.net/ [Windows users please note the link 'Windows 
   Port' on the page. Follow that and install the 'Full installer']. After 
   you have installed please follow the link to 'Dictionaries' and install the 
   dictionionaries you require.
   
   Database
   The standard SQL statements we supply create InnoDB, a MySQL transaction-safe 
   storage engine. It has been designed for maximum performance when processing 
   large data volumes. Its CPU efficiency is probably not matched by any other 
   disk-based relational database engine. It has been proven to handle an average 
   load of 800 inserts/updates per second. You may wish to change this prior to 
   installation by editting the /install/aroundme.sql file.
   
   For more information: http://dev.mysql.com/doc/mysql/en/innodb-overview.html
   
   CHARACTER SETS
   Unicode provides a unique number for every character, no matter what the 
   platform, no matter what the program, no matter what the language. The Unicode 
   Standard has been adopted by such industry leaders including Apple, HP, IBM, 
   Microsoft, Oracle, SAP, Sun, Sybase and Unisys. Unicode is required by modern 
   standards such as XML, Java, ECMAScript (JavaScript), LDAP, CORBA 3.0, WML, 
   etc., and is the official way to implement ISO/IEC 10646. It is supported 
   in many operating systems, all modern browsers, and many other products.

   Unicode enables a single software product or a single website to be targeted 
   across multiple platforms, languages and countries without re-engineering 
   and allows data to be transported through many different systems without 
   corruption.
   
   We have adopted UNICODE for AROUNDMe. In /install/aroundme.sql we create our 
   database tables using "CHARACTER SET utf8". We recommend that you use this.
   
   For more information:
   http://www.unicode.org/
   http://dev.mysql.com/doc/mysql/en/charset-unicode.html
   
   
>> WHO SHOULD INSTALL
   This is a web site and should be installed by a web site systems 
   administrator (webmaster). An understanding of FTP, changing directory 
   privileges and web servers is required. We cannot support you if you are 
   not able to understand these things.
   
   
>> INSTALL
   1. Please read the terms of the license prior to install. 3rd party classes 
      are included for ease. Please note, these are under separate licenses.

	  FTP note: When uploading a font to your website you have to set the 
	  transfer mode to binary.
	  
   2. Use the included install/aroundme.sql file to populate a database (you will need 
      to manually create a new database first). For development we recommend 
      using MySQL, however ADOdb supports many database types. Please note, we 
      have only tested this software with MySQL. No support for other databases 
      can be given at this time.

      You can edit the aroundme.sql file to change the prefix of the database 
      name. By default this is "am_<database_table_name>", but if you wish 
      to have multiple instances of AROUNDMe under one account you can edit this 
      to anything such as "am_dev_<database_table_name>" - remember to update 
	  the server_config file db_prefix var to reflect your changes.

   3. Edit the /config/config_aroundme.inc.php with your server and database 
      connection variables.
      
   4. [optional] If you require spell checking and you have Aspell installed 
      update the $c_node['node']['language']['aspell']['command'] variable to 
      include the path to you Aspell installation. Standard aspell installs 
      are:
        
        WINDOWS          '"C:\Program Files\Aspell\bin\aspell.exe"'
        GNU/Linux        "/usr/local/bin/aspell"

   5. Edit the .htaccess file and replace the 404 error URL with your own.
   

>> SETUP
   1. Register as a user. You will receive an email. Complete step 2 BEFORE 
      actioning the email.
	  
   2. The user_id you have been assigned will be "1". This is insecure. We 
      recommend that you change the user_id to be a random number between 1 
	  and 100000 by running the following SQL statement:
	  
	  UPDATE am_user set user_id=<random_number> where user_id=1;
      
      If you do this you will also need to update the auto increment value set 
	  against the table:
	  
	  ALTER TABLE am_user AUTO_INCREMENT =<random_number+1>
	  
   3. Following the instructions in the email complete the registration process.
      Once complete change your 'role_id' to administrator level. In 
	  config_acs.inc.php $c_acs['arr_acs']['resource']['administration'] is 
	  the administrator (admin privilege). The default value is 1. 
	  
	  UPDATE am_user set role_id=1 where user_id=<random_number>;
	  
   4. Setup the administrator privileges. Insert the 'allow_access' privilege 
      into the am_acs_permission table. Default is:

      INSERT INTO `am_acs_permission` VALUES (1, 1, 3, 1);
	  
   5. Logoff and log in again. You will now see a "permissions" button appear 
      under the "structure" menu. Go to the permissions page. Check the boxes 
	  for the permissions for the maintainer to grant yourself permissions 
	  throughout the system (recommended that you check all boxes) and press 
	  "update permissions".
	  
   6. start playing.
   
   
>> CRON
   1. Set the $c_node['batch']['enabled'] config var to true and then just 
      schedule the script newsletter scripts:
	  
	  nlt_send.php
	  When a user or a group sends a newsletter nlt_send will send out X 
	  newsletters every time cron activates the script until there are no 
	  more newsletters to send.

	  The number of newsletter send each time is defined by the 
	  $c_node['newsletter']['nr_per_batch'] config variable. As default 
	  this is set to 25 per script excecution:

	  $c_node['newsletter']['nr_per_batch'] = "25";

	  Setup a crontab that will send X newsletters (default 10) every Y times 
	  per day. You should consider the number of projected users, the number of 
	  projected newsletters, the number of mail servers and the processing 
	  speed of your server when doing this. If you are unsure and you just 
	  want to get up and running set this to execute every 15 minutes:

	  10,25,40,55 * * * * /usr/local/bin/php -q /home/b2350/build/aroundme/batch/nlt_send.php 

	  This will run at 10,25,40 and 55 minutes past each hour.

	  nlt_digest_send.php
	  This file runs the weekly digest email. It selects all the people that 
	  registered on the same day as the run time (ie: it will send an email to 
	  everyone who registered on a monday on monday).

	  0,15,30,45 * * * * /usr/local/bin/php -q /home/b2350/build/aroundme/batch/nlt_digest_send.php 

	  This will run at 0,15,30 and 45 minutes past each hour.
	  
	  mail_notification.php
	  This file sends an email to users who are tracking items. When an item 
	  has a comment added anyone tracking it will receive an email, thus this 
	  script should run frequently (example for send every 2 minutes).
	  
	  2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,38,40,42,44,46,48,50,52,54,56,58 * * * * /usr/local/bin/php -q /home/b2350/build/aroundme/batch/mail_notification.php
      
	  sn_calculate.php
	  This file calculates a persons full social network when a person is added 
	  to their first degree network. 
      
	  5,20,35,50 * * * * /usr/local/bin/php -q /home/b2350/build/aroundme/batch/sn_calculate.php
	  
	  pending_user_cleanup.php
	  This file remove anyone who registered but did not complete setup more than 
	  24 hours ago.
	  
	  * 1 * * * /usr/local/bin/php -q /home/b2350/build/aroundme/batch/sn_calculate.php
	  
	  This script will run at 01:00 daily.

>> COMMON ERRORS
   1. No GDLIB Installed (Windows only)

	You will need GDLib support active for uploading images. Php4.3.x and up 
	has this built in, but not activated:

	Now you should have a file named php.ini.dist (for this document we will 
	assume it to be in in this path "c:\php\"). Rename that to php.ini and copy 
	it to the root of you Windows directory, C:/WINDOWS/ (be sure to back up 
	the one that is there).
	
	change:
		extension_dir = ":/"
	to:
		extension_dir= " C:\php\extensions"

	uncomment to extension:
	
	change:
		;extension=php_gd2.dll
	to:
		extension=php_gd2.dll
		
	You must restart to see the changes take effect.
	
   2. Session Errors (Windows only)
	You will need to set up a session save path in php.ini. Edit php.ini:
	
	change
		session.save_path = "/tmp"
	to:
		session.save_path = "C:\tmp\"
	
	(C:\tmp\ used as example - you can change the directory path to suit you)

      	
>> UNSUPPORTED LANGUAGES
   You can add a language by translating the language files, adding an ID to the 
   config file and by updating set_locale function in the User.class.php file, but 
   we would be happier if you worked with us so that we add it and everyone gets it.


>> TECHNICAL SUPPORT
   See our community at http://build.barnraiser.org/ for support. If in doubt 
   contact Barnraiser and we will try to help you - http://www.barnraiser.org/





