...
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.
License agreement
The translate5 installation consists of several Docker images providing the needed software apart from translate5 itself.
| Note |
|---|
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
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 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.
| Code Block |
|---|
CONTAINER_REGISTRY_BASE=translate5
MYSQL_USERNAME=translate5
MYSQL_PASSWORD=translate5
APP_HOST=t5docker.localdev
COMPOSE_FILE=docker-compose.yml:docker-compose.production.yml
|
| Note |
|---|
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:
| Code Block |
|---|
docker compose up -d
# If the above command returns an error, try the following command
docker-compose up -d |
Now everything needed for translate5 will be automatically downloaded, installed and configured for your needs.
...
🚀 Quick Start with the Simple Installer
We’ve added a new lightweight installer to make your setup fast and easy—no more manual file edits or guesswork!
✅ What it does:
Guides you through setting up MySQL credentials and your domain.
Checks that you’ve accepted the license disclaimer.
Creates the
.envfile for you.Starts the Translate5 Docker stack with one command.
📦 Installation Steps
Download the Installer Package Get the latest release zip from: https://downloads.translate5.net/translate5-installer.zip
Extract the files Unzip the contents into a new folder.
Run the installer
Read and accept the license disclaimer
You’ll be prompted to manually remove the LICENSE DISCLAIMER from
docker-compose.ymlbefore installation can proceed.- Make sure, translate5 is up2date: Follow Updating a docker-based installation
Done! Open your browser at
http://t5docker.localdev(or your configured domain).
...
Configure cron jobs (scheduled jobs)
...
| Code Block |
|---|
*/15 * * * * /usr/bin/docker exec localadm-php-1 t5 cron 30 23 * * * /usr/bin/docker exec localadm-php-1 t5 cron --daily |
Alternativ way: call via URL
| Anchor | ||||
|---|---|---|---|---|
|
...
| Note |
|---|
In order to use the Visual plug-in:
|
...
| Code Block | ||
|---|---|---|
| ||
docker-pdfconverter-1 | [WARNING] The local web server is already running docker-pdfconverter-1 | docker-pdfconverter-1 | docker-pdfconverter-1 | Local Web Server docker-pdfconverter-1 | Listening on http://127.0.0.1:8086 docker-pdfconverter-1 | The Web server is using PHP FPM 7.4.33 (from default version in $PATH) docker-pdfconverter-1 | docker-pdfconverter-1 | Local Domains docker-pdfconverter-1 | docker-pdfconverter-1 | Workers docker-pdfconverter-1 | No Workers docker-pdfconverter-1 | docker-pdfconverter-1 | Environment Variables docker-pdfconverter-1 | None |
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:
| Code Block | ||||
|---|---|---|---|---|
| ||||
services:
proxy:
ports:
- "127.0.0.1:80:80" # map
extra_hosts:
- ${APP_HOST}:127.0.0.1 |
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.