BabelViz Translator — Self-Hosting Docker Container Quick Start

These Compose files let you run the BabelViz Translator service by default, or both the Translator plus the Datapoints Translator.

Important: Only use these files when explicitly instructed by the BabelViz Support or Account Management team. They require additional, client-specific installation steps and configuration that are provided directly to you; running them without those steps will not work.

Included files

• docker-compose.yml — default (BabelViz Translator only - i.e. the classic product used by 95% of clients, for fully automated text element translations)
• docker-compose.with-datapoints.yml — BabelViz Translator + Datapoints
• .env.sample — example environment variables

Setup

1. Copy the example env:

   cp .env.sample .env
   

2. Edit .env and set values:
   • CLIENT_SECRET — choose a strong secret
   • PROXY_URL — full proxied base path (e.g., https://example.com/babelviztranslator/)
   • LICENSE_KEY — your license

Example .env contents (from .env.sample):

CLIENT_SECRET=<your-choice-of-strong-password>
PROXY_URL=https://<your-tableau-custom-domain>/babelviztranslator/
LICENSE_KEY=XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX-XX

Start

BabelViz Translator only (recommended — simplest):

docker compose -f docker-compose.yml up -d

Both services (Translator + Datapoints):

docker compose -f docker-compose.with-datapoints.yml up -d

Note: Only start the datapoints compose when instructed by BabelViz Support — datapoints requires extra per-client setup.

Update (apply a specific new image version)

Replace with the release you want (for example 1.2.3), then run:

# optionally update the image tag in the compose file (replace 1.2.2)
sed -i 's/:1.2.2$/:<new-version>/' docker-compose.yml

# pull the new image
docker compose -f docker-compose.yml pull babelviz-translator

# recreate the container using the pulled image
docker compose -f docker-compose.yml up -d --no-deps --force-recreate babelviz-translator

Stop and remove

docker compose -f docker-compose.with-datapoints.yml down

(Use docker-compose.yml in place of the above if you started only the default file.)

To remove volumes for a clean state:

docker compose -f docker-compose.with-datapoints.yml down -v

Logs & troubleshooting

• Follow logs:

  docker compose -f <file> logs -f
  

• If a dependent service fails to start, check environment variables, network access to PROXY_URL, and license validity.
• If ports conflict, ensure 3000 and 9004 (when running datapoints) are free or adjust ports in the compose files.

Files & conventions

• Use docker-compose.yml as the default, easy command for most users.
• Use docker-compose.with-datapoints.yml only when datapoints functionality is needed and you've been given the specific installation steps by BabelViz Support.
• Keep actual .env out of version control; commit .env.sample with placeholders and comments.