rhoconnect 3.3.6 → 3.4.2

data/commands/utilities/utilities.rb

@@ -0,0 +1,6 @@
+module Utilities
+  def dtach_installed?
+    return false if windows? # dtach n/a on Windows
+    `which dtach` != ''
+  end
+end

data/doc/benchmarks.txt

@@ -146,7 +146,7 @@ sudo chown -R www-data:www-data blobapp/
 
 Edit <b>Nginx</b> configuration file, set server_name and root properties to public DNS server name 
 and bench application public folder respectively. After restarting server make sure that bench application is
-running by visiting its web concole, i.e. : 
+running by visiting its web console, i.e. : 
 <pre>
 http://server_dns_public_name/console/ 
 </pre>
@@ -164,7 +164,7 @@ Edit rhoconnect/bench/benchapp/settings/settings.yml and set redis and syncserve
 
 Do the same for blobapp settings.yml file.
 
-Then from rhoconnect/becnh directory execute run_cud_script.sh and run_blob_script.sh scripts respectively.
+Then from rhoconnect/bench directory execute run_cud_script.sh and run_blob_script.sh scripts respectively.
 
 ## Multi-core Amazon EC2 server environments
 

data/doc/bulk-sync.txt

@@ -1,6 +1,6 @@
 Bulk Sync
 ===
-During the initial sync process in your applcation, you may need to deliver a large number of objects. This may result in many megabytes of data being sent to the device. In this case, incremental synchronization may take a while to complete since it uses JSON as the wire format. To significantly speed up this process you may use RhoConnect's "bulk sync" feature. 
+During the initial sync process in your application, you may need to deliver a large number of objects. This may result in many megabytes of data being sent to the device. In this case, incremental synchronization may take a while to complete since it uses JSON as the wire format. To significantly speed up this process you may use RhoConnect's "bulk sync" feature. 
 
 ## Bulk Sync Process
 
@@ -14,6 +14,8 @@ If and when the Rhodes application issues a request to get bulk data, the RhoCon
  
 * The Rhodes application will poll RhoConnect for the bulk sync job to finish. Once the job is finished, the files are generated and Rhodes will download and install them to the device. 
 
+* After bulk database is installed, Rhodes application will analyze sources for references to remote blob objects. Each remote blob object will be downloaded to device, and if download is successful, remote references will be updated to local ones.
+
 **NOTE: Be cautious using this in your application - any previous set of objects on the device will be replaced with the latest set from the backend service.**
 
 Once the bulk data sync process is complete for a source, you may continue to synchronize sources using the default incremental sync process. However, the default sync process may be disabled for a source by setting its `sync_type` to 'bulk_sync_only'.  This will save space in your redis database if you don't plan on using incremental sync for this source.
@@ -145,3 +147,12 @@ An example schema method is as follows:
     
 **NOTE: Key `version` is mandatory and should be always defined in schema method. You need update `version` value only in the case of schema changes.**
 
+## Select which models to bulk sync.
+
+Bulk sync process will only sync sources which sync type is not ‘none’. You may exclude model data from bulk sync with following code in your Rhodes application:
+
+	:::ruby
+	Rho::RHO.get_user_db().update_into_table('sources',{'sync_type'=>'none'}, {'name'=> "MySourceName" })
+
+Set sync type to 'incremental' or 'bulk' when you want to get model data with bulk sync.
+

data/doc/client-java.txt

@@ -71,13 +71,13 @@ These can be build from <rhodes>/rhoconnect-client directory with next command
 	    // Handle login event
 	}
 
-Note: RhoConnect callbacks (like passed to RhoConnectClient.loginWithUserAsync methodin axample above) may and most possibly will be called from another thread. It is up to application developer to care about synchronizing or forwarding call to an appropriate thread like GUI thread or Service thread. 
+Note: RhoConnect callbacks (like passed to RhoConnectClient.loginWithUserAsync method in example above) may and most possibly will be called from another thread. It is up to application developer to care about synchronizing or forwarding call to an appropriate thread like GUI thread or Service thread. 
 
 ## Object Model
 
 ### Intro
 
