System administrators

Page tree

Versions Compared

Old Version 40

changes.mady.by.user Aleksandar Mitrev

Saved on

compared with

New Version 41

changes.mady.by.user Marc Mittag

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

🚀 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 .env file for you.

  • Starts the Translate5 Docker stack with one command.

📦 Installation Steps

  1. Download the Installer Package Get the latest release zip from: https://downloads.translate5.net/translate5-installer.zip

  2. Extract the files Unzip the contents into a new folder.

  3. Run the installer

  • Read and accept the license disclaimer

    You’ll be prompted to manually remove the LICENSE DISCLAIMER from docker-compose.yml before installation can proceed.

  • Done! Open your browser at http://t5docker.localdev (or your configured domain).

(Manual step) Get docker-compose.yml

...

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
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.

Sit back, and watch!

Configure cron jobs (scheduled jobs)

...

Note

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.

...