Author: ieb
Date: Tue Jun 23 09:16:29 2009
New Revision: 787590
URL: http://svn.apache.org/viewvc?rev=787590&view=rev
Log:
SHINDIG-1098
Changes for some misc files in the php subtree.
This takes the merge upto
f5236a8c13d688d17f527e4bc06aa9cfd02752e0
or
725744
Modified:
incubator/shindig/trunk/php/README
incubator/shindig/trunk/php/make-release.sh
Modified: incubator/shindig/trunk/php/README
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/php/README?rev=787590&r1=787589&r2=787590&view=diff
==============================================================================
--- incubator/shindig/trunk/php/README (original)
+++ incubator/shindig/trunk/php/README Tue Jun 23 09:16:29 2009
@@ -1,109 +1,154 @@
-Welcome to Apache Shindig!
+ Apache Shindig PHP
-* Read javascript/README for instructions for using the Shindig Gadget
+ What is it?
+ -----------
+
+ Shindig is a JavaScript container and implementations of the backend APIs
+ and proxy required for hosting OpenSocial applications.
+
+ This is the PHP implementation of Shindig. If you are looking to the Java
+ implementation, please visit our website.
+
+ Documentation
+ -------------
+
+ The most up-to-date documentation can be found at
http://incubator.apache.org/shindig/
+ and at http://incubator.apache.org/shindig/developers/php/index.html
+ for specific PHP documentation.
+
+ Read javascript/README for instructions for using the Shindig Gadget
Container JavaScript to enable your page to render Gadgets.
-* Read the instructions below for how to use PHP Shindig
-* For more information, see http://incubator.apache.org/shindig/
+ Release Notes
+ -------------
-Installing and Running The PHP Shindig Gadget Server
-============================================
+ The full list of changes can be found at
https://issues.apache.org/jira/browse/SHINDIG.
-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 (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
-
-mkdir /var/www/html/shindig
-cd /var/www/html/shindig
-svn co http://svn.apache.org/repos/asf/incubator/shindig/trunk/ .
-
-
-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.
-
-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...
- <Directory />
- AllowOverride All
- </Directory>
- </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
-
-If you cannot/don't want to create a virtual host, you can edit the file
php/config/container.php
-or php/config/local.php (see the comments php/config/container.php for
documentation of the
-configuration system) and change the web_prefix setting to '/shindig/php'.
-
-In this case, you should also change all paths in shindig/config/container.js
-(see the comments there for documentation of the JSON configuration system).
-
-Then you can run the gadget by pointing your browser to:
-
-http://<your.host>/shindig/php/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
-
-Going forward
-============================================
-Check out the php/config/container.php file, in local.php you only have to
specificy the
-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,
- 'allow_plaintext_token' => false,
- 'token_cipher_key' => 'MySecretKey',
- 'token_hmac_key' => 'MyOtherSecret',
- 'private_key_phrase' => 'MyCertificatePassword',
- 'person_service' => 'MyPeopleService',
- 'activity_service' => 'MyActivitiesService',
- 'app_data_service' => 'MyAppDataService',
- 'messages_service' => 'MyMessagesService',
- 'oauth_lookup_service' => 'MyOAuthLookupService'
- 'xrds_location' => 'http://www.mycontainer.com/xrds',
- 'check_file_exists' => false
- );
+ System Requirements
+ -------------------
+
+ PHP:
+ 5.2.x or above with the json, simplexml, mcrypt and curl extentions
+ enabled.
+ Web server:
+ Apache with mod_rewrite enabled.
+ Memory:
+ No minimum requirement.
+ Disk:
+ No minimum requirement.
+ Operating System:
+ No minimum requirement. On Windows, Windows NT and above or Cygwin is
+ required for the startup scripts. Tested on Windows XP, Fedora Core
+ and Mac OS X.
+
+ Installing Shindig
+ ------------------
+
+ Unzip the distribution archive, i.e. shindig-1.0-incubating-php.zip to
+ the web document root, e.g. /var/www/html.
+
+ Rename the created shindig-1.0-incubating-php dir to shindig.
+
+ a. Create a new virtual host
+
+ Point your Apache to the shindig dir with a virtual host like:
+
+ <VirtualHost your_ip:your_port>
+ ServerName your.host
+ DocumentRoot /var/www/html/shindig
+ ... other normal settings in vhosts...
+ <Directory>
+ AllowOverride All
+ </Directory>
+ </VirtualHost>
+
+ Restart apache, and point your browser to:
+
+
http://<your.host>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
+
+ b. Run with an existing host
+
+ If you cannot/don't want to create a virtual host, you can edit the file
+ php/config/container.php or php/config/local.php (see the comments
+ php/config/container.php for documentation of the configuration system)
+ and change the web_prefix setting to '/shindig/php'.
+
+ In this case, you should also change all paths in shindig/config/container.js
+ (see the comments there for documentation of the JSON configuration system).
+
+ Then you can run the gadget by pointing your browser to:
+
+
http://<your.host>/shindig/php/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
+
+ Going forward
+ -------------
+
+ Check out the php/config/container.php file, in local.php you only have
+ to specificy the 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,
+ 'allow_plaintext_token' => false,
+ 'token_cipher_key' => 'MySecretKey',
+ 'token_hmac_key' => 'MyOtherSecret',
+ 'private_key_phrase' => 'MyCertificatePassword',
+ 'person_service' => 'MyPeopleService',
+ 'activity_service' => 'MyActivitiesService',
+ '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.
+ 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
+ ---------
+
+ Please see the file called LICENSE.
+
+ Shindig URLS
+ ------------
+
+ Home Page: http://incubator.apache.org/shindig/
+ Downloads: http://incubator.apache.org/shindig/download/index.html
+ Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
+ Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
+ Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
+ Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
+
+This distribution includes cryptographic software. The country in
+which you currently reside may have restrictions on the import,
+possession, use, and/or re-export to another country, of
+encryption software. BEFORE using any encryption software, please
+check your country's laws, regulations and policies concerning the
+import, possession, or use, and re-export of encryption software, to
+see if this is permitted. See <http://www.wassenaar.org/> for more
+information.
+
+The U.S. Government Department of Commerce, Bureau of Industry and
+Security (BIS), has classified this software as Export Commodity
+Control Number (ECCN) 5D002.C.1, which includes information security
+software using or performing cryptographic functions with asymmetric
+algorithms. The form and manner of this Apache Software Foundation
+distribution makes it eligible for export under the License Exception
+ENC Technology Software Unrestricted (TSU) exception (see the BIS
+Export Administration Regulations, Section 740.13) for both object
+code and source code.
+
+The following provides more details on the included cryptographic
+software:
+
+ Apache Shindig PHP interfaces with the mcrypt API
+ <http://mcrypt.sourceforge.net/> to provide encryption
+ of messages using the AES standard.
+
Modified: incubator/shindig/trunk/php/make-release.sh
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/php/make-release.sh?rev=787590&r1=787589&r2=787590&view=diff
==============================================================================
--- incubator/shindig/trunk/php/make-release.sh (original)
+++ incubator/shindig/trunk/php/make-release.sh Tue Jun 23 09:16:29 2009
@@ -2,8 +2,8 @@
#### Settings, feel free to adjust these as required ####
-VERSION=SNAPSHOT
-NAME="shindig-${VERSION}"
+VERSION=1.0.0
+NAME="php-shindig-${VERSION}"
OPWD=`pwd`
#### Build a clean php-shindig tarball
