rabbitmq-server/deps/rabbitmq_web_dispatch/README.md

# RabbitMQ Web Dispatch

rabbitmq-web-dispatch is a thin veneer around Cowboy that provides the
ability for multiple applications to co-exist on Cowboy
listeners. Applications can register static document roots or dynamic
handlers to be executed, dispatched by URL path prefix.

See

 * [Management plugin guide](https://www.rabbitmq.com/management.html)
 * [Web STOMP guide](https://www.rabbitmq.com/web-stomp.html)
 * [Web MQTT guide](https://www.rabbitmq.com/web-mqtt.html)

for information on configuring plugins that expose an HTTP or WebSocket interface.
Closes #36 2019-01-16 00:58:32 +08:00			`# RabbitMQ Web Dispatch`
First working version of registering static content 2009-07-13 20:52:53 +08:00
Use Cowboy instead of Webmachine/Mochiweb for Web plugins As part of a push to reduce the number of dependencies from the RabbitMQ project, the management plugin needed to be converted from Webmachine to Cowboy REST. This plugin provides a convenient interface to listeners, which had to be converted from Mochiweb's to Cowboy's also. Because Cowboy does not have any logging built-in we keep Webmachine's access logger for now. It has been adapted to use data coming from Cowboy, as opposed to Mochiweb. The event handler for logging has also been moved to web dispatch. The main breaking change in the interface is that contexts do not take a fun for the main loop anymore, but instead take a dispatch list of the routes to be served by that context. Routes must be compiled using cowboy_router:compile(Routes), and will be served with the context prefix appended. Some contexts do not require any code change, including the static contexts and port redirect contexts. To serve many applications, we use a Cowboy middleware specific to RabbitMQ which, when receiving a request, checks in the registry if there is a matching application, and use its dispatch list for any subsequent operations. 2015-10-02 22:05:33 +08:00			`rabbitmq-web-dispatch is a thin veneer around Cowboy that provides the`
			`ability for multiple applications to co-exist on Cowboy`
Closes #36 2019-01-16 00:58:32 +08:00			`listeners. Applications can register static document roots or dynamic`
Minor corrections 2011-05-13 23:40:10 +08:00			`handlers to be executed, dispatched by URL path prefix.`
First working version of registering static content 2009-07-13 20:52:53 +08:00
Closes #36 2019-01-16 00:58:32 +08:00			`See`
Update README with the new configuration and API 2011-05-12 23:49:54 +08:00
URL Cleanup This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener). # HTTP URLs that Could Not Be Fixed These URLs were unable to be fixed. Please review them to see if they can be manually resolved. * http://blog.listincomprehension.com/search/label/procket (200) with 1 occurrences could not be migrated: ([https](https://blog.listincomprehension.com/search/label/procket) result ClosedChannelException). * http://dozzie.jarowit.net/trac/wiki/TOML (200) with 1 occurrences could not be migrated: ([https](https://dozzie.jarowit.net/trac/wiki/TOML) result SSLHandshakeException). * http://dozzie.jarowit.net/trac/wiki/subproc (200) with 1 occurrences could not be migrated: ([https](https://dozzie.jarowit.net/trac/wiki/subproc) result SSLHandshakeException). * http://e2project.org (200) with 1 occurrences could not be migrated: ([https](https://e2project.org) result AnnotatedConnectException). * http://nitrogenproject.com/ (200) with 2 occurrences could not be migrated: ([https](https://nitrogenproject.com/) result ConnectTimeoutException). * http://proper.softlab.ntua.gr (200) with 1 occurrences could not be migrated: ([https](https://proper.softlab.ntua.gr) result SSLHandshakeException). * http://yaws.hyber.org (200) with 1 occurrences could not be migrated: ([https](https://yaws.hyber.org) result AnnotatedConnectException). * http://choven.ca (503) with 1 occurrences could not be migrated: ([https](https://choven.ca) result ConnectTimeoutException). # Fixed URLs ## Fixed But Review Recommended These URLs were fixed, but the https status was not OK. However, the https status was the same as the http request or http redirected to an https URL, so they were migrated. Your review is recommended. * http://fixprotocol.org/ (301) with 1 occurrences migrated to: https://fixtrading.org ([https](https://fixprotocol.org/) result SSLHandshakeException). * http://erldb.org (UnknownHostException) with 1 occurrences migrated to: https://erldb.org ([https](https://erldb.org) result UnknownHostException). * http://~s:~w/rabbit_web_dispatch_test/index.html (UnknownHostException) with 1 occurrences migrated to: https://~s:~w/rabbit_web_dispatch_test/index.html ([https](https://~s:~w/rabbit_web_dispatch_test/index.html) result UnknownHostException). ## Fixed Success These URLs were switched to an https URL with a 2xx status. While the status was successful, your review is still recommended. * http://cloudi.org/ with 27 occurrences migrated to: https://cloudi.org/ ([https](https://cloudi.org/) result 200). * http://erlware.org/ with 1 occurrences migrated to: https://erlware.org/ ([https](https://erlware.org/) result 200). * http://inaka.github.io/cowboy-trails/ with 1 occurrences migrated to: https://inaka.github.io/cowboy-trails/ ([https](https://inaka.github.io/cowboy-trails/) result 200). * http://ninenines.eu with 6 occurrences migrated to: https://ninenines.eu ([https](https://ninenines.eu) result 200). * http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html with 1 occurrences migrated to: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html ([https](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) result 200). * http://www.actordb.com/ with 2 occurrences migrated to: https://www.actordb.com/ ([https](https://www.actordb.com/) result 200). * http://www.cs.kent.ac.uk/projects/wrangler/Home.html with 1 occurrences migrated to: https://www.cs.kent.ac.uk/projects/wrangler/Home.html ([https](https://www.cs.kent.ac.uk/projects/wrangler/Home.html) result 200). * http://www.rabbitmq.com/management.html with 1 occurrences migrated to: https://www.rabbitmq.com/management.html ([https](https://www.rabbitmq.com/management.html) result 200). * http://www.rabbitmq.com/web-mqtt.html with 1 occurrences migrated to: https://www.rabbitmq.com/web-mqtt.html ([https](https://www.rabbitmq.com/web-mqtt.html) result 200). * http://www.rabbitmq.com/web-stomp.html with 1 occurrences migrated to: https://www.rabbitmq.com/web-stomp.html ([https](https://www.rabbitmq.com/web-stomp.html) result 200). * http://www.rebar3.org with 1 occurrences migrated to: https://www.rebar3.org ([https](https://www.rebar3.org) result 200). * http://contributor-covenant.org with 1 occurrences migrated to: https://contributor-covenant.org ([https](https://contributor-covenant.org) result 301). * http://contributor-covenant.org/version/1/3/0/ with 1 occurrences migrated to: https://contributor-covenant.org/version/1/3/0/ ([https](https://contributor-covenant.org/version/1/3/0/) result 301). * http://inaka.github.com/apns4erl with 1 occurrences migrated to: https://inaka.github.com/apns4erl ([https](https://inaka.github.com/apns4erl) result 301). * http://inaka.github.com/edis/ with 1 occurrences migrated to: https://inaka.github.com/edis/ ([https](https://inaka.github.com/edis/) result 301). * http://lasp-lang.org/ with 1 occurrences migrated to: https://lasp-lang.org/ ([https](https://lasp-lang.org/) result 301). * http://saleyn.github.com/erlexec with 1 occurrences migrated to: https://saleyn.github.com/erlexec ([https](https://saleyn.github.com/erlexec) result 301). * http://www.mozilla.org/MPL/ with 12 occurrences migrated to: https://www.mozilla.org/MPL/ ([https](https://www.mozilla.org/MPL/) result 301). * http://zhongwencool.github.io/observer_cli with 1 occurrences migrated to: https://zhongwencool.github.io/observer_cli ([https](https://zhongwencool.github.io/observer_cli) result 301). # Ignored These URLs were intentionally ignored. * http://127.0.0.1 with 1 occurrences * http://www.w3.org/1999/xhtml with 1 occurrences 2019-03-20 16:25:25 +08:00			`* [Management plugin guide](https://www.rabbitmq.com/management.html)`
			`* [Web STOMP guide](https://www.rabbitmq.com/web-stomp.html)`
			`* [Web MQTT guide](https://www.rabbitmq.com/web-mqtt.html)`
Update README with the new configuration and API 2011-05-12 23:49:54 +08:00
Closes #36 2019-01-16 00:58:32 +08:00			`for information on configuring plugins that expose an HTTP or WebSocket interface.`