openmpf · brosenberg42 · Dec 20, 2023 · Dec 8, 2023 · Dec 14, 2023
diff --git a/docs/docs/Admin-Guide.md b/docs/docs/Admin-Guide.md
@@ -8,7 +8,7 @@ Rights in Data-General Clause 52.227-14, Alt. IV (DEC 2007). Copyright 2023 The
 
 # Web UI
 
-The login procedure, as well as all of the pages accessible through the Workflow Manager sidebar, are the same for admin and non-admin users. Refer to the [User Guide](/User-Guide/index.html) for more information. The default account for an admin user has the username "admin" and password "mpfadm". 
+The login procedure, as well as all of the pages accessible through the Workflow Manager sidebar, are the same for admin and non-admin users. Refer to the [User Guide](/User-Guide/index.html) for more information. The default account for an admin user has the username "admin" and password "mpfadm".
 
 We highly recommend changing the default username and password settings for any environment which is exposed on a network, especially production environments. The default settings are public knowledge, which could be a security risk. Please refer to the [User Configuration](#user-configuration) section below.
 
@@ -38,18 +38,24 @@ At the bottom of the properties table is the "Save Properties" button. The numbe
 
 ![Properties Settings Page](img/mpf-adm-property-settings-change.png "Properties Settings Page")
 
+## Hawtio
+
+The [Hawtio](https://hawt.io/) web console can be accessed by selecting "Hawtio" from the
+"Configuration" dropdown menu in the top menu bar. Hawtio exposes various management information
+and settings. It can be used to monitor the state of the ActiveMQ queues used for communication
+between the Workflow Manager and the components.
+
 # User Configuration
 
 Every time the Workflow Manager starts it will attempt to create accounts for the users listed in the `user.properties` file. At runtime this file is extracted to `$MPF_HOME/config` on the machine running the Workflow Manager. For every user listed in that file, the Workflow Manager will create that user account if a user with the same name doesn't already exists in the SQL database. By default, that file contains two entries, one for the "admin" user with the "mpfadm" password, and one for a non-admin "mpf" user with the "mpf123" password.
 
-We highly recommend modifying the `user.properties` file with your own user entries before attempting to start the Workflow Manager for the first time. This will ensure that the default user accounts are not created. 
+We highly recommend modifying the `user.properties` file with your own user entries before attempting to start the Workflow Manager for the first time. This will ensure that the default user accounts are not created.
 
 The official way to deploy OpenMPF is to use the Docker container platform. If you are using Docker, please follow the instructions in the openmpf-docker [README](https://github.com/openmpf/openmpf-docker/blob/master/README.md#optional-configure-users) that explain how to use a `docker secret` for your custom `user.properties` file.
 
 
 # (Optional) Configure HTTPS
-The official way to deploy OpenMPF is to use the Docker container platform. 
-If you are using Docker, please follow the instructions in the openmpf-docker 
-[README](https://github.com/openmpf/openmpf-docker#optional-configure-https) 
+The official way to deploy OpenMPF is to use the Docker container platform.
+If you are using Docker, please follow the instructions in the openmpf-docker
+[README](https://github.com/openmpf/openmpf-docker#optional-configure-https)
 that explain how to configure HTTPS.
-
diff --git a/docs/docs/Development-Environment-Guide.md b/docs/docs/Development-Environment-Guide.md
@@ -171,34 +171,6 @@ cd;
 sudo rm -rf /tmp/libheif;
 ```
 
-
-- Install ActiveMQ:
-```bash
-wget -O- https://archive.apache.org/dist/activemq/5.17.0/apache-activemq-5.17.0-bin.tar.gz \
-    | sudo tar --extract --gzip --directory /opt;
-sudo ln --symbolic /opt/apache-activemq-5.17.0 /opt/activemq;
-sudo chown -R mpf:mpf /opt/apache-activemq-5.17.0
-```
-
-- In `/opt/activemq/conf/activemq.xml` change line 34 from <br />
-  `<broker xmlns="http://activemq.apache.org/schema/core" brokerName="localhost" dataDirectory="${activemq.data}">`
-  <br /> to <br />
-  `<broker xmlns="http://activemq.apache.org/schema/core" brokerName="localhost" dataDirectory="${activemq.data}" persistent="false">`
-
-- In `/opt/activemq/conf/activemq.xml` (line 38) under the line:
-  `<policyEntries>`, add <br />
-  `<policyEntry queue=">" prioritizedMessages="true" useCache="false" expireMessagesPeriod="0" queuePrefetch="1" />`
-
-- In `/opt/activemq/conf/activemq.xml` (line 66, after making the above addition),
-  change the line: `<managementContext createConnector="false"/>`
-  <br /> to <br />
-  `<managementContext createConnector="true"/>`.
-
-- In `/opt/activemq/conf/log4j2.properties` (line 69), change the line <br />
-  `appender.logfile.layout.pattern=%d | %-5p | %m | %c | %t%n%throwable{full}`
-  <br /> to  <br />
-  `appender.logfile.layout.pattern=%d %p [%t] %c - %m%n`
-
 - From your home directory run:
 ```bash
 git clone https://github.com/openmpf/openmpf-projects.git --recursive;
@@ -267,8 +239,7 @@ finished starting:
 2022-10-11 12:21:16,447 INFO [main] o.m.m.Application - Started Application in 22.843 seconds (JVM running for 24.661)
 ```
 
-After startup, the Workflow Manager will be available at
-<http://localhost:8080/workflow-manager>.
+After startup, the Workflow Manager will be available at <http://localhost:8080>.
 Browse to this URL using Firefox or Chrome.
 
 If you want to test regular user capabilities, log in as the "mpf" user with
@@ -284,8 +255,7 @@ The preferred method to start and stop services for OpenMPF is with the
 `mpf start` and `mpf stop` commands. For additional information on these
 commands, please see the
 [Command Line Tools](#command-line-tools) section.
-These will start and stop the ActiveMQ, PostgreSQL, Redis, Node Manager,
-and Workflow Manager processes.
+These will start and stop the PostgreSQL, Redis, Node Manager, and Workflow Manager processes.
 
 
 # Known Issues
@@ -317,7 +287,7 @@ Execute `mpf --help` for general documentation and `mpf <action> --help` for
 documentation about a specific action.
 
 - **Start / Stop Actions**: Actions for starting and stopping the OpenMPF
-  system dependencies, including PostgreSQL, ActiveMQ, Redis, Workflow Manager, and the
+  system dependencies, including PostgreSQL, Redis, Workflow Manager, and the
   node managers on the various nodes in the OpenMPF cluster.
     - `mpf status`: displays a message indicating whether each of the system
        dependencies is running or not
@@ -339,9 +309,8 @@ documentation about a specific action.
 - **Clean Actions**: Actions to remove old data and revert the system to a
   new install state. User accounts, registered components, as well as custom
   actions, tasks, and pipelines, are preserved.
-    - `mpf clean`: cleans out old job information and results, pending job
-      requests, marked up media files, and ActiveMQ data, but preserves log
-      files and uploaded media
+    - `mpf clean`: cleans out old job information and results, pending job requests, and marked up
+      media files, but preserves log files and uploaded media.
     - `mpf clean --delete-logs --delete-uploaded-media`: the same as `mpf clean`
       but also deletes log files and uploaded media
 - **Node Action**: Actions for managing node membership in the OpenMPF cluster.

diff --git a/docs/docs/OpenID-Connect-Guide.md b/docs/docs/OpenID-Connect-Guide.md
@@ -128,8 +128,8 @@ docker run -p 9090:8080 -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin
         in job completion callbacks and when communicating with TiesDb.
 - Login settings:
     - Set "Valid redirect URIs" to
-      `http://localhost:8080/workflow-manager/login/oauth2/code/provider`
-    - Set "Valid post logout redirect URIs" to `http://localhost:8080/workflow-manager`
+      `http://localhost:8080/login/oauth2/code/provider`
+    - Set "Valid post logout redirect URIs" to `http://localhost:8080`
 - Set Workflow Manager's `OIDC_CLIENT_SECRET` environment variable to the "Client secret" in the
     "Credentials" tab.
 
@@ -189,7 +189,7 @@ curl -d grant_type=client_credentials -u '<client-id>:<client-secret>' 'http://<
 The response JSON will contain a token in the `"access_token"` property. That token needs to be
 included as a bearer token in REST requests to Workflow Manager. For example:
 ```bash
-curl -H "Authorization: Bearer <access-token>" http://localhost:8080/workflow-manager/rest/actions
+curl -H "Authorization: Bearer <access-token>" http://localhost:8080/rest/actions
 ```
 
 

diff --git a/docs/docs/User-Guide.md b/docs/docs/User-Guide.md
@@ -13,7 +13,7 @@ The Open Media Processing Framework (OpenMPF) can be used in three ways:
 
 ## Accessing the Web UI
 
-On the server hosting the Open Media Processing Framework, the Web UI is accessible at http://localhost:8080/workflow-manager. To access it from other machines, substitute the hostname or IP address of the master node server in place of "localhost".
+On the server hosting the Open Media Processing Framework, the Web UI is accessible at http://localhost:8080. To access it from other machines, substitute the hostname or IP address of the master node server in place of "localhost".
 
 The OpenMPF user interface was designed and tested for use with Chrome and Firefox. It has not been tested with other browsers. Attempting to use an unsupported browser will result in a warning.
 
@@ -256,7 +256,7 @@ This page allows a user to view the various log files that are generated by syst
 
 In general, all services of the same component type running on the same node write log messages to the same file. For example, all OCV face detection services on somehost-7-mpfd2 write log messages to the same "ocv-face-detection" log file. All OCV face detection services on somehost-7-mpfd3 write log messages to a different "ocv-face-detection" log file.
 
-Note that only the master node will have the "workflow-manager" log. This is because the workflow manager only runs on the master node. The same is true for the "activemq" logs.
+Note that only the master node will have the "workflow-manager" log. This is because the workflow manager only runs on the master node.
 
 The "node-manager-startup" and "node-manager" logs will appear for every node in a non-Docker OpenMPF cluster. The "node-manager-startup" log captures information about the nodemanager startup process, such as if any errors occurred. The "node-manager" log captures information about node manager execution, such as starting and stopping services.
 

diff --git a/docs/docs/html/REST-API.html b/docs/docs/html/REST-API.html
@@ -183,22 +183,12 @@ <h2>Version 7.2</h2>
         </font></i></p>
         <br/>
     </div>
-    <div class='footer'>Last updated on: May 4, 2023</div>
+    <div class='footer'>Last updated on: December 14, 2023</div>
     <div class="coverHeadings">
         <h1>Introduction</h1>
     </div>
     <div>REST-based web services for the OpenMPF Workflow Manager</div>
     <br />
-    <table>
-        <tr>
-            <td><span class='small-heading'>Host:</span></td>
-            <td><span class='subheading-text'>hostname:8080</span></td>
-        </tr>
-        <tr>
-            <td><span class='small-heading'>Base Path:</span></td>
-            <td><span class='subheading-text'>/workflow-manager</span></td>
-        </tr>
-    </table>
     <div style='page-break-after:always'>
         <div class="coverHeadings">
             <h1>Table of contents</h1>

diff --git a/docs/site/Admin-Guide/index.html b/docs/site/Admin-Guide/index.html
@@ -92,6 +92,8 @@
 
             <li><a class="toctree-l4" href="#properties-settings">Properties Settings</a></li>
 
+            <li><a class="toctree-l4" href="#hawtio">Hawtio</a></li>
+
         </ul>
 
 
@@ -247,7 +249,7 @@
 <div style="background-color:DeepSkyBlue"><p style="color:white; padding:5px"><b>INFO:</b> This document refers to components and pipelines that are no longer supported by OpenMPF; however, the images and general content still reflect the appearance and usage of the OpenMPF web UI and its features.</p></div>
 
 <h1 id="web-ui">Web UI</h1>
-<p>The login procedure, as well as all of the pages accessible through the Workflow Manager sidebar, are the same for admin and non-admin users. Refer to the <a href="../User-Guide/index.html">User Guide</a> for more information. The default account for an admin user has the username "admin" and password "mpfadm". </p>
+<p>The login procedure, as well as all of the pages accessible through the Workflow Manager sidebar, are the same for admin and non-admin users. Refer to the <a href="../User-Guide/index.html">User Guide</a> for more information. The default account for an admin user has the username "admin" and password "mpfadm".</p>
 <p>We highly recommend changing the default username and password settings for any environment which is exposed on a network, especially production environments. The default settings are public knowledge, which could be a security risk. Please refer to the <a href="#user-configuration">User Configuration</a> section below.</p>
 <p>This document will cover the additional functionality permitted to admin users through the Admin Console pages.</p>
 <h2 id="dashboard">Dashboard</h2>
@@ -263,14 +265,19 @@ <h2 id="properties-settings">Properties Settings</h2>
 
 <p>At the bottom of the properties table is the "Save Properties" button. The number of modified properties is shown in parentheses. Clicking the button will make the necessary changes to the properties file on the file system, but the changes will not take effect until the workflow manager is restarted. The saved properties will be colored blue and a blue icon will be displayed to the right of the property name. Additionally, a notification will appear at the top of the page alerting all system users that a restart is required:</p>
 <p><img alt="Properties Settings Page" src="../img/mpf-adm-property-settings-change.png" title="Properties Settings Page" /></p>
+<h2 id="hawtio">Hawtio</h2>
+<p>The <a href="https://hawt.io/">Hawtio</a> web console can be accessed by selecting "Hawtio" from the
+"Configuration" dropdown menu in the top menu bar. Hawtio exposes various management information
+and settings. It can be used to monitor the state of the ActiveMQ queues used for communication
+between the Workflow Manager and the components.</p>
 <h1 id="user-configuration">User Configuration</h1>
 <p>Every time the Workflow Manager starts it will attempt to create accounts for the users listed in the <code>user.properties</code> file. At runtime this file is extracted to <code>$MPF_HOME/config</code> on the machine running the Workflow Manager. For every user listed in that file, the Workflow Manager will create that user account if a user with the same name doesn't already exists in the SQL database. By default, that file contains two entries, one for the "admin" user with the "mpfadm" password, and one for a non-admin "mpf" user with the "mpf123" password.</p>
-<p>We highly recommend modifying the <code>user.properties</code> file with your own user entries before attempting to start the Workflow Manager for the first time. This will ensure that the default user accounts are not created. </p>
+<p>We highly recommend modifying the <code>user.properties</code> file with your own user entries before attempting to start the Workflow Manager for the first time. This will ensure that the default user accounts are not created.</p>
 <p>The official way to deploy OpenMPF is to use the Docker container platform. If you are using Docker, please follow the instructions in the openmpf-docker <a href="https://github.com/openmpf/openmpf-docker/blob/master/README.md#optional-configure-users">README</a> that explain how to use a <code>docker secret</code> for your custom <code>user.properties</code> file.</p>
 <h1 id="optional-configure-https">(Optional) Configure HTTPS</h1>
-<p>The official way to deploy OpenMPF is to use the Docker container platform. 
-If you are using Docker, please follow the instructions in the openmpf-docker 
-<a href="https://github.com/openmpf/openmpf-docker#optional-configure-https">README</a> 
+<p>The official way to deploy OpenMPF is to use the Docker container platform.
+If you are using Docker, please follow the instructions in the openmpf-docker
+<a href="https://github.com/openmpf/openmpf-docker#optional-configure-https">README</a>
 that explain how to configure HTTPS.</p>
 
             </div>