-RhoConnect Client Android Java API resides at com.rhomobile.rhoconnect pakage. It contains two main classes: RhoConnectClient and RhomModel. The package also contains two classes which represent results of call to the API. These are RhoConnectNotify and RhoConnectObjectNotify.
+RhoConnect Client Android Java API resides at com.rhomobile.rhoconnect package. It contains two main classes: RhoConnectClient and RhomModel. The package also contains two classes which represent results of call to the API. These are RhoConnectNotify and RhoConnectObjectNotify.
 Also several utility classes from com.rhomobile.rhodes package can be used. These are RhoConf, RhoLogConf, Logger.
 
 ### RhoConnectClient
@@ -85,7 +85,7 @@ Also several utility classes from com.rhomobile.rhodes package can be used. Thes
 	:::cplusplus
     package com.rhomobile.rhoconnect;
     public class RhoConnectClient{
-        /// Call this method before create and use the client. It sets up directory structure and makes nessesary native library initialization.
+        /// Call this method before create and use the client. It sets up directory structure and makes necessary native library initialization.
     	public static native void nativeInit();
         /// Creates instance of RhoConnectClient singlethon (yes, it's only one instance of RhoConnectClient allowed).
 	    public RhoConnectClient();

data/doc/client-objc.txt

@@ -562,7 +562,7 @@ Instance method. Returns a RhoConnectNotify object after running a sync on all t
 
 ### <a id="is_syncing">is_syncing
 
-Instance method. Returns TRUE if syncronization is in progress
+Instance method. Returns TRUE if synchronization is in progress
 
 	:::cplusplus
 	- (BOOL) is_syncing;

data/doc/client.txt

@@ -63,7 +63,7 @@ Rhoconnect Client is a library to add sync data capability to your applications.
 	- (RhoConnectNotify*) loginWithUser: (NSString*) user pwd:(NSString*) pwd;
 
 	//login to rhoconnect server and keep login session in database and call selector when finish
-	// target is obejct where to call selector, selector calls in thread which make login call
+	// target is object where to call selector, selector calls in thread which make login call
 	- (void) loginWithUser: (NSString*) user pwd:(NSString*) pwd callback:(SEL) callback target:(id)target;
 
 	//set sync notification callback
@@ -232,7 +232,7 @@ To create schema model tables edit database schema file:
 
 * Copy file <rhoconnect-client>/shared/db/res/db/syncdb.schema to your project folder
 
-* Edit file syncdb.schema : add create table statment for each schema model. Note that mandatory object column should be in each table:
+* Edit file syncdb.schema : add create table statement for each schema model. Note that mandatory object column should be in each table:
 
     "object" varchar(255) PRIMARY KEY
 
@@ -464,13 +464,13 @@ These can be build from <rhodes>/rhoconnect-client directory with next command
 	    // Handle login event
 	}
 
-Note: RhoConnect callbacks (like passed to RhoConnectClient.loginWithUserAsync methodin axample above) may and most possibly will be called from another thread. It is up to application developer to care about synchronizing or forwarding call to an appropriate thread like GUI thread or Service thread. 
+Note: RhoConnect callbacks (like passed to RhoConnectClient.loginWithUserAsync method in example above) may and most possibly will be called from another thread. It is up to application developer to care about synchronizing or forwarding call to an appropriate thread like GUI thread or Service thread. 
 
 ### Object Model
 
 #### Intro
 
-RhoConnect Client Android Java API resides at com.rhomobile.rhoconnect pakage. It contains two main classes: RhoConnectClient and RhomModel. The package also contains two classes which represent results of call to the API. These are RhoConnectNotify and RhoConnectObjectNotify.
+RhoConnect Client Android Java API resides at com.rhomobile.rhoconnect package. It contains two main classes: RhoConnectClient and RhomModel. The package also contains two classes which represent results of call to the API. These are RhoConnectNotify and RhoConnectObjectNotify.
 Also several utility classes from com.rhomobile.rhodes package can be used. These are RhoConf, RhoLogConf, Logger.
 
 #### RhoConnectClient
