Author: chabotc
Date: Tue May 5 11:52:02 2009
New Revision: 771677
URL: http://svn.apache.org/viewvc?rev=771677&view=rev
Log:
Added seperate instructions for running php-shindig from svn, so that the main
readme file can contain the release instructions, and added a reference to it
in the main readme file
Added:
incubator/shindig/branches/1.0.x-incubating/php/docs/README.svn
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=771677&r1=771676&r2=771677&view=diff
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/php/README (original)
+++ incubator/shindig/branches/1.0.x-incubating/php/README Tue May 5 11:52:02
2009
@@ -104,6 +104,13 @@
And then implement your own service and oauth lookup classes.
+ Running from an svn checkout
+ ---------
+
+ If you want to run PHP Shindig directly from an svn checkout, please refer
to the
+ docs/README.svn file to learn about the configuration differences between
the released
+ and svn version.
+
Licensing
---------
Added: incubator/shindig/branches/1.0.x-incubating/php/docs/README.svn
URL:
http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/php/docs/README.svn?rev=771677&view=auto
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/php/docs/README.svn (added)
+++ incubator/shindig/branches/1.0.x-incubating/php/docs/README.svn Tue May 5
11:52:02 2009
@@ -0,0 +1,97 @@
+ Apache Shindig PHP
+
+ Running PHP Shindig from SVN
+ -----------
+
+ This file is intended to be a supliment to the general README file, the
release version
+ has a slightly different file path configuration
+
+ Differences between the release version and a svn checkout
+ -----------
+
+ Shindig's svn repository contains both the Java and PHP versions of shindig,
and the shared
+ javascript and features code.
+
+ To make PHP Shindig work from svn, it's default file path configurations in
+ <shindig>/php/config/container.php
+ are all configured for a file path layout where the features and javascript
code is contained
+ in a directory level above the php folder (ie <shindig>/php/../{features,
javascript}), resulting in a
+ folder layout like:
+
+ shindig/ (contains the shared README, NOTICE, LICENSE, etc files)
+ shindig/javascript (contains shared javascript code)
+ shindig/features (contains shared features code)
+ shindig/config (contains the shared configuration)
+ shindig/java (contains the java-shindig implementation)
+ shindig/php (contains the php-shindig implementation)
+
+ The release script moves these folders to the top level php folder and makes
the php folder the top
+ level folder when building it's archives, so in other words the javascript
and features code will be
+ located in <shindig>/{features, javascript}, resulting in the folowing
layout:
+
+ shindig/ (contains the php implementation(!) & the php specific
README, NOTICE, LICENSE, etc files)
+ shindig/javascript (contains shared javascript code)
+ shindig/features (contains shared features code)
+ shindig/config (contains both the shared as wel as php specific
configuration)
+ .. etc ..
+
+ Switching from release to svn, and back
+ -----------
+
+ There are 2 configurations that need to be updated to switch from release to
a svn version:
+
+ 1) Apache's virtual host configuration:
+
+ The DirectoryRoot for the release version is <shindig>/, while the
DirectoryRoot for the svn
+ version is <shindig>/php, ie:
+
+ RELEASE
+
+ <VirtualHost your_ip:your_port>
+ ServerName your.host
+ DocumentRoot /var/www/html/shindig
+ ... other normal settings in vhosts...
+ <Directory>
+ AllowOverride All
+ </Directory>
+ </VirtualHost>
+
+ SVN
+
+ <VirtualHost your_ip:your_port>
+ ServerName your.host
+ DocumentRoot /var/www/html/shindig/php
+ ... other normal settings in vhosts...
+ <Directory>
+ AllowOverride All
+ </Directory>
+ </VirtualHost>
+
+ 2) PHP Shindig's configuration
+
+ The file paths of all the shared resources are different between the
released and svn versions in the config/container.php config file
+ (notice the extra ../ for the javascript, features and jsondb path's with
the SVN version)
+
+ RELEASE
+
+ 'base_path' => realpath(dirname(__FILE__) . '/..') . '/',
+ 'features_path' => realpath(dirname(__FILE__) .
'/../features/src/main/javascript/features') . '/',
+ 'container_path' => realpath(dirname(__FILE__) . '/../config') . '/',
+ 'javascript_path' => realpath(dirname(__FILE__) . '/../javascript') . '/',
+ 'private_key_file' => realpath(dirname(__FILE__) . '/../certs') .
'/private.key',
+ 'public_key_file' => realpath(dirname(__FILE__) . '/../certs') .
'/public.crt',
+ 'private_key_phrase' => 'SOMEKEY',
+ 'jsondb_path' => realpath(dirname(__FILE__) . '/../javascript/sampledata') .
'/canonicaldb.json',
+
+ SVN
+
+ 'base_path' => realpath(dirname(__FILE__) . '/..') . '/',
+ 'features_path' => realpath(dirname(__FILE__) .
'/../../features/src/main/javascript/features') . '/',
+ 'container_path' => realpath(dirname(__FILE__) . '/../../config') . '/',
+ 'javascript_path' => realpath(dirname(__FILE__) . '/../../javascript') . '/',
+ 'private_key_file' => realpath(dirname(__FILE__) . '/../certs') .
'/private.key',
+ 'public_key_file' => realpath(dirname(__FILE__) . '/../certs') .
'/public.crt',
+ 'private_key_phrase' => 'SOMEKEY',
+ 'jsondb_path' => realpath(dirname(__FILE__) .
'/../../javascript/sampledata') . '/canonicaldb.json',
+
+
\ No newline at end of file
