Author: chabotc
Date: Tue May 20 15:07:52 2008
New Revision: 658463
URL: http://svn.apache.org/viewvc?rev=658463&view=rev
Log:
Updated readme with better instructions. Thanks to Erel Segal for taking the
time to format this into a digestable format
Modified:
incubator/shindig/trunk/php/README
Modified: incubator/shindig/trunk/php/README
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/php/README?rev=658463&r1=658462&r2=658463&view=diff
==============================================================================
--- incubator/shindig/trunk/php/README (original)
+++ incubator/shindig/trunk/php/README Tue May 20 15:07:52 2008
@@ -1,18 +1,56 @@
Installing and Running The PHP Shindig Gadget Server
============================================
-1) Make sure you have PHP 5.x installed and have the simplexml and json
extentions enabled; It also
- requires apache with .htaccess and mod_rewrite support
+Prequisites before building Shindig for PHP
+============================================
+In order to build and run Shindig for PHP, you must have the following:
+
+- A Subversion client installed in order to checkout the code.
+ Instructions for downloading and installing Subversion can be found here:
+ http://subversion.tigris.org/
+- Apache with mod_rewrite enabled.
+- PHP 5.2.x with the json, simplexml, mcrypt and curl extentions enabled.
+
+
+Getting the code
+============================================
+Create a subdirectory in your web document root, e.g. /var/www/html and
+checkout the Shindig code from its Subversion repository
+
+mkdir /var/www/html/shindig
+cd /var/www/html/shindig
+svn co http://svn.apache.org/repos/asf/incubator/shindig/trunk/ .
+
+
+Running Shindig
+============================================
+With PHP There is no need to build anything - the source code
+is already built.
+
+To run the code, you have several options:
+
+a. Create a new virtual host
+
+Point your apache to the php dir with a virtual host like:
+
+ <VirtualHost your_ip:your_port>
+ ServerName your.host
+ DocumentRoot /var/www/html/shindig/php
+ ... other normal settings in vhosts...
+ </VirtualHost>
+Restart apache, and point your browser to:
+
+http://<your.host>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
+
+you should see something like this:
+http://shindig.chabotc.com/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
+
+b. Run with an existing host
-2) Copy the files to your web root, and edit the config.php web_prefix and
debug settings
- to your liking. Make sure that the features and javascript directories are
also copied
- or edit your config.php to reflect their location. If you change the
web_prefix also
- update the container/container.js file too point to the correct locations
+If you cannot/don't want to create a virtual host, you can edit the file
php/config.php and
+change the web_prefix setting to '/shindig/php'.
-3) Hit server at http://<yourhost>/gadgets/ifr?url=<gadget-url>
- Example:
http://<yourhost>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
- Or hit the sample container at
http://<yourhost>/gadgets/files/samplecontainer/samplecontainer.html
+Then you can run the gadget by pointing your browser to:
-The PHP source of the gadget server resides in the gadgets, socialdata and
common directories.
+http://<your.host>/shindig/php/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
-For more information, see http://incubator.apache.org/projects/shindig.html
