[
https://issues.apache.org/jira/browse/DISPATCH-1347?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16852832#comment-16852832
]
ASF GitHub Bot commented on DISPATCH-1347:
------------------------------------------
jbyrne-redhat commented on pull request #516: DISPATCH-1347: Update doc for
setting up and accessing web console
URL: https://github.com/apache/qpid-dispatch/pull/516#discussion_r289310152
##########
File path: docs/books/user-guide/using-console.adoc
##########
@@ -17,110 +17,100 @@ specific language governing permissions and limitations
under the License
////
+[id='using-router-console']
= Using {ConsoleName}
-[[console-overview]]
-== Console Overview
+{ConsoleName} is a web console for monitoring the status and performance of
{RouterName} router networks.
-The console is an HTML based web site that displays information about a qpid
dispatch router network.
+== Setting up access to the web console
-The console requires an HTML web server that can serve static html,
javascript, style sheets, and images.
+Before you can access the web console, you must configure a `listener` to
accept HTTP connections for the web console and serve the console files.
-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.
+.Procedure
-[[console-installation]]
-== Console Installation
+. On the router from which you want to access the web console, open the
{RouterConfigFile} configuration file.
-[discrete]
-=== Prerequisites
-
-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.
-* A websockets to tcp proxy.
-* A web server. This can be any server capable of serving static
-html/js/css/image files.
-
-[discrete]
-=== Procedure
-
-To install a websockets to tcp proxy:
+. Add a `listener` to serve the console.
++
+--
+This example creates a `listener` that clients can use to access the web
console:
+[options="nowrap",subs="+quotes"]
----
-sudo dnf install python-websockify
-websockify localhost:5673 localhost:5672
+listener {
+ host: 0.0.0.0
+ port: 8672
+ role: normal
+ http: true
+ httpRootDir: /usr/share/qpid-dispatch/console
+}
----
+`http`:: Set this attribute to `true` to specify that this `listener` should
accept HTTP connections instead of plain AMQP connections.
-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:
+`httpRootDir`:: Specify the absolute path to the directory that contains the
web console HTML files. The default directory is
`/usr/share/qpid-dispatch/console`.
+--
+. If you want to secure access to the console, secure the `listener`.
++
+--
+For more information, see
xref:securing-incoming-client-connections-{context}[]. This example adds basic
user name and password authentication using SASL PLAIN.
Review comment:
This is extremely nit-picky, but you introduce other examples with a :
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Update documentation for Dispatch Router console
> ------------------------------------------------
>
> Key: DISPATCH-1347
> URL: https://issues.apache.org/jira/browse/DISPATCH-1347
> Project: Qpid Dispatch
> Issue Type: Improvement
> Components: Documentation
> Reporter: Ben Hardesty
> Priority: Major
>
> The documentation for the web console is out-of-date. It should be updated to
> describe how to install and access the console.
>
> [https://qpid.apache.org/releases/qpid-dispatch-1.7.0/user-guide/index.html#using_apache_qpid_dispatch_router_console]
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@qpid.apache.org
For additional commands, e-mail: dev-h...@qpid.apache.org
