Skip to main content
Skip table of contents

Update Enterprise Glossary & Sync Service

Updating requires only replacing the image TAR files and adjusting the .env. All persistent data (application data, uploads, sync configuration) is stored in named volumes and is not affected.

Step-by-Step Update

  1. Download the newest version of the ContainerEG_<Version>.zip and extract the files.

  2. Copy the new TAR files into your deployment folder.

    1. The TAR files must sit in the same directory as run.ps1. The filenames are derived from .env at runtime: <IMAGE_WEB_NAME>-<IMAGE_TAG>.tar and <IMAGE_SYNC_NAME>-<IMAGE_TAG>.tar

  3. Update .env

    1. Open <deployment-folder>/.env and set IMAGE_TAG to the new version or place the new .env file in the <deployment-folder>and change the certificate password to your password.

  4. Stop the running stack (powershell)

CODE
# Docker
.\stop.ps1

# Podman
podman stop localhost-enterpriseglossary localhost-enterpriseglossary-sync

For Podman: Use the name of your running containers. They might be different than shown above. To check for the names enter podman ps -a

  1. Start with the new images (powershell)

CODE
# Docker
.\run.ps1

# Podman
.\run-podman.ps1
  1. Verify

CODE
# Check which image is actually running
docker ps --format "table {{.Names}}`t{{.Image}}`t{{.Status}}"

The IMAGE column should show the new tag. Then open the app in your browser:

Protocol

URL

HTTP

http://localhost:8080

HTTPS

https://localhost:8443

What Gets Preserved

Data

Volume

Preserved

Application data & config

app-data

Yes

User uploads

uploads

Yes

Sync Service configuration

sync-config

Yes

Sync Service logs

sync-logs

Yes

TLS certificate

certs/eg.pfx (bind mount)

Yes

Port settings & secrets

.env

Not overwritten when adjusting the image tag instead of copying the new .env

Troubleshooting

Symptom

Cause

Fix

App still shows old version

Old image cached under same tag

Check IMAGE_TAG in .env; run docker images | grep enterpriseglossary to verify the new tag was loaded

"Missing image TAR" error

TAR file not in deployment folder

Copy both TAR files next to run.ps1 before starting

Health check failing

App still initializing

Wait up to 60 s; check with docker compose logs -f web

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.