rhoconnect 3.4.5 → 4.0.0.beta.10

data/doc/push-client-setup-rps.txt

@@ -0,0 +1,200 @@
+Setting Up for RhoConnect Push Service on Client Application
+===
+
+RhoConnect Push Service is a separate process that will run on your machine and broker push messages between your RhoConnect server and registered Android and Windows Mobile/CE devices.
+
+This chapter contains the steps you need to set up your registered Android or Windows Mobile/CE client and RhoConnect server for RhoConnect Push Service. After you perform the steps in this chapter, you will finish by performing the [client setup that is needed for all platforms](/rhoconnect/push-client-setup).
+
+**NOTE: If you are setting up standard RhoConnect Push on Android, you do not perform the steps in this chapter. Perform the steps in [RhoConnect Push for Android setup](/rhoconnect/push-client-setup-android) instead.**
+
+## Setting up RhoConnect Push Service on the Server
+
+RhoConnect v3.3 introduces the RhoConnect Push Service (RPS) which supports efficient messaging for both Android and Windows Mobile. This service can be used instead of Google GCM on Android.
+
+The typical flow of a message using RPS:
+
+	Device      RPS       	 RhoConnect        Backend App
+	+           +            +                 +
+	|           |            |                 |
+	|           |            | POST            |
+	|           | POST       |/rc/v1/users/ping|
+	|           |/instanceId |<----------------+
+	|           |<-----------+                 |
+	|<----------+            |                 |
+	|{"content"}|            |                 |
+	|           |            |                 |
+	+           +            +                 +
+
+### Download and Install Nodejs
+
+If you are using a Macintosh, go to the [Node.js website](http://nodejs.org/#), and download and install Node.js. (Motorola RhoMobile Suite for Windows includes Node.js in its installation.)
+
+### Starting the Push Service
+
+RhoConnect Push Service is a separate process that will run on your machine and broker push messages between your RhoConnect server and registered devices.
+
+Assuming you've installed the latest [RhoMobile Suite](http://www.motorola.com/Business/US-EN/RhoMobile%20Suite/Downloads), start redis by runing the following command:
+
+	:::term
+	$ rhoconnect redis-start
+
+Now start RhoConnect push by running the following command:
+
+	:::term
+	$ rhoconnect-push
+	RhoConnect push server started...
+
+You can also start the server with more verbose logging (see next section for more details):
+
+	:::term
+	$ rhoconnect-push -d 3
+
+Next, make sure you have the following option in your RhoConnect application's `settings/settings.yml` file in the `:development:`, `:production:` and `:test:` sections:
+
+	:::yaml
+	:push_server: http://someappname@localhost:8675/
+
+Where you edit `someappname` to be a shared secret name between your RhoConnect application and your mobile application.
+
+**NOTE: This shared secret name ensures that only your RhoConnect application can send push messages to the RPS instance you started up in the previous step.  Use this shared secret name in your [mobile app's 'rhoconnect_push_appname' setting](/rhoconnect/push-client-setup-rps#configuring-rhoconfigtxt).**
+
+Now setup [push notifications](/rhoconnect/push-client-setup#configuring-a-rhodes-application-to-receive-push-with-rhoconnect-push-service) in your Android or Windows Mobile RhoElements application, then start up your RhoConnect application.
+
+### Configuring RhoConnect Push
+
+You can control basic settings for RhoConnect push using command line arguments.
+
+	:::term
+	$ rhoconnect-push --help
+
+	Usage: rhoconnect-push [options]
+
+	Available options:
+	  -c, --config FILE           Path to configuration (config.json) file
+	  -d, --debug LEVEL           Specify server debug level: 0 (errors) - 3 (everything)
+	  -e, --rcPort PORT           Specify RhoConnect instance port
+	  -h, --help                  Print this help message
+	  -i, --rcHost HOST           Host for the RhoConnect instance
+	  -k, --keyFile FILE          Path to private SSL keyfile (https only)
+	  -p, --port                  Run the server on this port (defaults to 8675)
+	  -r, --redis REDIS           Redis connection string (i.e. redis://localhost:6379)
+	  -s, --httpSecure            Specify if this server is running over https or http
+	  -t, --timeout TIMEOUT       Time (in ms) before timeout is sent to client
+	  -T, --registrationTimeout   Expiration limit for client registration tokens
+	  -v, --version               Display server version
+
+### Configuring and Running with config.json Advanced Options
+
+You can also configure more advanced settings in RhoConnect push by creating a config.json file.
+
+	:::json
+	{
+		"httpSecure": "n",
+		"devAuthHost": "localhost",
+		"devAuthUrl": "/rc/v1/app/ans_login",
+		"devAuthPort": "9292",
+		"userAuthHost": "localhost",
+		"userAuthUrl": "/rc/v1/app/ans_login",
+		"userAuthPort": "9292",
+		"appAuthHost": "localhost",
+		"appAuthUrl": "/rc/v1/app/ans_login",
+		"appAuthPort": "9292",
+		"ansResponseTimeout": "300000",
+		"ansServerPort": "8675",
+		"registrationTimeout": "2592000",
+		"clearDataBase": "n",
+		"socketPoolSize": 1,
+		"debugLevel": "3"
+	}
+
+To start the server using a config.json file, run the following command.
+
+	:::term
+	$ rhoconnect-push -c /path/to/config.json
+
+The JSON file has the following parameters.
+
+* `httpSecure` - Specify whether the push server will be an https or http server (y/n).
+* `devAuthHost` - RhoConnect instance used to handle device credentials.
+* `devAuthUrl` - Path used on the RhoConnect instance to handle device credentials.
+* `devAuthPort` - Port used on the RhoConnect instance to handle device credentials.
+* `userAuthHost` - RhoConnect instance used to handle user credentials.
+* `userAuthUrl` - Path used on the RhoConnect instance to handle user credentials.
+* `userAuthPort` - Port used on the RhoConnect instance to handle user credentials.
+* `appAuthHost` - RhoConnect instance used to handle application credentials.
+* `appAuthUrl` - Path used on the RhoConnect instance to handle application credentials.
+* `appAuthPort` - Port used on the RhoConnect instance to handle application credentials.
+* `ansResponseTimeout` -  Time (in ms) that the push server will allow a message request from the client to go without a response. Upon expiration of this time, a 204 response will be issued and the request will be considered satisfied. If this parameter is set to 0, then this time limit will not be in effect - there is no limit to how long a client request will go without a response.
+* `ansServerPort` - Push server listening port
+* `registrationTimeout` - Expiration limit for registration tokens (in seconds), the client-side application is automatically unregistered if there is no activity related to its token for the registrationTimeout period. Activity related to its token consists of either attempted fetches of messages on its behalf by the push client or messages sent to the push server by RhoConnect.
+* `clearDataBase` - Clear the redis database containing tokens, instanceIds, etc. at the start of the push server (y/n).
+* `socketPoolSize` - The maximum number of sockets the push server will use when connecting to each of the authorization servers. This essentially caps the number of http requests to each authorization server that the push server can have outstanding at any given time.
+* `debugLevel` -  Print additional information to console to aid in debugging:
+  * 0 - print only error & warning info
+  * 1 - print error & warning info and message for each invoked ANS operation
+  * 2 - reserved for future use
+  * 3 - print everything
+
+## Installing the rhoconnect-push-service Runtime Apps on the Mobile Device
+
+To use the RhoConnect Push Service in your client application, you must install the rhoconnect-push-service runtime app(s) on your mobile device.
+
+On the Macintosh, the rhoconnect-push-service runtime apps for Android and for Windows Mobile are located in the Motorola RhoMobile Suite installation package, in a folder called rhoconnect-push-service.
+
+On Windows, the rhoconnect-push-service runtime apps for Android and for Windows Mobile are located in the Motorola RhoMobile Suite installation, in a directory called rhoconnect-push-service.
+
+### Installing Runtime Apps on Android Device
+
+If you are using an Android device, install `rhoconnect_push_service.apk` to your device. One way to do this is to connect your Android to your computer with a USB cable and use `adb install`. You can verify that your device is connected by executing:
+
+	$ adb devices
+
+If connected, you’ll see the device name listed. If your computer doesn’t see the device, try killing the adb process first:
+
+	$ adb kill-server
+
+Then navigate to the directory containing the runtime file and run `adb install`.
+
+	$ adb install <filename>.apk
+
+### Installing Runtime Apps for Windows Mobile/CE Devices
+
+If you are using a Windows Mobile or CE device, install the following runtime apps on your device.
+
+* `rhoconnect-push-service.CAB`
+* `NETCFv35.Messages.EN.wm.cab`
+* `NETCFv35.Messages.EN.cab`
+
+Connect your device to your Windows computer. You can use USB-cable, bluetooth or any other method. Start ActiveSync or Windows Mobile Device Center.
+
+Manually copy the .cab files to the device. For example, you can use the device File Explorer to display the .cab files that are on the computer. Click on each .cab file and the installation process will be started; after it is finished, you should see the app icon on your device in Programs.
+
+## Setting up the Rhodes Client for RhoConnect Push Service
+
+To set up your Rhodes client application for RhoConnect Push Service, you configure rhoconfig.txt and build.yml.
+
+### Configuring rhoconfig.txt
+
+In your client application `rhoconfig.txt` file, set the following options to configure your RhoConnect Push Service.
+
+    syncserver = 'http://<hostname>:<port>/application'
+    rhoconnect_push_server = 'http://<hostname>:<port>'
+    rhoconnect_push_appname = 'someappname'
+
+Next, your RhoConnect application should be running on a network that is accessible to your device. For example, you might have your RhoConnect application running on a LAN with IP 192.168.1.10, PORT 9292. Then make sure your device is connected to the same LAN.
+
+Here is an example of setting `rhoconfig.txt` for the RhoConnect Push Service. The URLs used for the RhoConnect Push Service (rhoconnect_push_server) and the RhoConnect server are running on the same host.
+
+    syncserver = 'http://192.168.1.10:9292/application'
+  	rhoconnect_push_server = 'http://192.168.1.10:8675'
+  	rhoconnect_push_appname = 'someappname'
+
+### Configuring build.yml
+
+When you configure your application `build.yml` file for RhoConnect Push Service, do not add `push` under `capabilities`. Instead, add rhoconnect-push to extensions.
+
+	extensions: ["rhoconnect-push"]
+
+## Finishing Client Setup
+
+Once you have completed the above steps for setting up for RhoConnect Push Service on Android or Windows Mobile/CE client and RhoConnect server, you must still [perform the client setup that is needed for all platforms](/rhoconnect/push-client-setup).

data/doc/push-client-setup.txt

@@ -1,18 +1,22 @@
 Setting Up for RhoConnect Push on Client Application
 ===
 
-Push notification support (receiving push notifications from the RhoConnect server/backend) is currently available for Android, Blackberry and iPhone.
+This chapter contains the final steps for setting up your Rhodes application for RhoConnect Push. You also need to perform the setup on client and server for your mobile device platform (if you have not done so already).
 
-## Configuring a Rhodes Application to Receive Push
+ * [Setup for RhoConnect Push Service on client and server](/rhoconnect/push-client-setup-rps).
+ * [Setup for RhoConnect Push on client and server for Rhodes Android Client](/rhoconnect/push-client-setup-android).
+ * [Setup for RhoConnect Push on client and server for Rhodes Blackberry Client](/rhoconnect/push-client-setup-bb).
+ * [Setup for RhoConnect Push on client and server for Rhodes iOS Client](/rhoconnect/push-client-setup-ios).
 
-Enable push in your rhodes application in build.yml.
+## Configuring a Rhodes Application for RhoConnect Push
+
+If you want your device to vibrate when it receives a push message, enable vibration in your Rhodes/RhoElements application in build.yml.
 
 	:::yaml
 	capabilities:
-	  - push
 	  - vibrate #=> if you want to enable vibrate in your push messages
 
-Set up your application [rhoconfig.txt](configuration#run-time-configuration) syncserver to point to your RhoConnect server:
+Set up your application [rhoconfig.txt](/rhodes/configuration#run-time-configuration) syncserver to point to your RhoConnect server:
 
 	syncserver = 'http://<rhoconnect_server_url>/application'
 
@@ -39,6 +43,15 @@ To have your Rhodes app automatically perform the operations listed in the push
       "rho_push"
     end
 
+To get push messages from RhoConnect server, the user must be logged into the RhoConnect server.
+
+In application.rb:
+
+  	:::ruby
+    if SyncEngine::logged_in > 0
+      System.set_push_notification("/app/Settings/your_rhoconnect_callback",'')
+    end
+
 ## Understanding the Rhodes Push Message Payload
 
 From Rhodes 2.0.4 on, the callback push message parameters are in the form of a hash. This hash contains parameters and values for the operation to perform. If the parameter for that operation is not listed, the operation is not performed.
@@ -48,84 +61,68 @@ The hash payload may include the parameters of alert, do_sync, sound, and vibrat
     :::text
     alert=some message here&sound=alert.mp3&vibrate=2000&do_sync=product,customer
 
-To sync all the sources with do_sync, the source name list would specified as 'all' in the ping call, instead of 'product,customer' as in this example.
-
-The sound file should be included in the Rhodes application bundle in the `/public/alerts` folder.
-
-## Setting up the Rhodes Client for iPhone, Android, and Blackberry
-
-To set up your Rhodes client for push, refer to these links for your respective platforms.
-
-* [Setting up iPhone Client for Push](/rhodes/device-caps#iphone-push-setup)
-* [Setting up Android Client for Push](/rhodes/device-caps#android-push-setup)
-* [Setting up Blackberry Client for Push](/rhodes/device-caps#blackberry-push-setup)
-
-## Configuring a Rhodes Application to Receive Push with RhoConnect Push Service
-
-RhoConnect Push Service is a separate process that will run on your machine and broker push messages between your RhoConnect server and registered Android and Windows Mobile/CE devices.
-
-NOTE: You do not perform the setup steps in the Rhodes Device Capabilities chapter when you use the RhoConnect Server Push Service. That setup is for regular RhoConnect push, not for the RhoConnect Server Push Service.
+To sync all the sources with do_sync, the source name list would be specified as 'all' in the ping call, instead of 'product,customer' as in this example.
 
-### Installing the rhoconnect-push-service Runtime Apps
+The Rhodes push payload allows more than one operation in a single message. 
+ 
+There are no required operations. There are default operations - if operation is not specified, no default operation will be performed.
 
-To use the RhoConnect Push Service in your client application, you must install the rhoconnect-push-service runtime app(s) on your mobile device.
+Payload may include following operations which client will perform when it receives the PUSH message:
 
-On the Macintosh, the rhoconnect-push-service runtime apps for Android and for Windows Mobile are located in the Motorola RhoMobile Suite installation package, in a folder called rhoconnect-push-service.
+do_sync - do sync on spec specified sync source; use "all" to sync all sources  
+	:::ruby
+	# one or more sources, or "all" can be specified
+	do_sync = "Product,Customer" 
 
-On Windows, the rhoconnect-push-service runtime apps for Android and for Windows Mobile are located in the Motorola RhoMobile Suite installation, in a directory called rhoconnect-push-service.
+alert - bring app upfront and show specified message
+	:::ruby
+	alert = "Some message"
 
-If you are using an Android device, install `rhoconnect_push_service.apk` to your device.
+vibrate - vibrate for the specified number of milliseconds, up to 25500; if 0 or no duration is specified, it will vibrate for 2500 millisecond.
 
-If you are using a Windows Mobile or CE device, install the following runtime apps on your device.
+To enable vibrate in your rhodes application in build.yml:
 
-* `rhoconnect-push-service.CAB`
-* `NETCFv35.Messages.EN.wm.cab`
-* `NETCFv35.Messages.EN.cab`
-
-### Configuring rhoconfig.txt
-
-In your client application `rhoconfig.txt` file, set the following options to configure your RhoConnect Push Service.
-
-    syncserver = 'http://<hostname>:<port>/application'
-    rhoconnect_push_server = 'http://<hostname>:<port>'
-    rhoconnect_push_appname = 'someappname'
-
-Next, your RhoConnect application should be running on a network that is accessible to your device. For example, you might have your RhoConnect application running on a LAN with IP 192.168.1.10, PORT 9292. Then make sure your device is connected to the same LAN and set up your application rhoconfig.txt syncserver as follows:
-
-Here is an example of setting `rhoconfig.txt` for the RhoConnect Push Service. The URLs used for the RhoConnect Push Service (rhoconnect_push_server) and the RhoConnect server running on the same host.
-
-    syncserver = 'http://192.168.1.10:9292/application'
-  	rhoconnect_push_server = 'http://192.168.1.10:8675'
-  	rhoconnect_push_appname = 'someappname'
-
-### Configuring build.yml
+	capabilities:
+	 - vibrate
+    	  
+Example of vibrate call:
+     
+	vibrate = 2000 #=> duration in milliseconds
 
-When you configure your application `build.yml` file for RhoConnect Server Push Service, you do not add `push` under `capabilities` for RhoConnect Server Push Service. Instead, you add rhoconnect-push to extensions.
+sound - play specified file if media type supported by the phone. iPhone will ignore media-type parameter.
+	:::ruby
+	sound = "hello.mp3"
 
-	extensions: ["rhoconnect-push"]
+The sound file should be included to the application bundle in `/public/alerts` folder.
 
-You can still enable vibrate in `build.yml` capabilities.
+Media type should be either specified explicitly or may be recognized from file extension. Known file extensions are: .mp3 - audio/mpeg; .wav - audio/x-wav.
 
-	capabilities:
-	  - vibrate #=> if you want to enable vibrate in your push messages
+## Handling Push Notifications from a non-RhoConnect Application
 
-### Registering a Push Callback in your Client Application with RhoConnect Server Push Service
+Rhodes applications can also handle PUSH notifications that didn't come from a RhoConnect application. 
 
-To handle a RhoConnect Server Push Service push message from your Rhodes/RhoElements application, you must register callback with the set_push_notification method.
+In this example, we will get the device ID so we can register the device with some push server:
+	:::ruby
+	System.get_property('device_id')
 
-To get push messages from RhoConnect server, the user must be logged into the RhoConnect server.
+Application can set push callback to process any commands from server:
+	:::ruby
+	System.set_push_notification("/app/Settings/push_notify", '')
 
-In application.rb:
+Callback parameters:
 
-  	:::ruby
-    if SyncEngine::logged_in > 0
-      System.set_push_notification("/app/Settings/your_rhoconnect_callback",'')
-    end
+* since Rhodes 2.0.4 : contain push message parameters as hash
+* rhodes  < 2.0.4 : message - contain server push message body
 
-[Understanding the Rhodes Push Message Payload](/rhoconnect/push-client-setup#understanding-the-rhodes-push-message-payload) shows the structure of the hash for the callback push message. You can write the push callback to automatically perform some of the operations in the hash by using "rho_push", as shown in [Registering a Push Callback in the Rhodes Application](/rhoconnect/push-client-setup#registering-a-push-callback-in-the-rhodes-application).
+Callback return:
 
-### Push Callback, Push Payload
+* empty string - do not run Rhodes push command processing
+* "rho_push" - to run rhodes push command processing (for alerts, sounds, etc...)
 
-Refer to [Rhodes Device Capabilities - Push Notifications - Push Callback](/rhodes/device-caps#push-callback) for more information about setting up a push callback.
+Example:
+	:::ruby
+	def push_notify
+	  puts 'push_notify: ' + @params.inspect  
+	  "rho_push"
+	end
 
-Refer to [Rhodes Device Capabilities - Push Notifications - Push Payload](/rhodes/device-caps#push-payload) for more information about setting up the push payload.

data/doc/push-server-setup.txt

@@ -1,7 +1,10 @@
 Setting Up Push on RhoConnect Server
 ===
 
-To set up your RhoConnect server application for delivering push messages, you need to set up the application settings configurations for the operating system of your mobile client.
+To set up your RhoConnect server application for delivering push messages, you need to either:
+
+* set up to deliver push messages in your RhoConnect server application settings for the operating system of your mobile client,
+* or set up the RhoConnect Push Service to broker push messages between your RhoConnect server and your mobile client.
 
 ## Setting up RhoConnect Server Push for iOS
 
@@ -53,8 +56,6 @@ Update `settings/settings.yml` to include your GCM API key:
 	  :licensefile: settings/license.key
 	  :gcm_api_key: your_gcm_api_key_here
 
-Start up your RhoConnect application and setup [push notifications](/rhodes/device-caps#push-notifications) in your Rhodes application.
-
 ## Setting up RhoConnect Server Push for Android (C2DM)
 
 **NOTE: Google has officially deprecated the C2DM service and requires that you now use Google Cloud Messaging (GCM). Please see [Google's announcement](https://developers.google.com/android/c2dm/) for more details. Follow the instructions at [Setting up RhoConnect Server Push for Android (GCM)](/rhoconnect/push-server-setup#setting-up-rhoconnect-server-push-for-android-gcm) to set up your RhoConnect Application for GCM push.**
@@ -75,18 +76,14 @@ For this purpose, you can specify C2DM Google account's username/password combo
 At run-time, the system will use these credentials to obtain the C2DM token and store it in the Redis for the future use.
 Once the token is expired, the system will automatically connect to the Google C2DM service to renew the token.
 
-Alternatively, you can use `:authtoken` setting to specify the pre-defined authentication token. This token MUST be related to the role-based google account registered for your application. See [the rhodes push instructions](/rhodes/device-caps#push-notifications) for more details. To retrieve this token, use sample script [c2dm.rb](http://github.com/rhomobile/rhodes/blob/master/bin/c2dm.rb). Uncomment last two lines and put your google account specific data, then run it. It will print token to stdout.
+Alternatively, you can use `:authtoken` setting to specify the pre-defined authentication token. This token MUST be related to the role-based google account registered for your application. See [the Rhodes client push instructions](/rhoconnect/push-client-setup-android#setting-up-the-rhodes-client-for-android-c2dm) for more details. To retrieve this token, use sample script [c2dm.rb](http://github.com/rhomobile/rhodes/blob/master/bin/c2dm.rb). Uncomment last two lines and put your google account specific data, then run it. It will print token to stdout.
 However, this approach will not allow the server to connect to the C2DM service and renew the token once it is expired.
 
 For those who interested in what this token means, the description is [here](http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html).
 
-Now start up your RhoConnect application and setup [push notifications](/rhodes/device-caps#push-notifications) in your Rhodes application.
-
-## Setting up RhoConnect Server Push Service
-
-**NOTE: This option is still a _beta_ feature.  You may encounter issues using this service.**
+## Setting up RhoConnect Push Service
 
-RhoConnect v3.3 introduces the RhoConnect Push Service (RPS) which supports efficient messaging for both Android and Windows Mobile. This service can be used instead of Google C2DM on Android.
+RhoConnect v3.3 introduces the RhoConnect Push Service (RPS) which supports efficient messaging for both Android and Windows Mobile. This service can be used instead of Google GCM or C2DM on Android.
 
 The typical flow of a message using RPS:
 
@@ -110,7 +107,59 @@ If you are using a Macintosh, go to the [Node.js website](http://nodejs.org/#),
 
 RhoConnect Push Service is a separate process that will run on your machine and broker push messages between your RhoConnect server and registered devices.
 
-First, create a file called "config.json" with the following content:
+Assuming you've installed the latest [RhoMobile Suite](http://www.motorola.com/Business/US-EN/RhoMobile%20Suite/Downloads), start redis by runing the following command:
+
+	:::term
+	$ rhoconnect redis-start
+
+Now start RhoConnect push by running the following command:
+
+	:::term
+	$ rhoconnect-push
+	RhoConnect push server started...
+
+You can also start the server with more verbose logging (see next section for more details):
+
+	:::term
+	$ rhoconnect-push -d 3
+
+Next, make sure you have the following option in your RhoConnect application's `settings/settings.yml` file in the `:development:`, `:production:` and `:test:` sections:
+
+	:::yaml
+	:push_server: http://someappname@localhost:8675/
+
+Where you edit `someappname` to be a shared secret name between your RhoConnect application and your mobile application.
+
+**NOTE: This shared secret name ensures that only your RhoConnect application can send push messages to the RPS instance you started up in the previous step.  Use this shared secret name in your [mobile app's 'rhoconnect_push_appname' setting](/rhoconnect/push-client-setup-rps#configuring-rhoconfigtxt).**
+
+Now setup [push notifications](/rhoconnect/push-client-setup#configuring-a-rhodes-application-to-receive-push-with-rhoconnect-push-service) in your Android or Windows Mobile RhoElements application, then start up your RhoConnect application.
+
+#### Configuring RhoConnect Push
+
+You can control basic settings for RhoConnect push using command line arguments.
+
+	:::term
+	$ rhoconnect-push --help
+
+	Usage: rhoconnect-push [options]
+
+	Available options:
+	  -c, --config FILE           Path to configuration (config.json) file
+	  -d, --debug LEVEL           Specify server debug level: 0 (errors) - 3 (everything)
+	  -e, --rcPort PORT           Specify RhoConnect instance port
+	  -h, --help                  Print this help message
+	  -i, --rcHost HOST           Host for the RhoConnect instance
+	  -k, --keyFile FILE          Path to private SSL keyfile (https only)
+	  -p, --port                  Run the server on this port (defaults to 8675)
+	  -r, --redis REDIS           Redis connection string (i.e. redis://localhost:6379)
+	  -s, --httpSecure            Specify if this server is running over https or http
+	  -t, --timeout TIMEOUT       Time (in ms) before timeout is sent to client
+	  -T, --registrationTimeout   Expiration limit for client registration tokens
+	  -v, --version               Display server version
+
+#### Configuring and Running with config.json Advanced Options
+
+You can also configure more advanced settings in RhoConnect push by creating a config.json file.
 
 	:::json
 	{
@@ -132,6 +181,11 @@ First, create a file called "config.json" with the following content:
 		"debugLevel": "3"
 	}
 
+To start the server using a config.json file, run the following command.
+
+	:::term
+	$ rhoconnect-push -c /path/to/config.json
+
 The JSON file has the following parameters.
 
 * `httpSecure` - Specify whether the push server will be an https or http server (y/n).
@@ -155,33 +209,6 @@ The JSON file has the following parameters.
   * 2 - reserved for future use
   * 3 - print everything
 
-
-Assuming you've installed the latest [RhoMobile Suite](http://www.motorola.com/Business/US-EN/RhoMobile%20Suite/Downloads), start redis.
-
-	:::term
-	$ rhoconnect redis-start
-
-Now start RhoConnect Push by running the following in a command line:
-
-	:::term
-	$ rhoconnect-push -c /path/to/your/config.json
-
-For example:
-
-	:::term
-	$ rhoconnect-push -c C:/dev/config.json
-
-Next, make sure you have the following option in your RhoConnect application's `settings/settings.yml` file in the `:development:`, `:production:` and `:test:` sections:
-
-	:::yaml
-	:push_server: http://someappname@localhost:8675/
-
-Where `someappname` is a shared secret between your RhoConnect application and your mobile application.
-
-**NOTE: This ensures that only your RhoConnect application can send push messages to the RPS instance you started up in the previous step.  Use this in your [mobile app's 'rhoconnect_push_appname' setting](/rhoconnect/push-client-setup#configuring-a-rhodes-application-to-receive-push-with-rhoconnect-push-service). **
-
-Now setup [push notifications](/rhoconnect/push-client-setup#configuring-a-rhodes-application-to-receive-push-with-rhoconnect-push-service) in your Android or Windows Mobile RhoElements application, then start up your RhoConnect application.
-
 ## Testing Push in the RhoConnect Web Console
 
 The [RhoConnect Web Console](/rhoconnect/web-console) includes a utility for testing push to make sure everything is wired up correctly.
@@ -194,13 +221,13 @@ Next, once you've logged into the web console, navigate to the user's page you u
 
 You should see a registered device for this user, for example: "c92e36874bc74f39a8fbd7c1a86f9e0e".  Click on the link for this device and you will see the device attributes:
 
-  	device_type: APPLE
+  device_type: APPLE
 	device_pin:	10fd92abfa8ee48155d9af6e7329086322b323fd0d18fdbd19e92d03c0fef7c8
 	device_port: 100
 	user_id: t
 	app_id:	application
 
-**NOTE: If you don't see all of these attributes, then something is incorrect in your Rhodes application settings. Please verify you followed the [Rhodes application push setup](/rhodes/device-caps#push-notifications).**
+**NOTE: If you don't see all of these attributes, then something is incorrect in your Rhodes application settings. Please verify you followed the [Rhodes application push setup](/rhoconnect/push-client-setup).**
 
 Now that the device is registered, go back to the user page and click 'Ping User'.
 

data/doc/push-testing.txt

@@ -0,0 +1,29 @@
+Testing Push in the RhoConnect Web Console
+===
+
+The [RhoConnect Web Console](/rhoconnect/web-console) includes a utility for testing push to make sure everything is wired up correctly.
+
+First, make sure you've logged in and performed a sync on the device/simulator you are going to test.
+
+Next, once you've logged into the web console, navigate to the user's page you used to login in the Rhodes application. For example, if you logged in as user 't', the url would be:
+
+	http://localhost:9292/console/user?user_id=t
+
+You should see a registered device for this user, for example: "c92e36874bc74f39a8fbd7c1a86f9e0e".  Click on the link for this device and you will see the device attributes:
+
+  device_type: APPLE
+	device_pin:	10fd92abfa8ee48155d9af6e7329086322b323fd0d18fdbd19e92d03c0fef7c8
+	device_port: 100
+	user_id: t
+	app_id:	application
+
+**NOTE: If you don't see all of these attributes, then something is incorrect in your Rhodes application settings. Please verify you followed the [Rhodes application push setup](/rhoconnect/push-client-setup).**
+
+Now that the device is registered, go back to the user page and click 'Ping User'.
+
+Here you can specify an alert message, sources array to sync, badge value (iOS only), sound file to play, and duration to vibrate.
+
+Enter in some values or try the defaults, you should see a push message on the device when you click "Ping!".
+
+By default, the sources list will be a comma-separated list of your RhoConnect application's sources. This sources list will be sent in the push message to trigger a sync. You can specify one or more sources, or 'all' to trigger a sync of all sources.
+

data/doc/push.txt

@@ -3,12 +3,27 @@ Push Synchronization
 
 Use push synchronization when you want to automatically detect changes on the RhoConnect side, and you want to push those changes to your client without having to tell your client to sync.
 
-RhoConnect has a simple ruby API for sending push notifications (a ping call) to a user's devices. This API can be called directly, queued as a resque job, or called remotely via the [RhoConnect REST API](/rhoconnect/rest-api). The push message can trigger the following actions in the rhodes application: alert with a message, sync one or more sources, vibrate, display a badge, and play a sound file.
+RhoConnect has a simple ruby API for sending push notifications (a ping call) to a user's devices. This API can be called directly, queued as a resque job, or called remotely via the [RhoConnect REST API](/rhoconnect/rest-api). The push message can trigger the following actions in the Rhodes application: alert with a message, sync one or more sources, vibrate, display a badge, and play a sound file.
 
-The following sections show how to use the RhoConnect application to deliver push messages on each platform and how you can handle the push notification in your Rhodes application.
+The following sections show how to use the RhoConnect application to deliver push messages to each client platform and how you can handle the push notification in your Rhodes application.
+
+## Setting up Server and Client
+
+You will need to perform one of the following set of instructions on the RhoConnect server and your mobile device for your specific platform.
+
+* [Set up RhoConnect Push Service on client and server](/rhoconnect/push-client-setup-rps).
+* [Set up RhoConnect Push on client and server for Rhodes Android Client](/rhoconnect/push-client-setup-android).
+* [Set up RhoConnect Push on client and server for Rhodes Blackberry Client](/rhoconnect/push-client-setup-bb).
+* [Set up RhoConnect Push on client and server for Rhodes iOS Client](/rhoconnect/push-client-setup-ios).
+
+Then you will need to [perform the final set up on your client](/rhoconnect/push-client-setup).
+
+## Executing a Ping Call
+
+RhoConnect has a simple ruby API for sending push notifications (a ping call) to a user's devices. You can [execute a ping call from your RhoConnect source adapter or from your backend application that uses a RhoConnect plugin](/rhoconnect/push-backend-setup).
+
+## Testing Push
+
+You can [test push from the RhoConnect console](/rhoconnect/push-testing).
 
-You will need to perform the following tasks.
 
-* [Set up the configuration settings in the RhoConnect application](/rhoconnect/push-server-setup) for your mobile client operating system.
-* [Execute a ping call](/rhoconnect/push-backend-setup) from your RhoConnect source adapter or from your backend application that uses a RhoConnect plugin.
-* [Set up push notification support](/rhoconnect/push-client-setup) -- receiving push notifications from the RhoConnect server/backend -- on your Android, Blackberry, or iPhone client application.