README.rdoc in wackamole-0.0.1 vs README.rdoc in wackamole-0.0.2
- old
+ new
@@ -1,34 +1,30 @@
== Wackamole
Observe your web applications in the wild!
== DESCRIPTION:
-This is a companion sinatra app for the Rackamole framework which provides for recording
-interactions with your rack applications. Wackamole allows you to view, filter and drilldown
-on the collected moled information, hence allowing you to observe your
-applications live in the wild...
+ This is a companion sinatra app for the Rackamole framework which provides for recording
+ interactions with your rack applications. Wackamole allows you to view, filter and drilldown
+ on the collected moled information, hence allowing you to observe your
+ applications live in the wild...
== PROJECT INFORMATION
-* Developer: Fernand Galiana
-* Site: http://www.rackamole.com
-* Twitter: http://twitter.com/rackamole
-* Forum: http://groups.google.com/group/rackamole
-* Git: git://github.com/derailed/wackamole.git
+ Developer: Fernand Galiana
+ Site: http://www.rackamole.com
+ Twitter: http://twitter.com/rackamole
+ Forum: http://groups.google.com/group/rackamole
+ Git: git://github.com/derailed/wackamole.git
== FEATURES
-* Self bundled sinatra app
-* View daily activity
-* Search and filter on any info collected by the mole
-* Reports performance and exceptions that might occur in your applications
+ o Self bundled sinatra app ( NEW !)
+ o View daily activity
+ o Search and filter on any info collected by the mole
+ o Reports performance and exceptions that might occur in your applications
-== ROAD MAP
-
- Rewrite as sinatra gem - done
-
== DEPENDENCIES
mongo + mongo-ext
sinatra
agnostic-will_paginate
@@ -66,11 +62,31 @@
=== Launch It!
Watch your creation live!
+ NOTE: By default wackamole uses mongo_rack for storing its session information.
+ This assumes that you have a local mongoDB instance running on the default port 27017.
+
+ > wackamole
+
+ Alternatively you can use a different mongo instance to store wackamole session information
+ or use memcache by specifying the --pool options as follows:
+
+ To use the mongo session store on localhost at port 27030 with db name 'wackamole' and collection named 'sessions'
+
+ > wackamole --pool "mongo://localhost:27030/wackamole/sessions"
+
+ To use memcache session store on localhost at port 11233 with namespace 'wackamole'
+
+ > wackamole --pool "memcache://localhost:11233/wackamole"
+
+ The pool options assumes the following format:
+
+ --pool {mongo|memcache}://{host}:{port}/{db_name|namespace}/{cltn_name}
+
Please checkout the forum and send us feedback and issues. This is still work in progress so your
- feedback will be very much appreciated!
+ feedback is very important and will be very much appreciated!
== LICENSE:
Copyright 2009-2010 LiquidRail LLC
\ No newline at end of file