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.
A public IP and a hostname / domain pointing to that IP must be configured. If that is not given check the common problems below.
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.
This also means, that you yourself have the responsibility, that you combine the different licenses and download the different software used by translate5 and use them together. You do this on your own risk and need to make sure, that this works for you from a legal perspective and warranty perspective.
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
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 a .env file
Create a file with name ".env" (nothing before the "." in the file name) and the following content.
Change the values of MYSQL_USERNAME and MYSQL_PASSWORD, if needed/wanted.
Change the value of APP_HOST to the domain under which translate5 should run without leading protocol (so without https://).
The value of COMPOSE_FILE can stay as it is, except if you want also install translate5 Visual (see below in this case).
In case you want to install translate5 Visual, please jump to the instructions for the Visual.
When installing under Windows, the separator between the different yml files in COMPOSE_FILE must be ; (semicolon) instead of : (colon) in the above example.
Execute docker-compose up
Put all 2 (or in case of translate5 Visual usage 3) fetched docker-compose yml files and the generated ".env" file into the same directory and call:
Now everything needed for translate5 will be automatically downloaded, installed and configured for your needs.
Sit back, and watch!
Configure cron jobs (scheduled jobs)
In order that things are working properly in translate5 some regular jobs must be called. Since in the host system mostly a cron is installed, we suggest to add the specific calls to the hosts crontab:
Please adjust the docker container name - localadm-php-1 in the example below. To get the proper name call docker ps.
And adjust the path to the docker binary if needed.
The interval of 15 minutes for the periodical calls should be kept. The point of time for the daily call could be adjusted so that it does not interfer with backups or so.
Alternativ way: call via URL
Additional instructions for users of paid or non-public translate5 plug-ins
Visual / VisualReview
In order to use the Visual plug-in:
- Get a docker hub token from MittagQI
- Login to docker hub with by executing
docker login -u translate5
At the password prompt, enter the personal access token.
- Download the docker-compose.visual.yml
- Change in your ".env" file the value of COMPOSE_FILE to docker-compose.yml:docker-compose.visual.yml:docker-compose.production.yml
- Open the docker-compose.production.yml and search for the following line:
# ENABLE ME IF USING Visual plugin
- Uncomment the 4 lines below this line (remove the starting # from them)
- Go to Execute docker-compose up and follow those intructions. After this paragraph is done, go to General steps for paid/private plug-ins and follow those steps. Then you are done.
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.
On your CMD execute the following:
This steps will be improved in the near future, so that private plug-ins are registered via the config and pulled automatically.
Additional hints for experts regarding optional configuration steps
Editing files in the docker container
It is dangerous to edit files directly in the docker container, since some are overwritten on updating the docker containers (with docker pull) or just updating translate5 itself.
Possible scenarios where this may be needed are described above.
If files must be edited in the docker container (like the installation.ini mentioned below) then there are basically two possibilities:
go into the desired container and edit the file directly with the CLI editor vi :
copy the file out, edit it outside and copy it in again:
By default sending of E-Mails is disabled in translate5 directly in /var/www/translate5/application/config/installation.ini in the php docker container.
- set runtimeOptions.sendMailDisabled = 0 in the installation.ini
- Add the SMTP configuration as described in Mail server as SMTP
Check the e-maling with
SSL Configuration in the delivered nginx proxy
- In the proxy container by default SSL is disabled.
- In order to enable SSL several steps are needed:
expose port 443 in docker-compose.production.yml
Provide the certificate and key files in PEM format. The certificate file should also contain the intermediate files. See https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate
- Place that files on the host server
- Get the the ssl-server.conf template file from inside the docker container and place it beneath your docker-compose.yml files:
docker-compose cp proxy:/etc/nginx/conf.d/ssl-server.conf nginx-server.conf
- Edit the nginx-server.conf locally, if needed.
Mount that nginx-server.conf file and the certificate files into the docker container. So the default /etc/nginx/conf.d/server.conf is overwritten with the ssl one, and also the certificates are mounted into the container.
Recreate the proxy container:
if you don't know what SSL offloading is, just do not read ahead.
SSL Offloading to an external load balancer is possible, the load balancer must support / enable websockets.
- Do not follow the above "SSL Configuration in the delivered nginx proxy" instructions! Keep the ordinary HTTP setup!
Add in your docker-compose.production.yml file a new environment variable HTTPS=on to the php container
This is needed in order that translate5 recognizes that the application is running under https.
Configure Translate5 as it would have SSL (runtimeOptions.server.protocol = https://) and run autodiscovery to configure messagebus correctly.
Jump into the php container and call the autoconfiguration:
DNS resolution in docker container to other docker containers fail
If you experience problems, that the used service names (like termtagger) are not correctly resolving to the correct IP, then follow
If the pdfconverter container is always dying immediately after start-up with message "[WARNING] The local web server is already running".
This happens mostly after stopping and starting the container.
The easiest solution is to stop, remove and recreate the container:
Use a local setup only
If you do not plan to make the installation public and you just want to evaluate translate5 locally, you have to do the following additional steps:
Set APP_HOST in your .env file to localhost.
Or if you wanna use a different hostname pointing to 127.0.0.1, configure that in your /etc/hosts file first.