Index

This page is not regularly updated

Please refer to the release notes of the primary images:

Note

From time to time, the versions of the two primary images, Dash4 frontend and TethysDash backend, are "re-synced" depending on involved adjustments, but in general it is not expected that both images have the same version. See here for more details.

4.64.0 - 4.70.3¶

2024-05-01 - Frontend 4.64.0 - change log
2024-05-10 - Backend 4.70.3 - Backend change log

Note

Significant internal updates to the backend system since version 4.70.1, which has been exercised with various vehicle deployments without any issues since 2024-04-21.

4.63.0¶

2024-03-27

Dash4 4.63.0 - change log
Backend 4.63.0 - Backend change log

4.62.0¶

2024-02-13

Dash4 4.62.0 - change log
Backend 4.62.0 - Backend change log

4.60.0 - 4.61.0¶

2024-01-12

Dash4 4.60.0 - change log
Backend 4.61.0 - Backend change log

4.53.3 - 4.53.4¶

2023-09-19

Dash4 4.53.3 - change log
Backend 4.53.4 - Backend change log

4.53.0¶

2023-09-01

Both Dash4 and TethysDash backend versions "re-synced" at 4.53.0.

4.50.5¶

2023-06-01

Both Dash4 and TethysDash backend versions "resynced" at 4.50.5, in this case with Dash4 4.50.5 actually requiring backend 4.50.5 due to a new configuration setting (see below).

Template: 4.50.5/tethysdash-instance-template.tgz

Addition in the template:

New required entry external.ws in config/TethysDash.conf to indicate the URL of the websocket endpoint, for example:

