VRS Upgrade Guide from 14.12.0 to 14.12.1 | Voice Recording

Upgrade VRS from 14.12.0 to 14.12.1

Follow these steps in order.

This guide applies to Cisco and EFCX compose profiles. Optional steps call out where Cisco and EFCX differ.

Before you start

You have access to the VRS server
You know which database your deployment uses
You are already on 14.12.0 (or have completed the 14.11.0 → 14.12.0 upgrade)

Step 1 — Backup

Back up config.env and any custom compose overrides.
Take a full database backup before you change image tags.

Step 2 — Stop VRS

Stop the running VRS stack with your usual compose/stop procedure for this deployment.

Step 3 — Update image tags to 14.12.1

In docker-compose.yml (and related compose files), set these image tags to 14.12.1:

front-end → 14.12.1
apis → 14.12.1
jtapi-connector (Cisco) → 14.12.1
archival-process (if used) → 14.12.1

mixed-session (mixer): leave at the current tag already running on the site — do not change it for this upgrade.

Archival (if used): Matching archival-process and apis 14.12.1 builds are required for multi-leg stamped-path playback. Ensure Archive Days / retention_days is at least 2 — settings with retention_days = 1 are skipped. You do not need to re-run the EFCX fusionpbx dual-schema SQL if it was already applied in 14.12.0.

Step 4 — Database indexes (recommended for Cisco)

If your site does not already have them, apply the recording-solution schema indexes shipped for this release (SQL Server, PostgreSQL, or MySQL — use the script that matches your database). These support JTAPI linking and Media Recordings list grouping. There is no change to the correlation_id default.

Step 5 — Keycloak Brute Force Detection (optional)

If you want login lockout after too many wrong passwords, enable Brute Force Detection on the realm used for VRS login and grant the confidential client service account the Admin roles described in Login account lockout (Keycloak Brute Force Detection).

Step 6 — Start VRS again

Start the stack and confirm containers are healthy. On Cisco, restart jtapi-connector once after the upgrade so the connector picks up the new build.

What this upgrade gives you

Improved Cisco call linking
More reliable multi-leg archival playback (per-file stamped paths; Archive Days ≥ 2)
EFCX Agent Name dropdown (previously no agent-name dropdown)
Local Material Icons (no Google CDN dependency)
Clearer on-screen feedback for download and login (including lock messaging when Keycloak BFD is configured)

Rollback

Restore the previous image tags and database backup, then start the stack again.