Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

new README

  • Loading branch information...
commit e56983e6663bb681ea867389276e09415758d53a 1 parent b9190f0
@videlalvaro authored
Showing with 47 additions and 0 deletions.
  1. +47 −0 README.md
View
47 README.md
@@ -0,0 +1,47 @@
+# RabbitMQ Websockets Plugin #
+
+This plugin exposes a Websockets for RabbitMQ.
+
+The user connects to the host where RabbitMQ is running, using default port `8080`.
+
+The user can use a form to submit to which `exchange` wants to receive messages and can provide an optional `routing_key`.
+
+The plugin will attach a consumer to the provided exchange and will start sending messages to the connected websocket processes.
+
+Depending on the `type` of the exchange will be the behavior seen browser side.
+
+## Installation ##
+
+Get the `rabbitmq-public-umbrella`
+
+ $ hg clone http://hg.rabbitmq.com/rabbitmq-public-umbrella
+ $ cd rabbitmq-public-umbrella
+ $ make co
+
+Get the [misultin_wrapper](https://github.com/videlalvaro/misultin_wrapper) to support Websockets:
+
+ $ git clone git://github.com/videlalvaro/misultin_wrapper.git
+
+Clone this repository:
+
+ $ git clone git://github.com/videlalvaro/rabbitmq-websockets.git
+
+Once you have the code you can move into the `rabbitmq-websockets` and test the plugin with the broker:
+
+ $ make run-in-broker
+
+If you want to install the plugin in the broker then copy the `*.ez` files inside the `dist` folder to your broker `plugins` folder.
+
+## Usage ##
+
+Point your browser to [http://localhost:8080](http://localhost:8080) and then submit the name of an __existing exchange__. The routing key is optional and depends on how you publish messages to that exchange.
+
+You can publish test messages by calling the following helper function inside the Erlang REPL:
+
+ rabbit_websockets_util:publish_msg(Exchange, Msg, RKey).
+
+All three parameters are binaries.
+
+## License ##
+
+See LICENSE.md
Please sign in to comment.
Something went wrong with that request. Please try again.