external {
  ...

  # External URL of the websocket endpoint:
  ws = "ws://localhost:18080/TethysDash/ws"

  ...

Previously, Dash4 would determine such URL based on the URL of the TethysDash service itself, but it is more appropriate that the backend explicitly indicate this as it is after all also the place where the websocket endpoint is defined depending on any related proxy passes and such.

4.40.4¶

2023-04-20

Basically this version consolidates some recent interim versions (while also reflecting a "resync" of both backend and frontend versions).

Template: 4.40.4/tethysdash-instance-template.tgz

No changes in the template.

4.40.4: digest: sha256:fe08d8c0b46132db1a5d440f25b63937c669ce5bebb8fcf95217c86da21693a6 size: 4305

4.32.1¶

2023-04-07

Template: 4.32.1/tethysdash-instance-template.tgz

No changes in the template.

4.32.1: digest: sha256:9fc38ae669260754e4a22e65f5d33e2ac3cc8dbc69546519e338a71cb4cb54f6 size: 4305

4.30.2¶

2023-02-17

Template: 4.30.2/tethysdash-instance-template.tgz

No changes in the template.

4.30.2: digest: sha256:c97ce0d2bd3e42c6a9430d3f2451f8a05fca8a89e95b2a765256cd6f56e36c5c size: 4099

4.25.0¶

2023-02-08

Template: 4.25.0/tethysdash-instance-template.tgz

No changes in the template.

4.25.0: digest: sha256:7c1958c5af5fb8799e3d16677d820bcd50baf1d392e6107285251916a049650c size: 4099

4.24.0¶

2023-01-26

See frontend change log.

Template: 4.24.0/tethysdash-instance-template.tgz

4.23.0¶

2022-11-21

Adjustments to expose the URLs of the status widgets via configuration from backend.

Template: 4.23.0/tethysdash-instance-template.tgz

Addition in the template:

New optional section external.statusWidgets in config/TethysDash.conf to indicate the URL patterns of the vehicle status widgets (which are externally generated):

external {
  ...

  # Optional section for the status widgets (which are generated by external tooling)
  statusWidgets {
    # URL pattern of the vehicle status widget:
    # Adjust as needed.
    #lrauvStatusWidgetUrlPattern = ${external.base}"/widget/auv_<vehicleName>.svg"

    # URL pattern of the ESP status widget:
    # Adjust as needed.
    #espStatusWidgetUrlPattern = ${external.base}"/widget/esp_<vehicleName>.svg"
  }

4.23.0: digest: sha256:cbb0ebce2f5c2fbd2a1eaed56ca5cb40eb283edaf16206342011662ad0716e76 size: 4099

4.22.8¶

2022-11-17

More detailed cell connection information, now including last time the vehicle itself has connected via the DataLink endpoint.

Template: 4.22.8/tethysdash-instance-template.tgz

No changes in the template.

4.22.8: digest: sha256:a80ebe1021857a6d317897bb5ac03a7d8b017574abb792eb0b153438bc00965d size: 4099

4.22.5¶

2022-11-10

Delete user account option exposed in the UI for admins.

Template: 4.22.5/tethysdash-instance-template.tgz

No changes in the template.

4.22.5: digest: sha256:5f1a56d3d319a1656ba060e85b5ad80ccf751453a87f5dd98f01dec8c1e82e5c size: 4099

- Frontend change log - Backend change log

4.22.4¶

2022-11-07

Maintenance release.

Template: 4.22.4/tethysdash-instance-template.tgz

No changes in the template.

4.22.4: digest: sha256:b32a4c31a315082d42de9a107cd8f764e44fe127c65eafc83dbb96ad058a5b0e size: 4099

- Frontend change log - Backend change log

4.22.1¶

2022-10-17

Maintenance release with a fix in backend and documentation link update in frontend.

Template: 4.22.1/tethysdash-instance-template.tgz

No changes in the template.

4.22.1: digest: sha256:fe31a51a9e6660a737dea168dcfd568d815ad8c6276a76f9d4a765745fff0b19 size: 4099

- Frontend change log - Backend change log

4.22.0¶

2022-10-07

Maintenance release, new /data endpoint, some fixes.

Template: 4.22.0/tethysdash-instance-template.tgz

No changes in the template.

4.22.0: digest: sha256:8bb5b658b0980befd0e8fd7b64ddb00876570ff6629326082458b4cf6f0a9f72 size: 4099

- Frontend change log - Backend change log

4.20.0¶

2022-09-19

The build command feature now includes arguments of a new type recently added on the LRAUV side.

Template: 4.20.0/tethysdash-instance-template.tgz

No changes in the template.

4.20.0: digest: sha256:f058c4393d18deb1a185664a757d8f4f21308213e75cf351f33cffc36b5a318f size: 4099

- Frontend change log - Backend change log

4.12.8¶

2022-09-14

Maintenance release including some non-critical regression fixes.

Template: 4.12.8/tethysdash-instance-template.tgz

No changes in the template.

4.12.8: digest: sha256:dba79f18c813b4443a2ee89ce3668e69b2dcf86c204ac52093586f2b161da536 size: 4099

- Frontend change log - Backend change log

4.12.6¶

2022-08-31

Maintenance release including internal API adjustments.

Template: 4.12.6/tethysdash-instance-template.tgz

No changes in the template.

4.12.6: digest: sha256:a778264a5b295d5281fccbc8443af28420088105812ac0e2c28ff5819c8545f2 size: 4099

- Backend change log

4.12.1¶

2022-08-04

Backend 4.12.1 with a fix related with .tl mission waypoint information.
No changes in the frontend (which still shows version 4.12.0).

Template: 4.12.1/tethysdash-instance-template.tgz

No changes in the template.

4.12.1: digest: sha256:3a7be92d66b142912c9af0f2361806cf1ba1c0dbceb7bd0a286d5fa2753b42ae size: 4099

- Backend change log

4.12.0¶

2022-07-22

Some significant but only internal/cleanup adjustments in the backend, with resulting image size reduced considerably.

Template: 4.12.0/tethysdash-instance-template.tgz

No changes in the template.

4.12.0: digest: sha256:d844cf340b623798c91a159178e5bd20c9d1ab9bee4637595015d0e2cf6b739f

4.11.5¶

2022-07-18

API adjustment. No visible changes in the frontend, other than the version number.

Template: 4.11.5/tethysdash-instance-template.tgz

No changes in the template.

4.11.5: digest: sha256:4fe149a1f3e907f7ef61b60769870345abc93bec070909613509dbf4e9c1f55e size: 5784

4.11.4¶

2022-07-12

API enhancements. No visible changes in the frontend.

Template: 4.11.4/tethysdash-instance-template.tgz

No changes in the template.

4.11.4: digest: sha256:1880d48cea527a5176a75695189e86ed68ea1c7c29b17bc2370bba7292a21404 size: 5784

4.11.3¶

2022-07-01

Enhancement when re-running a mission given the various mission script migrations from .xml to .tl that have been taking place.

Template: 4.11.3/tethysdash-instance-template.tgz

No changes in the template.

4.11.3: digest: sha256:9335bce3399808c23a01cb5b458ae669694cb4fcb12fd64e2572e9bff2e04ea7 size: 5784

4.11.2¶

2022-06-23

Addition in EmailService for WHOI: New optional cfg.mail.handleIncomingTimeoutMs: if positive, the usual handling of incoming email will be dispatched in a new thread, which is expected to complete within the given timeout. If not, a warning is logged.

No changes in the template.

4.11.2: digest: sha256:061abc9da420b9382cfff3508c062643af5ccb07f60138be0b4c5325e428883e size: 5784

4.11.1¶

2022-06-21

Adjustments/fixes related to the display of TethysL missions waypoints.

Template: 4.11.1/tethysdash-instance-template.tgz

No changes in the template.

4.11.1: digest: sha256:d3b4b9e0e8f64fe7ca557a72485aed4f4d4db86a15b4945cd1fbb1329dfefa77 size: 5784

4.10.9¶

NOTE: with backend 4.10.2

2022-06-16

Template: 4.10.9-4.10.2/tethysdash-instance-template.tgz

Changes in the template:

config/TethysDash.conf:
- Removal of obsolete settings:
  - external.useradmin
  - external.schemaBase
  - defaultVehicle
- New optional section vehicleBasicInfo -- see file for details.

4.10.9-4.10.2: digest: sha256:0518a49a12eb7497e0d2f0a37b684302a047a7f187722c6bd0a4573ea22ddcd5 size: 5784

4.10.8¶

2022-06-12

Internal: removal of long unneeded dependencies and other code cleanup. In particular, removal of the "pusher" dependency: Our direct websockets based mechanism has proved robust and reliable for a good while already.

Template: 4.10.8/tethysdash-instance-template.tgz

Changes in the template:

config/TethysDash.conf:
- Removal of the async.pusher section: pusher is no longer used.
- The async.websockets section is now optional:
  - The useWebsocket setting has been removed as the websockets mechanism is always used.
  - maxIdleTimeout is the only setting (optional) in this section. See template for details.

4.10.8: digest: sha256:9d6e0528d51539d4746bc8eae4d066d9d9b8fd565f7877a5d21e07a81bd8b319 size: 5784

4.10.7¶

2022-05-27

Template: 4.10.7/tethysdash-instance-template.tgz

4.10.7: digest: sha256:f1a0b6d22909b1d9dbecd375d05063d54a6e30d686aad5817bbf0b899cdc8355 size: 5784

4.10.4¶

2022-05-24

A regression fix and other adjustments.

Template: 4.10.4/tethysdash-instance-template.tgz

4.10.4: digest: sha256:717af3abbb527394e19e778191f4b6f433ca3bc1586a0c4cef6e22a2c930eaff size: 5784

4.10.1¶

2022-05-10

In short: New ability to edit the "stations" list, and new "polygons" entry under the "Layers" dropdown in the Map tab, with a similar edit capability as with the stations.

Template: 4.10.1/tethysdash-instance-template.tgz

Changes in the template:

config/TethysDash.conf (see mapOptions section in this file for more details):
- mapOptions.baseLayersDir: New entry.
- mapOptions.stationsFile: Deprecated.

4.10.1: digest: sha256:0fad50516cdd8b13a67ccd55f1b9e884c2984a573e9db0659bcec8e73a8a6e05 size: 5784

4.9.8¶

2022-04-25

Template: 4.9.8/tethysdash-instance-template.tgz

Maintenance release, including updated underlying base LRAUV image.

4.9.8: digest: sha256:e19b7cd2d63f930c550b0c2edfafc40d8a7a50440353ad2f213f4b24e29515a6 size: 5784

4.9.7¶

2022-04-18

Template: 4.9.7/tethysdash-instance-template.tgz

For app deployment purposes, the only changes are in docker-compose.yml:

Now with version: '3.7' (at the top of the file)
Now with additional init: true setting for each of the containers

These adjustments are intended for a more graceful termination of the containers. In the case of TethysDash, this should help prevent issues with potentially incomplete tasks (e.g., git related re-synchronization of clones) when the container is restarted as part of regular updates or OS system patches, etc.

4.9.6¶

2022-04-05

Template: 4.9.6/tethysdash-instance-template.tgz

4.9.52¶

2022-02-11

Template: 4.9.52/tethysdash-instance-template.tgz

4.9.51¶

2022-02-04

Template: 4.9.51/tethysdash-instance-template.tgz

4.9.4¶

2022-02-01

Template: 4.9.4/tethysdash-instance-template.tgz

4.9.1¶

2022-01-26

Template: 4.9.1/tethysdash-instance-template.tgz

4.8.9¶

2022-01-14

Template: 4.8.93/tethysdash-instance-template.tgz

4.8.7¶

2021-12-16

Template: 4.8.7/tethysdash-instance-template.tgz

4.8.6¶

2021-12-15

Template: 4.8.6/tethysdash-instance-template.tgz

4.8.4¶

2021-12-13

Template: 4.8.4/tethysdash-instance-template.tgz

Changes in the system:

Critical security update in the backend (v4.7.0).
As usual, please see the change logs for the frontend and the backend.

4.8.2¶

2021-11-18

Template: 4.8.3/tethysdash-instance-template.tgz

Changes in the system:

As usual, please see the change logs for the frontend and the backend.

4.8.0¶

2021-11-09

Template: 4.8.0/tethysdash-instance-template.tgz

docker-compose.yml: With placeholder X.Y.Z for the version of the mbari/tethysdash image. Of course, please set this to appropriate version in your deployment.

4.7.8¶

2021-11-08

Template: 4.7.8/tethysdash-instance-template.tgz

Changes in the template:

setenv.sh:
- New optional variable TETHYSDASH_LOGS that facilitates mapping the location of the TethysDash application log directory. Adjust docker-compose.yml accordingly.
docker-compose.yml:
- Optional use of the TETHYSDASH_LOGS variable to map the application log directory.
- Change in the version of the 'mbari/tethysdash' image.

Change in how the main TethysDash log is exposed

The main application log is now explicitly captured in a file with name main.log. This means that a command like docker logs -f tethysdash(*) is not anymore the typical mechanism to see the log. Instead, one will look at this main log as follows:

docker exec -it tethysdash tail -f /usr/local/tomcat/logs/main.log

Alternatively, if that logs directory in the container is mapped to a host location via the TETHYSDASH_LOGS setting indicated above, one can then simply run on the host directly, for example:

tail -f td_logs/main.log

Such volume mapping is in general more convenient, especially considering that there are other log files generated by the application (e.g., ws.log for websocket-related activity), as well as in terms of persistence of the logs.

(*)

docker logs -f tethysdash will now only show basic logging related with the launch and termination of the TethysDash application as reported from the application server (Tomcat).

New index in TethysDash database

There is a new index specified for the event table in the database. This is typically a large table so, upon a first launch of this new release, a delay (potentially of a couple of minutes) will be noted until the index is completed. The service may not be very responsive while such reindexing takes place.

4.7.0¶

2021-10-12

Template: 4.7.0/tethysdash-instance-template.tgz

Changes in the template:

docker-compose.yml: Only change is the version of the 'mbari/tethysdash' image.

4.6.2¶

2021-07-23

Template: 4.6.2/tethysdash-instance-template.tgz

Changes in the template:

docker-compose.yml: Only change is the version of the 'mbari/tethysdash' image.

4.5.3¶

2021-06-07

Template: 4.5.3/tethysdash-instance-template.tgz

Changes in the template:

docker-compose.yml: Only change is the version of the 'mbari/tethysdash' image.
config/TethysDash.conf: New optional entry vehicleNames (at first level) to indicate the concrete list of vehicle names for the UI to consider. This is a convenience for when the underlying lrauv-config repo involves more vehicles than desired to expose in the UI.
```
vehicleNames = ["foo", "bar"]
```

4.5.2¶

2021-06-01

Template: 4.5.2/tethysdash-instance-template.tgz

Changes in the template:

docker-compose.yml: Only change is the version of the 'mbari/tethysdash' image.
config/TethysDash.conf: The websockets section now looks like so:
```
async {
  websockets {
    useWebsocket = true
  }
  ...
```
NOTE: websockets will be the automatic default in a future version. For now, please keep the setting as indicated above.

Changes in the system:

Several enhancements and fixes have been incorporated since last announced version in this page. The main change is the use of proper websockets endpoint. As usual, please see the change logs for the frontend and the backend.

4.3¶

2020-12-14

Initial version with an experimental websockets server.

Template: 4.3/tethysdash-instance-template.tgz

Changes in the template:

docker-compose.yml: Only change is the version of the 'mbari/tethysdash' image.
config/TethysDash.conf: Optional new entry useWebsocket under the async section. If set to true, TethysDash will push notifications about vehicle cell connection related events also via a proper websocket server.

On the Dash4 frontend, there's a new "Websockets" section under UI Settings -> Experimental that allows to connect/disconnect to the websocket server.

4.2.3¶

2020-12-13

Template: 4.2.3/tethysdash-instance-template.tgz

Changes in the template:

docker-compose.yml: Only change is the version of the 'mbari/tethysdash' image.
config/TethysDash.conf: Optional new entry onlyCellConn under pusher as a temporary setting to help reduce use of pusher by restricting notifications only to cell connection related events.

4.2.1¶

2020-12-07

Template: 4.2.1/tethysdash-instance-template.tgz

Changes in the template:

docker-compose.yml: Only change is the version of the 'mbari/tethysdash' image.

4.2¶

2020-10-30

Template: 4.2/tethysdash-instance-template.tgz

Changes in the template:

docker-compose.yml: Only change is the version of the 'mbari/tethysdash' image.

4.1.4¶

2020-10-19

Template: 4.1.4/tethysdash-instance-template.tgz

Changes in the template:

docker-compose.yml: Only change is the version of the 'mbari/tethysdash' image.

4.1.1¶

2020-10-09

Template: 4.1.1/tethysdash-instance-template.tgz

Changes in the template:

docker-compose.yml: Only change is the version of the 'mbari/tethysdash' image.

4.0.1¶

2020-10-05

Template: 4.0.1/tethysdash-instance-template.tgz

Changes in the template:

docker-compose.yml: Only change is the version of the 'mbari/tethysdash' image.
config/TethysDash.conf:
- The dashui entry under the external section now refers to the new v4 version of the Dash UI, that is:
```
 dashui = ${external.base}"/dash4/"
```
- Under the sbd section, add:
```
  # Regex for recognizing SBD Receipt e-mails from Iridium system.
  receipt.subject.regex = "SBD Mobile Terminated Message Queued for Unit: (\\d+)"
```
  (Note: this was introduced as part of v3.9.990be3.7.7 hotfix.)

Changes in the system:

As usual, please see the change logs for the frontend and the backend.

3.9.990¶

2020-09-26

Template: 3.9.990/tethysdash-instance-template.tgz.

NOTE: No changes in this template, except for the 'mbari/tethysdash' image version in docker-compose.yml.

3.9.982¶

2020-09-18

Template: 3.9.982/tethysdash-instance-template.tgz.

It contains:

.
├── README.md             (*)
├── setenv.sh
├── docker-compose.yml    (*)
└── config
    ├── TethysDash.conf   (*)
    ├── miscLinks.json
    ├── tileLayers.json
    └── stations.json

(*) Changed files wrt previous version.

README.md: Simplified (main instructions located here).
docker-compose.yml: Only change is reference to the new image.
config/TethysDash.conf:
- New mail.user section with options related with emails sent to users. Right now only an optional sentCopyFolder.
- New optional sbd.outgoing.copyFolder setting indicating folder where copies of outgoing SBD emails are to be stored.
- Adjusted argos.subject.regex value reflecting change for use in MBARI instance.

3.9.81¶

2020-05-07

Template: 3.9.81/tethysdash-instance-template.tgz.

It contains:

.
├── README.md             (*)
├── setenv.sh
├── docker-compose.yml    (*)
└── config
    ├── TethysDash.conf   (*)
    ├── miscLinks.json
    ├── tileLayers.json   (*) New file
    └── stations.json

(*) Changed files wrt previous version.

README.md: Updated instructions.
docker-compose.yml: Only change is reference to the new image.
config/TethysDash.conf: New optional tileLayersFile entry under mapOptions. If used, do not change the value but rather edit the new file config/tileLayers.json
config/tileLayers.json: New file. This file can be used to indicate tile layers to be included on the map in the Dash UI. The contents of this file should be a JSON object containing a tileLayers member with a list of objects:
```
{
  "tileLayers": [
    {
      "name": "<name to be shown>",
      [ "wms": true, ]
      [ "legendurl": "https://...", ]
      "urlTemplate": "https://...",
      "options" : {
        "attribution": "...",
        ...
      }
    },
  ]
}
```
For each given layer, the given information will be passed to the Leaflet library used by the Dash. In concrete, the Dash will use a TileLayer.WMS if "wms": true is given, or TileLayer otherwise. The "options" object is passed directly as given. The optional "legendurl" entry is used by the Dash to show a tooltip for the entry.

3.9.8¶

2020-04-30

Template: 3.9.8/tethysdash-instance-template.tgz.

NOTE: No changes in the template wrt 3.9.77, except for the image version in docker-compose.yml.

3.9.77¶

2020-03-16

Template: 3.9.77/tethysdash-instance-template.tgz.

It contains:

    .
    ├── README.md
    ├── setenv.sh
    ├── config
    │   ├── TethysDash.conf   (*)
    │   ├── miscLinks.json
    │   └── stations.json
    └── docker-compose.yml    (*)

(*) The only files with adjustments.

Upgrading to 3.9.77

config/TethysDash.conf:
- New cellConnStatus section. This section includes two entries, hostNamePattern and hostNames, that allow to explicitly indicate the host name of the server to "ping" for checking cell connection status for each vehicle. (Note: this mechanism can be considered temporary until the corresponding information gets captured in the vehicle configuration itself.)
- Section done removed. (The corresponding unneeded scripts have been removed from the image /opt/tethysdash/tools/{runShoreScripts.sh,tethysCentroid.py}.)
docker-compose.yml:
- The only change here is about the new tethysdash image version.

Upgrade steps

Stop and remove your current tethysdash container (no need to stop the tdpostgres one):

cd .../your/tethysdash/
source setenv.sh
docker compose stop tethysdash
docker compose rm tethysdash

Do any necessary updates to your existing files from previous template as explained above.

Start new 3.9.77 tethysdash container:

docker compose up -d
docker logs -f --tail=20 tethysdash

3.9.73¶

2020-02-20

Template: 3.9.73/tethysdash-instance-template.tgz.

It contains:

    .
    ├── README.md
    ├── setenv.sh
    ├── config
    │   ├── TethysDash.conf
    │   ├── miscLinks.json     <-  new file
    │   └── stations.json
    └── docker-compose.yml

Upgrading from 3.9.4 to 3.9.73

Summary of changes as reflected in the template:

README.md updated (some irrelevant details removed).
setenv.sh now, as a convenience, also creates some of the directories to make sure they are owned by the running user. For an upgrade, the directories will of course already exist, so the ownership should be changed as needed after stopping your current version and before launching the new version.
config/TethysDash.conf:
- New entry sbd.outgoing.alternativeAddresses to indicate a list of alternative destination addresses for the SBDs. If not empty, new buttons in the GUI will be available as follows:
  - Send Commands to <vehicle-name> via alternative address when issuing a mission;
  - Submit to alternative address when issuing a command.
- The entry external.miscLinks has been removed. Instead, this optional feature is indicated with the config/miscLinks.json file described below.
- Obsolete mapOptions.stationsFile entry removed. This feature was already captured via config/stations.json file.
New file config/miscLinks.json to indicate any links to be included in the main dropdown menu in the Dash UI.

Upgrade steps

Stop your current 3.9.4 system:

cd .../your/tethysdash/
source setenv.sh
docker compose down

Do any necessary updates to your existing files from previous template as explained above.
If needed, recursively change ownership of mapped directories so they belong to current user.

Start new 3.9.73 system:

source setenv.sh
docker compose up -d
docker logs -f tethysdash

3.9.4¶

2019-12-06

Template: 3.9.4/tethysdash-instance-template.tgz.