svn commit: r769317 - /incubator/shindig/branches/1.0.x-incubating/php/README

[ch...@apache.org]

Author: chabotc
Date: Tue Apr 28 10:12:49 2009
New Revision: 769317

URL: http://svn.apache.org/viewvc?rev=769317&view=rev
Log:
Added release instructions to the README

Modified:
    incubator/shindig/branches/1.0.x-incubating/php/README

Modified: incubator/shindig/branches/1.0.x-incubating/php/README
URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/php/README?rev=769317&r1=769316&r2=769317&view=diff
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/php/README (original)
+++ incubator/shindig/branches/1.0.x-incubating/php/README Tue Apr 28 10:12:49 2009
@@ -20,7 +20,7 @@
 - PHP 5.2.x with the json, simplexml, mcrypt and curl extentions enabled.
 
 
-Getting the code (if your running from svn and not a release tarball)
+Getting the code (if you're running from svn and not a release tarball)
 ============================================
 Create a subdirectory in your web document root, e.g. /var/www/html and
 checkout the Shindig code from its Subversion repository
@@ -30,7 +30,22 @@
 svn co http://svn.apache.org/repos/asf/incubator/shindig/trunk/ .
 
 
-Running Shindig
+Running Shindig from a release download
+============================================
+
+The instructions are identical as when running from an svn checkout, except
+that the /shindig/php directory in the virtual host becomes just /shindig, ie:
+
+	<VirtualHost your_ip:your_port>
+	       ServerName your.host
+	       DocumentRoot /var/www/html/shindig
+	       ... other normal settings in vhosts...
+		<Directory />
+			AllowOverride All
+		</Directory>
+	</VirtualHost>
+
+Running Shindig from an svn checkout
 ============================================
 With PHP There is no need to build anything - the source code
 is already built.
@@ -49,6 +64,7 @@
 			AllowOverride All
 		</Directory>
 	</VirtualHost>
+	
 
 Restart apache, and point your browser to:
 
@@ -76,17 +92,18 @@
 fields you want to overwrite with other values, for example on a production system you 
 would probably want to have something like:
  $shindigConfig = array(
-  'debug' => false,
+ 	'debug' => false,
   'allow_plaintext_token' => false,
   'token_cipher_key' => 'MySecretKey',
   'token_hmac_key' => 'MyOtherSecret',
   'private_key_phrase' => 'MyCertificatePassword',
-  'people_service' => 'MyPeopleService',
+  'person_service' => 'MyPeopleService',
   'activity_service' => 'MyActivitiesService',
   'app_data_service' => 'MyAppDataService',
-  'app_data_service' => 'MyAppDataService',
+  'messages_service' => 'MyMessagesService',
   'oauth_lookup_service' => 'MyOAuthLookupService'
   'xrds_location' => 'http://www.mycontainer.com/xrds',
   'check_file_exists' => false
+ );
  
 And then implement your own service and oauth lookup classes.