Repository: qpid-dispatch Updated Branches: refs/heads/master 6464e0a2b -> da6688a53
DISPATCH-399: Fix out-dated console docs in asciidoc conversion. The console chapter of the user guide was converted to asciidoc from out-of-date documentaiton, this has been corrected. Project: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/commit/da6688a5 Tree: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/tree/da6688a5 Diff: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/diff/da6688a5 Branch: refs/heads/master Commit: da6688a53475f80e7ff81adc65484f587efef876 Parents: 6464e0a Author: Alan Conway <[email protected]> Authored: Thu Jun 30 11:37:22 2016 -0400 Committer: Alan Conway <[email protected]> Committed: Thu Jun 30 12:23:41 2016 -0400 ---------------------------------------------------------------------- doc/CMakeLists.txt | 2 +- doc/asciidoc.conf.in | 5 ++++ doc/book/console_installation.adoc | 25 ++++++++++---------- doc/book/console_operation.adoc | 42 ++++++++++----------------------- doc/book/console_overview.adoc | 16 +++---------- doc/book/default_config.adoc | 4 ++-- 6 files changed, 35 insertions(+), 59 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/da6688a5/doc/CMakeLists.txt ---------------------------------------------------------------------- diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index f9a9468..dbe53c6 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -92,7 +92,7 @@ if(BUILD_DOCS) add_custom_command( OUTPUT ${output} COMMAND ${ASCIIDOC_EXE} -b xhtml11 --conf-file=${bin}/asciidoc.conf -o ${output} ${source}.adoc - DEPENDS ${source}.adoc ${GENERATED_TXT} ${ADOC_SRC} + DEPENDS ${source}.adoc ${GENERATED_TXT} ${ADOC_SRC} ${bin}/asciidoc.conf WORKING_DIRECTORY ${src} # Book include links assume we are in source dir. ) list(APPEND DOC_DEPENDS ${output}) http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/da6688a5/doc/asciidoc.conf.in ---------------------------------------------------------------------- diff --git a/doc/asciidoc.conf.in b/doc/asciidoc.conf.in index 9db7110..2786135 100644 --- a/doc/asciidoc.conf.in +++ b/doc/asciidoc.conf.in @@ -2,4 +2,9 @@ SYSCONF_INSTALL_DIR=${SYSCONF_INSTALL_DIR} CMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} QD_DOC_INSTALL_DIR=${QD_DOC_INSTALL_DIR} +QPID_DISPATCH_VERSION=${QPID_DISPATCH_VERSION} + generated=${CMAKE_CURRENT_BINARY_DIR} + +[footer-text] +Qpid Dispatch ${QPID_DISPATCH_VERSION} - generated {localdate} {localtime} http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/da6688a5/doc/book/console_installation.adoc ---------------------------------------------------------------------- diff --git a/doc/book/console_installation.adoc b/doc/book/console_installation.adoc index e23bbb8..cda9f18 100644 --- a/doc/book/console_installation.adoc +++ b/doc/book/console_installation.adoc @@ -29,40 +29,39 @@ The following need to be installed before running a console: * One or more dispatch routers. See the documentation for the dispatch router for help in starting a router network. -* node.js This is needed to provide a proxy between the console's -websocket traffic and tcp. +* A websockets to tcp proxy. * A web server. This can be any server capable of serving static html/js/css/image files. -A nodejs proxy is distributed with proton. To start the proton's nodejs -proxy: +To install a websockets to tcp proxy: -------------------------------------------------- -cd ~/rh-qpid-proton/examples/javascript/messenger - node proxy.js & -------------------------------------------------- +---- +sudo dnf install python-websockify +websockify localhost:5673 localhost:5672 +---- This will start the proxy listening to ws traffic on port 5673 and translating it to tcp on port 5672. One of the routers in the network needs to have a listener configured on port 5672. That listener's role should be 'normal'. For example: ----------------------------- +---- listener { host: 0.0.0.0 role: normal port: amqp saslMechanisms: ANONYMOUS } ----------------------------- +---- [[the-console-files]] The console files ~~~~~~~~~~~~~~~~~ -The files for the console are located under the console directory in the -source tree: app/ bower_components/ css/ img/ index.html lib/ plugin/ -vendor.js +The files for the console are located under the console/stand-alone +directory in the source tree +* 'index.html' +* 'plugin/' Copy these files to a directory under the the html or webapps directory of your web server. For example, for apache tomcat the files should be http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/da6688a5/doc/book/console_operation.adoc ---------------------------------------------------------------------- diff --git a/doc/book/console_operation.adoc b/doc/book/console_operation.adoc index 29df336..501eee1 100644 --- a/doc/book/console_operation.adoc +++ b/doc/book/console_operation.adoc @@ -16,7 +16,6 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License //// - [[console-operation]] Console operation ----------------- @@ -25,50 +24,35 @@ Console operation Logging in to a router network ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The console communicates to the router network using the proton -javascript bindings. When run from a web page, the proton bindings use -web sockets to send and receive commands. However, the dispatch router -requires tcp. Therefore a web-sockets to tcp proxy is used. - image:console_login.png[image] -Enter the address of a proxy that is connected to a router in the -network. +Enter the address of the websockets to tcp proxy that is connected to a router in the network. -User name and password are not used at this time. - -The Autostart checkbox, when checked, will automatically log in with the -previous host:port the next time you start the console. +The Autostart checkbox, when checked, will automatically log in with the previous host:port the next time you start the console. [[overview-page]] Overview page ~~~~~~~~~~~~~ -On the overview page, aggregate information about routers, addresses, -and connections is displayed. - image:console_overview.png[image] +On the overview page, aggregate information about routers, addresses, and connections is displayed. + [[topology-page]] Topology page ~~~~~~~~~~~~~ -This page displays the router network in a graphical form showing how -the routers are connected and information about the individual routers -and links. - image:console_topology.png[image] -[[router-entity-details-page]] -Router entity details page -~~~~~~~~~~~~~~~~~~~~~~~~~~ +This page displays the router network in a graphical form showing how the routers are connected and information about the individual routers and links. -image:console_entity.png[image] +[[list-page]] +List page +~~~~~~~~~ -Displays detailed information about entities such as routers, links, -addresses, memory. +image:console_entity.png[image] -Numeric attributes can be graphed by clicking on the graph icon. +Displays detailed information about entities such as routers, links, addresses, memory. [[charts-page]] Charts page @@ -76,8 +60,7 @@ Charts page image:console_charts.png[image] -This page displays graphs of numeric values that are on the entity -details page. +This page displays graphs of numeric values that are on the list page. [[schema-page]] Schema page @@ -85,5 +68,4 @@ Schema page image:console_schema.png[image] -This page displays the json schema that is used to manage the router -network. +This page displays the json schema that is used to manage the router network. http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/da6688a5/doc/book/console_overview.adoc ---------------------------------------------------------------------- diff --git a/doc/book/console_overview.adoc b/doc/book/console_overview.adoc index ea28661..10cf023 100644 --- a/doc/book/console_overview.adoc +++ b/doc/book/console_overview.adoc @@ -16,22 +16,12 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License //// - [[console-overview]] Console overview ---------------- -The console is an HTML based web site that displays information about a -qpid dispatch router network. - -The console requires an HTML web server that can serve static html, -javascript, style sheets, and images. +The console is an HTML based web site that displays information about a qpid dispatch router network. -The current version of the is read-only. The ability to call management -methods that change the running of the router network is planned for a -future version of console. +The console requires an HTML web server that can serve static html, javascript, style sheets, and images. -The console only provides limited information about the clients that are -attached to the router network and is therfore more appropriate for -administrators needing to know the layout and health of the router -network. +The console only provides limited information about the clients that are attached to the router network and is therfore more appropriate for administrators needing to know the layout and health of the router network. http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/da6688a5/doc/book/default_config.adoc ---------------------------------------------------------------------- diff --git a/doc/book/default_config.adoc b/doc/book/default_config.adoc index 30aa97d..b0122be 100644 --- a/doc/book/default_config.adoc +++ b/doc/book/default_config.adoc @@ -22,14 +22,14 @@ Configuration ------------- The default configuration file is installed in -'install-prefix/etc/qpid-dispatch/qdrouterd.conf'. This configuration file will +'{CMAKE_INSTALL_PREFIX}/etc/qpid-dispatch/qdrouterd.conf'. This configuration file will cause the router to run in standalone mode, listening on the standard AMQP port (5672). Dispatch Router looks for the configuration file in the installed location by default. If you wish to use a different path, the "-c" command line option will instruct Dispatch Router as to which configuration to load. -To run the router, invoke the executable: qdrouterd [-c my-config-file] +To run the router, invoke the executable: `qdrouterd [-c my-config-file]` For more details of the configuration file see the 'qdrouterd.conf(5)' man page. --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
