rSIGNAL Files

rSIGNAL - ruby Simple Inter-Interface Generic Aggregation Layer
===============================================================

Please see also LICENSE.txt! This is GPLv3-Software!

Installation Notes
------------------

1. install Ruby, see http://www.ruby-lang.org 
   (on Windows the Ruby Installer is a good choice)
   
2. make sure Ruby is installed with gem package manager
   (default with Ruby Installer)
   
3. install following gems:
     - dbi
     - sqlite3-ruby
     - dbd-sqlite3

   you can do this by entrying following on the command prompt:
   gem install --remote dbi sqlite3-ruby dbd-sqlite3
   
4. unpack rSIGNAL where ever you like on your (server) hard disk

5. start rSIGNAL from command prompt

6. if you wish to run rSIGNAL as a http server on windows it may
   help to (because there's yet no windows service available) to
   define a Scheduler Task using the .bat file, Start Time: when
   booting, End Time: never
   - This automatically starts rSIGNAL not attached to a session -
   
Usage Notes
-----------

By default rSIGNAL runs as a http server over which you can
control rSIGNAL... it uses URLs to take commands and prints
out messages to the browser in plain text (which is pretty
enough).
Also by default the controlling commands are password protected.

Short Reference:
	http://<servername>/
		- show current status of rSIGNAL
	
	http://<servername>/stop
		- stops the server completely
	
	http://<servername>/restart
		- restarts the server, forcing the whole source code
		  to reload
	
	http://<servername>/restart/config
		- just reloads the config (also loading added
		  config files since the last restart/reload)
		  this is useful when you added a new data source
		  at runtime
		  
	http://<servername>/restart/modules
		- just reloads the modules (also loading added
		  module files since the last restart/reload)
		  this is useful when you added a connector
		  or transformer at runtime
		  
	http://<servername>/restart/bin
		- just reloads the (libraries, ) modules and config
		
	http://<servername>/pull
		- pulls all new data from ALL data sources!
		  (and pushes all to default location)
		
	http://<servername>/pull/<source_id>
		- pulls all new data from given source id
		  (and pushes to default location)
		
	http://<servername>/pull/<source_id>?push_result
		- pulls all new data from given source id
		  pushing to default location and directly
		  to the http client
		
	http://<servername>/<source_id>
		- pushes given data source directly out to the http
		  client in default output format
		
	http://<servername>/<source_id>/<format_module>
		- pushes given data source directly out to the http
		  client formated by the given format module
		  (if format module is not defined by data source
		  definition, the defaul transformer is used)
		  
	adding a ?mime=<mime_type> forces output to use the given
	
	Standard Username and Password for controlling functions can
	be seen in the commented /config/rSIGNAL_config.rb
	
	
Version Log
-----------

v1.02
~~~~~
- initial release to public