reiseburo
/
offtopic
mirror of https://github.com/reiseburo/offtopic
1
0
Fork 0
Code Issues Releases Wiki Activity

Document the usage a bit more 

Fixes #17
This commit is contained in:
R. Tyler Croy 2015-09-03 08:51:50 -07:00
parent ce16d50c9f
commit cf98dd2717
No known key found for this signature in database
GPG Key ID: 1426C7DC3F51E16F
2 changed files with 38 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.adoc
View File

@ -26,3 +26,40 @@ image:http://strongspace.com/rtyler/public/offtopic-0.2.0-topicwatch.png['Watchi
watch at once (link:http://strongspace.com/rtyler/public/offtopic-usemultipass-20141125.png[screenshot of multipass in action])
* **Binary data support**: Clicking on a message row in the "watch" view will
drop down a base64-encoded version of the message data
== Usage Notes
As of `0.3.0` Offtopic is available as a wholly self-contained executable `.jar`
file which means running the command below will start Offtopic on link:http://localhost:5050/[localhost:5050]:
✗ java -jar offtopic*-all.jar
log4j:WARN No appenders could be found for logger (io.netty.util.internal.logging.InternalLoggerFactory).
log4j:WARN Please initialize the log4j system properly.
log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.
By default Offtopic looks for a Zookeeper on `localhost:2181`, if you wish to
connect it to another Zookeeper ensemble, use the `zookeeper` Java property,
e.g.:
✗ java -Dzookeepers=example.com:2181 -jar offtopic*-all.jar
log4j:WARN No appenders could be found for logger (io.netty.util.internal.logging.InternalLoggerFactory).
log4j:WARN Please initialize the log4j system properly.
log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.
=== Topic Watch Wildcards
A somewhat "hidden" feature is the ability to use regular expression when
watching topics. A normal topic watch URL might be
`localhost:5050/topics/foo/watch`. If there are a number of topics which are
all prefixed with `foo` you can watch them all at the same time with:
link:http://localhost:5050/topics/foo*/watch[localhost:5050/topics/foo*/watch].
The regular expressions that
link:http://www.groovy-lang.org/Regular+Expressions[Groovy supports] should all
be supported in the URL space.

2
build.gradle
View File

@ -20,7 +20,7 @@ apply plugin: 'io.ratpack.ratpack-groovy'
apply plugin: 'com.github.johnrengelman.shadow'
////////////////////////////////////////////////////////////////////////////////
version = '0.2.0'
version = '0.3.0'
group = 'offtopic'
description =' Offtopic is a simple web application built with Ratpack for inspecting and consuming events from Kafka.'