@@ -478,7 +478,7 @@ Also several utility classes from com.rhomobile.rhodes package can be used. Thes
 	:::cplusplus
     package com.rhomobile.rhoconnect;
     public class RhoConnectClient{
-        /// Call this method before create and use the client. It sets up directory structure and makes nessesary native library initialization.
+        /// Call this method before create and use the client. It sets up directory structure and makes necessary native library initialization.
     	public static native void nativeInit();
         /// Creates instance of RhoConnectClient singlethon (yes, it's only one instance of RhoConnectClient allowed).
 	    public RhoConnectClient();

data/doc/command-line.txt

@@ -57,39 +57,72 @@ After generating the application, you might be asked to change directories to yo
 	$ cd storeserver
 	$ bundle install
 
-## Rake Tasks (Rhoconnect v.3.1 and lower)
-<span class="label label-important">As of version 4.0 of rhoconnect rake tasks will be deprecated!!</span> 
+## Rhoconnect Command Line Interface
 
-Each RhoConnect application uses [rake](https://github.com/jimweirich/rake) to manage development tasks such as starting/stopping the app, starting resque workers, and running specs.
+In rhoconnect versions 3.2 and higher, a ruby utility called [thor](https://github.com/wycats/thor) routes all rake-like tasks through a custom command-line interface. All tasks are used via the rhoconnect gem's command line interface.
 
-To run a RhoConnect rake task, simply type `rake the-task-to-run` in your RhoConnect application's root directory.
+To issue commands this way, type `rhoconnect` followed by the task you wish to perform. To see a list of all the tasks you can issue with
+rhoconnect, type `rhoconnect` or `rhoconnect help`.
+
+	:::term
+	$ rhoconnect help
+	Tasks:
+	  rhoconnect app NAME               # Generates a new rhoconnect application.
+	  rhoconnect attach                 # Attach to rhoconnect console
+	  rhoconnect clean-start            # Clean rhoconnect, get token, and create new user
+	  rhoconnect create-user            # Creates and subscribes user for application in rhoconnect
+	  rhoconnect delete-device          # Deletes a device from rhoconnect
+	  rhoconnect delete-user            # Deletes a user from rhoconnect
+	  rhoconnect dtach-about            # About dtach
+	  rhoconnect dtach-install          # Install dtach 0.8 from source
+	  rhoconnect flushdb                # Flush data store - WARNING: THIS REMOVES ALL DATA IN RHOCONNECT
+	  rhoconnect get-token              # Fetches current api token from rhoconnect
+	  rhoconnect help [TASK]            # Describe available tasks or one specific task
+	  rhoconnect redis-about            # About redis
+	  rhoconnect redis-attach           # Attach to redis dtach socket
+	  rhoconnect redis-download         # Download redis package
+	  rhoconnect redis-install          # Install the latest version of Redis from Github (requires git, duh)
+	  rhoconnect redis-restart          # Restart redis
+	  rhoconnect redis-start            # Start redis
+	  rhoconnect redis-stop             # Stop redis
+	  rhoconnect reset                  # Reset the rhoconnect database (you will need to run rhoconnect:get_token afterwards)
+	  rhoconnect reset-refresh          # Reset source refresh time
+	  rhoconnect restart                # Alias for `rhoconnect stop; rhoconnect start`
+	  rhoconnect secret                 # Generate a cryptographically secure secret session key
+	  rhoconnect set-admin-password     # Sets the admin password
+	  rhoconnect source NAME            # Generates a new source adapter.
+	  rhoconnect spec                   # Run source adapter specs
+	  rhoconnect start                  # Start rhoconnect server
+	  rhoconnect stop                   # Stop rhoconnect server
+	  rhoconnect war                    # Build executable WAR file to be used in Java App Servers
+	  rhoconnect web                    # Launch the web console in a browser - uses :syncserver: in settings.yml
 
 ### Installing DTach (Mac OS / Linux only)
 
-If you're using MacOS / Linux, install [dtach](http://dtach.sourceforge.net/) on your path before running any of the rake tasks.  [DTach](http://dtach.sourceforge.net/) is a simple utility which runs processes in a detached state so you can re-attach your console later.
+If you're using MacOS / Linux, install [dtach](http://dtach.sourceforge.net/) on your path before running any of the rhoconnect tasks.  [DTach](http://dtach.sourceforge.net/) is a simple utility which runs processes in a detached state so you can re-attach your console later.
 
 	:::term
 	$ cd storeserver
-	$ [sudo] rake dtach:install
+	$ rhoconnect dtach-install
 
 ### Setup Redis
 
 Next, you will need to setup and start a [redis](http://redis.io/) server:
 
 	:::term
-	$ [sudo] rake redis:install
-	$ rake redis:start
+	$ rhoconnect redis-install
+	$ rhoconnect redis-start
 
 The server will show that it is running on the console.
 
 ### Start the Application
 
-Open a new console window (since the redis server is running in the previous console window). Then change directories to your rhoconnect applciation and start the application.
+Open a new console window (since the redis server is running in the previous console window). Then change directories to your rhoconnect application and start the application.
 
 	:::term
 	$ cd storeserver
-	$ rake rhoconnect:start
-	
+	$ rhoconnect start
+
 If everything went well, you should see the following in your console:
 
 	[05:47:10 PM 2011-04-19] Rhoconnect Server v3.0.0 started...
@@ -97,7 +130,7 @@ If everything went well, you should see the following in your console:
 To open the web console, navigate to [http://localhost:9292/](http://localhost:9292) in your browser or run:
 
 	:::term
-	$ rake rhoconnect:web
+	$ rhoconnect web
 	
 ### Creating executable WAR containers (JRuby environment only)
 
@@ -106,49 +139,63 @@ Java App Servers (for example, JBoss). To create the executable WAR container, e
 	
 	:::term
 	$ cd storeserver
-	$ rake rhoconnect:war
+	$ rhoconnect war
 	
 This will build the WAR file named <your_app>.war that can be deployed into the Java App Server.
 
-
 ### Common Tasks
 
-RhoConnect applications come with many useful rake tasks for administrative and development workflows.  Some common ones are:
+RhoConnect applications come with many useful rhoconnect tasks for administrative and development workflows. Some common ones are:
 
-* 	`rake dtach:install` - (Mac OS / Linux only) This will install [dtach](http://dtach.sourceforge.net/) to /usr/local/bin.
+* 	`rhoconnect dtach-install` - (Mac OS / Linux only) This will install [dtach](http://dtach.sourceforge.net/) to /usr/local/bin.
 
-* 	`rake redis:install` - This will install to the system.  On Mac OS / Linux, it will attempt to install in '/usr/local/bin' (on windows, C:\redis-<version>), unless you have specified a REDIS_HOME to use instead. 
+* 	`rhoconnect redis-install` - This will install to the system.  On Mac OS / Linux, it will attempt to install in '/usr/local/bin' (on windows, C:\redis-<version>), unless you have specified a REDIS_HOME to use instead. 
 If you cannot install redis on Linux due to insufficient user permissions, then follows these [instructions](/rhoconnect/install).
 	
-* 	`rake rhoconnect:set_admin_password` - Set the RhoConnect administrator password.  The default password is blank ''.
+* 	`rhoconnect set-admin-password` - Set the RhoConnect administrator password.  The default password is blank ''.
 
-*	`rake rhoconnect:get_token` - Get a RhoConnect API token to use for calling the RhoConnect REST API.
+*	`rhoconnect get-token` - Get a RhoConnect API token to use for calling the RhoConnect REST API.
 		
-**NOTE: On Mac OS / Linux, you need to install dtach (i.e. by running `rake dtach:install`) to run the following tasks: **
+**NOTE: On Mac OS / Linux, you need to install dtach (i.e. by running `rhoconnect dtach-install`) to run the following tasks: **
 
-* 	`rake redis:start` - This will launch a redis server in a new console.
+* 	`rhoconnect redis-start` - This will launch a redis server in a new console.
 	
-* 	`rake redis:stop` - Stop the currently-running redis server.
+* 	`rhoconnect redis-stop` - Stop the currently-running redis server.
 
-*	`rake redis:attach` - (Mac OS / Linux only) Attach to a currently-running redis server.
+*	`rhoconnect redis:attach` - (Mac OS / Linux only) Attach to a currently-running redis server.
 
-* 	`rake rhoconnect:start` - Start the RhoConnect application in a new console.  This requires a running redis server.
+* 	`rhoconnect start` - Start the RhoConnect application in a new console.  This requires a running redis server.
 
-* 	`rake rhoconnect:stop` - Stop the currently-running RhoConnect application.
+* 	`rhoconnect stop` - Stop the currently-running RhoConnect application.
 	
-*	`rake rhoconnect:attach` - (Mac OS / Linux only) Attach to a currently-running RhoConnect application. 
+*	`rhoconnect attach` - (Mac OS / Linux only) Attach to a currently-running RhoConnect application. 
 
-* 	`rake rhoconnect:clean_start` - Useful for development, resets and bootstraps the RhoConnect application with a test user.
+* 	`rhoconnect clean-start` - Useful for development, resets and bootstraps the RhoConnect application with a test user.
 
 Some other useful development tasks:
 
-*	`rake rhoconnect:reset` - Reset the RhoConnect application to the initial state.  This WILL DELETE ALL DATA IN REDIS! So be sure you don't run this in production!
+*	`rhoconnect reset` - Reset the RhoConnect application to the initial state.  This WILL DELETE ALL DATA IN REDIS! So be sure you don't run this in production!
 
-*	`rake rhoconnect:spec` - Run all source adapter specs in spec/sources/.
+*	`rhoconnect spec` - Run all source adapter specs in spec/sources/.
 	
-*	`rake rhoconnect:web` - Open the RhoConnect web console in a browser.
+*	`rhoconnect web` - Open the RhoConnect web console in a browser.
+
+## Generate Source
+
+Connecting to a backend service with RhoConnect requires that you write a small amount of code for the query, create, update and delete operations of your particular enterprise backend. The collection of the code for these operations is called a source. You can create source for your RhoConnect application two ways:
+ 
+ * [RhoConnect source adapter](/rhoconnect/source-adapters): generate a Ruby code source adapter from RhoStudio or from the command line, similar to how you generate a RhoConnect app. This source adapter contains code for the query, create, update and delete operations.
+ 
+ * [RhoConnect plugin](/rhoconnect/plugin-intro): write the source code (the query, create, update and delete operations) into your backend application, and plug a RhoConnect plugin in the application. The plugin is written in the language that matchs your backend application, such as Java or .NET.
+
+## Rake Tasks (Rhoconnect v.3.1 and lower)
+<span class="label label-important">As of version 4.0 of rhoconnect, rake tasks will be deprecated!!</span> 
+
+Each RhoConnect (v.3.1 and lower) application uses [rake](https://github.com/jimweirich/rake) to manage development tasks such as starting/stopping the app, starting resque workers, and running specs.
+
+To run a RhoConnect rake task, simply type `rake the-task-to-run` in your RhoConnect application's root directory.
 
-Here is a complete list of the rake tasks available in a RhoConnect application:
+Here is a complete list of the rake tasks available in a RhoConnect v.3.1 and lower application:
 
 	:::term
 	$ cd storeserver
@@ -159,7 +206,7 @@ Here is a complete list of the rake tasks available in a RhoConnect application:
 	rake redis:about                    # About redis
 	rake redis:attach                   # Attach to redis dtach socket
 	rake redis:download                 # Download package
-	rake redis:install                  # Install the latest verison of Redis from Github (requires git, duh)
+	rake redis:install                  # Install the latest version of Redis from Github (requires git, duh)
 	rake redis:restart                  # Restart redis
 	rake redis:start                    # Start redis
 	rake redis:stop                     # Stop redis
@@ -182,96 +229,7 @@ Here is a complete list of the rake tasks available in a RhoConnect application:
 	rake rhoconnect:war                 # Build executable WAR file to be used in Java App Servers
 	rake rhoconnect:web                 # Launch the web console in a browser - uses :syncserver: in settings.yml
 
-## Rhoconnect CLI (Rhoconnect v.3.2+)
-In rhoconnect versions 3.2 and higher the rake utility has been replaced using a ruby utility called [thor](https://github.com/wycats/thor).  
-Using this utility we are able to route all rake-like tasks through a custom command-line interface.  All tasks now are used via the 
-rhoconnect gem's cli. In doing this we have also combined the app and source generators into the same command making it unnecessary to switch
-from rhoconnect to rake at any point, simply use `rhoconnect` throughout.
-
-To issue commands this way simply type rhoconnect followed by the task you wish to perform.  To see a list of all the tasks you can issue with
-rhoconnect, simply type `rhoconnect` or `rhoconnect help`.
-
-	:::term
-	$ rhoconnect help
-	Tasks:
-	  rhoconnect app NAME               # Generates a new rhoconnect application.
-	  rhoconnect attach                 # Attach to rhoconnect console
-	  rhoconnect clean-start            # Clean rhoconnect, get token, and create new user
-	  rhoconnect create-user            # Creates and subscribes user for application in rhoconnect
-	  rhoconnect delete-device          # Deletes a device from rhoconnect
-	  rhoconnect delete-user            # Deletes a user from rhoconnect
-	  rhoconnect dtach-about            # About dtach
-	  rhoconnect dtach-install          # Install dtach 0.8 from source
-	  rhoconnect flushdb                # Flush data store - WARNING: THIS REMOVES ALL DATA IN RHOCONNECT
-	  rhoconnect get-token              # Fetches current api token from rhoconnect
-	  rhoconnect help [TASK]            # Describe available tasks or one specific task
-	  rhoconnect redis-about            # About redis
-	  rhoconnect redis-attach           # Attach to redis dtach socket
-	  rhoconnect redis-download         # Download redis package
-	  rhoconnect redis-install          # Install the latest verison of Redis from Github (requires git, duh)
-	  rhoconnect redis-restart          # Restart redis
-	  rhoconnect redis-start            # Start redis
-	  rhoconnect redis-stop             # Stop redis
-	  rhoconnect reset                  # Reset the rhoconnect database (you will need to run rhoconnect:get_token afterwards)
-	  rhoconnect reset-refresh          # Reset source refresh time
-	  rhoconnect restart                # Alias for `rhoconnect stop; rhoconnect start`
-	  rhoconnect secret                 # Generate a cryptographically secure secret session key
-	  rhoconnect set-admin-password     # Sets the admin password
-	  rhoconnect source NAME            # Generates a new source adapter.
-	  rhoconnect spec                   # Run source adapter specs
-	  rhoconnect start                  # Start rhoconnect server
-	  rhoconnect stop                   # Stop rhoconnect server
-	  rhoconnect war                    # Build executable WAR file to be used in Java App Servers
-	  rhoconnect web                    # Launch the web console in a browser - uses :syncserver: in settings.yml
-
-### Installing DTach (Mac OS / Linux only)
-
-If you're using MacOS / Linux, install [dtach](http://dtach.sourceforge.net/) on your path before running any of the rake tasks.  [DTach](http://dtach.sourceforge.net/) is a simple utility which runs processes in a detached state so you can re-attach your console later.
-
-	:::term
-	$ cd storeserver
-	$ rhoconnect dtach-install
-
-### Setup Redis
-
-Next, you will need to setup and start a [redis](http://redis.io/) server:
-
-	:::term
-	$ rhoconnect redis-install
-	$ rhoconnect redis-start
-
-The server will show that it is running on the console.
-
-### Start the Application
-
-Open a new console window (since the redis server is running in the previous console window). Then change directories to your rhoconnect applciation and start the application.
-
-	:::term
-	$ cd storeserver
-	$ rhoconnect start
-
-If everything went well, you should see the following in your console:
-
-	[05:47:10 PM 2011-04-19] Rhoconnect Server v3.0.0 started...
-	
-To open the web console, navigate to [http://localhost:9292/](http://localhost:9292) in your browser or run:
-
-	:::term
-	$ rhoconnect web
-	
-### Creating executable WAR containers (JRuby environment only)
-
-It is possible to create Java WAR containers for your Rhoconnect application that can be deployed into the
-Java App Servers (for example, JBoss). To create the executable WAR container, execute the following command in your app's root directory:
-	
-	:::term
-	$ cd storeserver
-	$ rhoconnect war
-	
-This will build the WAR file named <your_app>.war that can be deployed into the Java App Server.
-
-
-Below is provided a list of rake tasks and their corresponding rhoconnect command.
+Below is provided a list of rake tasks and their corresponding RhoConnect v.3.2+ command.
 
 <table border="1", cellpadding="5", width="100%">
 	<tr>
@@ -383,16 +341,3 @@ Below is provided a list of rake tasks and their corresponding rhoconnect comman
 		<td>rhoconnect redis-stop</td>
 	</tr>
 </table>
-
-## Generate Source
-
-Connecting to a backend service with RhoConnect requires that you write a small amount of code for the query, create, update and delete operations of your particular enterprise backend. The collection of the code for these operations is called a source. You can create source for your RhoConnect application two ways:
- 
- * [RhoConnect source adapter](/rhoconnect/source-adapters): generate a Ruby code source adapter from RhoStudio or from the command line, similar to how you generate a RhoConnect app. This source adapter contains code for the query, create, update and delete operations.
- 
- * [RhoConnect plugin](/rhoconnect/plugin-intro): write the source code (the query, create, update and delete operations) into your backend application, and plug a RhoConnect plugin in the application. The plugin is written in the language that matchs your backend application, such as Java or .NET.
-
- 
- 
-
-

data/doc/deploying.txt

@@ -102,19 +102,19 @@ And verify that it's up and running by visiting application web console in your
 ### Configuration of web and application servers
 Installer compiled and configured Nginx as reverse proxy web server (/opt/nginx) with the following settings:
 
-* Nginx start-up script (/etc/init.d/nginx)
+* Nginx start-up script (`/etc/init.d/nginx`)
 
-* Nginx logrotate settings (/etc/logrotate.d/nginx)
+* Nginx logrotate settings (`/etc/logrotate.d/nginx`)
 
-* Nginx configuration file (/opt/nginx/conf/nginx.conf) 
+* Nginx configuration file (`/opt/nginx/conf/nginx.conf`) 
 
-* virtual host template for rhoconnect application (/opt/nginx/conf/conf.d/rhoconnect.conf)
+* virtual host template for rhoconnect application (`/opt/nginx/conf/conf.d/rhoconnect.conf`)
 
 Installer also configured Thin app server with the following configuration files:
 
-* Thin start-up script (/etc/init.d/thin)
+* Thin start-up script (`/etc/init.d/thin`)
 
-* Thin configuration file (/etc/thin/rhoapp.yml)
+* Thin configuration file (`/etc/thin/rhoapp.yml`)
 
 Default setup of Nginx server is to deal with back-end servers (called "upstreams") that are running on UNIX domain sockets:
 
@@ -125,13 +125,15 @@ Default setup of Nginx server is to deal with back-end servers (called "upstream
 	  least_conn;
       server unix:/tmp/thin.0.sock;
       server unix:/tmp/thin.1.sock;
+	  # Add additional copies if need more Thin servers
       #server unix:/tmp/thin.2.sock;
       #server unix:/tmp/thin.3.sock;
     }
     
     server {
       listen      80;
-      root  /opt/nginx/html/rhoapp/public; # <-- be sure to point to 'public' folder of your application!
+      # Be sure to point to 'public' folder of your application!
+      root  /opt/nginx/html/rhoapp/public; 
       # ...
 
     }
@@ -180,7 +182,7 @@ c) Make sure that your app is bundled properly
     
     :::term
     $ cd your_rhoconnect_app
-    $ sudo /opt/rhconnect/bin/bundle install
+    $ sudo /opt/rhoconnect/bin/bundle install
 
 d) Configure Nginx virtual host for your rhoconnect application. For that edit the file 
 `/opt/nginx/conf/conf.d/rhoconnect.conf`, so that it reflects your specifications (root directive)
@@ -189,8 +191,9 @@ d) Configure Nginx virtual host for your rhoconnect application. For that edit t
     # ...
     server {
       listen      80;
-      root  /opt/nginx/html/your_rhoconnect_app/public; # Be sure your app have 'public' folder and root directive 
-                                                        # point to it!
+      # Be sure your app have 'public' folder and root directive 
+      # point to it!
+      root  /opt/nginx/html/your_rhoconnect_app/public;
       # ...
     }
 
@@ -207,18 +210,122 @@ e) Edit Thin `/etc/thin/rhoapp.yml` configuration file directly
     $ env PATH=/opt/rhoconnect/bin:$PATH thin config -C /etc/thin/your_rhoconnect_app.yml \
     -c /opt/nginx/html/your_rhoconnect_app/ \
     --socket /tmp/thin.sock --servers 2 --log /var/log/thin/thin.log \
+    --user nginx --group nginx \
     --pid /var/run/thin/thin.pid -e production
 
 f) As root user restart Nginx, and Thin servers
    
     :::term
-     /etc/init.d/nginx restart
-     /etc/init.d/thin restart
+    /etc/init.d/nginx restart
+    /etc/init.d/thin restart
 
 For monitoring and troubleshooting purposes visit web console of your app and look at log files in `/opt/nginx/logs`.
 
 Also you can use RhoConnect `/opt/nginx/html/rhoapp` application as a template and modify it as you wanted. 
 
+**NOTE: You should pay attentions to situations, if you have already Ruby installed on system level. Avoid usage of system gems in your application. It might lead to unpredictable results, if ruby versions are different. Either set up path to rhoconnect binaries for root user, 
+or install required gems as `sudo /opt/rhoconnect/bin/gem install gem_name`**
+
+## Deploying RhoConnect Redis and Push packages on Linux servers
+
+### RhoConnect Redis
+
+RhoConnect Redis is a packaged Redis server for RhoConnect development and production environment on Linux servers. 
+<b>rhoconnect-redis</b> package might be useful if you want to deploy Redis on separate server. 
+
+The package compiles from sources latest stable Redis release (2.4.15) and installs it to `/opt/rhoconnect` directory with the following settings:
+
+* Redis server configuration file (`/opt/rhoconnect/etc/redis.conf`)
+
+* log files located in `/var/log/redis` directory
+
+* start-up scripts in `/etc/init` and `/etc/init.d` directories
+
+#### Steps for Debian-Based Linux Users
+Add the following line to the end of your /etc/apt/sources.list.
+
+    :::term
+	deb http://rhoconnect-repo.s3.amazonaws.com/packages/deb rhoconnect-repo main
+
+Then update the repo list and install RhoConnect Redis.
+
+	:::term
+	$ sudo apt-get update
+	$ sudo apt-get install rhoconnect-redis
+
+When Redis server is successfully installed, start it using the following command.
+
+	:::term
+	$ sudo start rhoconnect-redis
+
+#### Steps for RedHat-Based Linux Users
+
+Create a file named rhoconnect-repo.repo in the /etc/yum.repos.d/ directory.
+
+	:::term
+	$ sudo nano /etc/yum.repos.d/rhoconnect-repo.repo
+
+Copy and paste these contents into the file.
+
+	:::term
+	[rhoconnect-redis]
+	name=Rhoconnect Redis
+	baseurl=http://rhoconnect-repo.s3.amazonaws.com/packages/rpm
+	enabled=1
+	gpgcheck=0
+
+Once that is done, install the RhoConnect Push service.
+
+	:::term
+	$ sudo yum install rhoconnect-redis
+
+You can start a redis server using the following command.
+
+	:::term
+	$ sudo /etc/init.d/redis start
+
+### RhoConnect Push Service
+You can create a RhoConnect Push production environment on Linux servers by installing prepackaged software for Ubuntu (12.x) and CentOS (6.x). In a few clicks, you will have installed on your Linux server.
+
+* Node.js with Npm package manager
+
+* RhoConnect Push service
+
+* Upstart script to start, stop, and control Push service
+
+#### Steps for Debian-Based Linux Users
+Add the following line to the end of your /etc/apt/sources.list.
+
+	:::term
+	deb http://rhoconnect-repo.s3.amazonaws.com/packages/deb rhoconnect-repo main
+
+Then update the repo list and install RhoConnect Push.
+
+	:::term
+	$ sudo apt-get update
+	$ sudo apt-get install rhoconnect-push
+
+#### Steps for RedHat-Based Linux Users
+Create a file named rhoconnect-repo.repo in the /etc/yum.repos.d/ directory.
+
+	:::term
+	$ sudo nano /etc/yum.repos.d/rhoconnect-repo.repo
+
+Copy and paste the following contents into the file.
+
+	:::term
+	[rhoconnect-push]
+	name=Rhoconnect Push Service
+	baseurl=http://rhoconnect-repo.s3.amazonaws.com/packages/rpm
+	enabled=1
+	gpgcheck=0
+
+Once that is done, install the RhoConnect Push service.
+
+	:::term
+	$ sudo yum install rhoconnect-push
+
+
 ## Deploying into J2EE environment
 In JRuby environment, there is an option to create the WAR container for the RhoConnect app
 and deploy it into the J2EE App Server.