Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

new README

  • Loading branch information...
commit e56983e6663bb681ea867389276e09415758d53a 1 parent b9190f0
Alvaro Videla authored

Showing 1 changed file with 47 additions and 0 deletions. Show diff stats Hide diff stats

  1. 47  README.md
47  README.md
Source Rendered
... ...
@@ -0,0 +1,47 @@
  1
+# RabbitMQ Websockets Plugin #
  2
+
  3
+This plugin exposes a Websockets for RabbitMQ.
  4
+
  5
+The user connects to the host where RabbitMQ is running, using default port `8080`.
  6
+
  7
+The user can use a form to submit to which `exchange` wants to receive messages and can provide an optional `routing_key`.
  8
+
  9
+The plugin will attach a consumer to the provided exchange and will start sending messages to the connected websocket processes.
  10
+
  11
+Depending on the `type` of the exchange will be the behavior seen browser side.
  12
+
  13
+## Installation ##
  14
+
  15
+Get the `rabbitmq-public-umbrella`
  16
+
  17
+    $ hg clone http://hg.rabbitmq.com/rabbitmq-public-umbrella
  18
+    $ cd rabbitmq-public-umbrella
  19
+    $ make co
  20
+
  21
+Get the [misultin_wrapper](https://github.com/videlalvaro/misultin_wrapper) to support Websockets:
  22
+
  23
+    $ git clone git://github.com/videlalvaro/misultin_wrapper.git
  24
+
  25
+Clone this repository:
  26
+
  27
+    $ git clone git://github.com/videlalvaro/rabbitmq-websockets.git
  28
+
  29
+Once you have the code you can move into the `rabbitmq-websockets` and test the plugin with the broker:
  30
+
  31
+    $ make run-in-broker
  32
+
  33
+If you want to install the plugin in the broker then copy the `*.ez` files inside the `dist` folder to your broker `plugins` folder.
  34
+
  35
+## Usage ##
  36
+
  37
+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.
  38
+
  39
+You can publish test messages by calling the following helper function inside the Erlang REPL:
  40
+
  41
+    rabbit_websockets_util:publish_msg(Exchange, Msg, RKey).
  42
+
  43
+All three parameters are binaries.
  44
+
  45
+## License ##
  46
+
  47
+See LICENSE.md

0 notes on commit e56983e

Please sign in to comment.
Something went wrong with that request. Please try again.