Browse files

Updated readme and added license

  • Loading branch information...
1 parent 4b3695b commit ecacba4513d1bfcb3ed45cbeda161b9fde3ade61 @matterkkila committed May 1, 2011
Showing with 85 additions and 1 deletion.
  1. +19 −0 LICENSE
  2. +66 −1 README.mkd
View
19 LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2011 Matt Erkkila
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
View
67 README.mkd
@@ -1 +1,66 @@
-A kestrel web ui.
+kestrelweb
+==========
+
+A kestrel web ui.
+
+Uses gunicorn + gevent for front end serving. Also uses gevent to make async requests to the kestrel servers for stats. It's still in early development so actual production deployment isn't supported yet.
+
+https://github.com/matterkkila/kestrelweb
+
+
+Dependencies:
+
+ * gevent
+ * gunicorn
+ * pykestrel
+ * dream - https://github.com/matterkkila/dream
+
+Note: All are available on pypi except for the dream library.
+
+
+Prerequisites
+-------------
+
+ * Python 2.7+
+ * virtualenv (not really required, but it's a good idea)
+
+
+Installing
+----------
+
+ git clone https://matterkkila@github.com/matterkkila/kestrelweb.git
+ cd kestrelweb
+ virtualenv --no-site-packages .
+ . bin/activate
+ pip install gevent
+ pip install gunicorn
+ pip install pykestrel
+ pip install https://github.com/matterkkila/dream/tarball/master
+ python ./setup.py develop
+
+
+Configuring
+-----------
+
+Edit the templates/index.html and change the server input to point to your kestrel servers.
+
+Format: server:port,server:port,...
+
+
+Running
+-------
+
+ gunicorn -k gevent -w 2 kestrelweb.main:App
+
+
+Filtering
+---------
+
+You can filter the queue list on any field.
+
+Example:
+
+ * queue=my_queue - Will filter the queues by name that start with my_queue
+ * server=10.0.10 - Will filter the queues by servers that start with 10.0.10
+
+Note: The filter is passed directly to the python re.match() function, so more complex patterns are supported.

0 comments on commit ecacba4

Please sign in to comment.