System administrators

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

This is installation is for new installations. If you upgrade from an existing installation see translate5 > 5.8.0 - needed visualreview to docker migration

Precondition on host system

On the host system docker and docker-compose must be installed.

License agreement

The translate5 installation consists of several Docker images providing the needed software apart from translate5 itself.

In order to use the docker compose files you have to remove the whole LICENSE DISCLAIMER, from START to END.

By removing these lines you accept the several different licenses used by the main software brought contained in each of the docker images, that you install. Which license this is you can see in the readme of every of those images on dockerhub.

As with all Docker images, the installed images likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of these images complies with any relevant licenses for all software contained within.

Install translate5 and its services

get docker-compose.yml

Get the latest docker-compose.yml file.

Remove the license disclaimer from the file before using it!

get docker-compose.production.yml - change if needed

Get the latest docker-compose.production.yml file - which is an addition to the base config file from above.

Changes regarding your local setup should be done in that file. This may be the configuration of volumes, host and port configurations.

The production file configures several volumes where your data is stored.

create .env:

CONTAINER_REGISTRY_BASE=translate5
MYSQL_USERNAME=translate5
MYSQL_PASSWORD=translate5
APP_HOST=t5docker.localdev
COMPOSE_FILE=docker-compose.yml:docker-compose.production.yml

call docker-compose up

Put all fetched docker-compose file and the generated .env file into the same directory and call:

docker compose up -d
# if that it is not possible, try
docker-compose up -d

Important note for paid or private customer specific plug-ins

VisualReview

In order to use visualreview:

  • get a docker hub token from MittagQI
  • login to docker hub with that
  • get docker-compose.visual.yml
  • add to .env docker-compose.yml:docker-compose.visual.yml:docker-compose.production.yml
  • check docker-compose.production.yml and comment in the visual related entries.
  • follow below general steps

General steps for paid/private plug-ins

In order to use paid or private customer specific plug-ins, follow the normal installation. If all is up and running request the installer package containing all private plugins from mittagqi. You will receive an URL pointing to the package.zip.

Go into the translate5 docker container:

docker-compose exec php bash
t5 status 
# now you should be in /var/www/translate5
wget URL_TO_YOUR.zip
./install-and-update.sh YOUR.zip
t5 service:autodiscovery -s


This steps will be improved in the near future, so that private plug-ins are registered via the config and pulled automatically.

SSL Offloading

SSL Offloading to an external LB is possible, the LB must support / enable websockets.

  1. Configure Translate5 as it would have SSL (server.protocol = https://) and run autodiscovery to configure messagebus correctly.
  2. In the proxy container of translate5 modify /etc/nginx/conf.d/server.conf and duplicate the /ws/ location block with /wss/.

The last step is needed since the /wss/ location block is normally in the ssl-server.conf which is not used since SSL is offloaded.

  • No labels