6.0 KiB
Setup LibreTranslate Translation on Local Computer using Docker
Yimmenu's chat translation feature relies on LibreTranslate. This guide will help you setup LibreTranslate translation service on your computer.
Table of Contents
Quick Start
1. Install Docker
Windows: Install Docker on Windows
Linux: Install Docker on Linux
Mac: Install Docker on Mac
For Windows users, after running the Docker Desktop installer, simply click OK, and the installer will automatically complete all steps. If you haven't enabled WSL in control panel, restart Windows as prompted after installation to use Docker.
2. Run Docker Desktop
You must run Docker Desktop and complete the initialization configuration before proceeding.
Open Docker Desktop from the desktop shortcut or start menu
Click Accept to agree to Docker Desktop's Terms of Service
Click Continue without signing in and then skip survey
You can proceed to the next step when you see the green "Engine Running" indicator at the bottom left of the Docker Desktop main window.
3. Download LibreTranslate Setup Script
Windows: Download run.bat
Linux/Mac: Download run.sh
4. Run Setup Script
Running the script will automatically download LibreTranslate images and all supported languages. This process may take a few minutes.
When the console outputs Running on http://*:5000, it means LibreTranslate has successfully run on port 5000. You can now turn on the chat translation switch in Yimmenu and configure the target language.
To stop LibreTranslate, press Ctrl+C in the command prompt window.
After completing the initial installation, to start LibreTranslate, you only need to open Docker Desktop and then run the LibreTranslate setup script.
Advanced
How to Add Startup Arguments
Open Command Prompt or Linux Shell and use the cd command to navigate to the directory where run.bat or run.sh is located. For example, if your run.bat file is in E:\git-repo\LibreTranslate\run.bat, you need to use the command cd /d "E:\git-repo\LibreTranslate".
Run with additional arguments:
Linux/macOS: ./run.sh [args]
Windows: run.bat [args]
LibreTranslate supports various parameters, see here for details.
Common Arguments
This document only lists the most likely parameters to be used as the backend service for Yimmenu chat translation.
1. Specify Languages to Download
If you don't want the translation models to take up too much space, you can add parameters to specify which models to load. See the full language support list here.
For example, if you only need Chinese-English translation, you can use the command run.bat --load-only zh,en --update-models.
2. Specify IP Address Binding
If you don't want the LibreTranslate translation service to be exposed to networks outside your local computer, you can use --host [ip] to modify the IP address bound by LibreTranslate. When set to 127.0.0.1, other computers on the LAN will be unable to access LibreTranslate service on your computer.
For example, run.bat --host 127.0.0.1.
3. Specify Listening Port
If other programs need to use port 5000, you can use the --port [port] parameter to customize the listening port of LibreTranslate.
For example, run.bat --port 8080.
If you change the listening port of LibreTranslate, please fill in the same port in the URL setting of Yimmenu chat translation settings.
Removal
Uninstall Docker
If your Docker is only used to run LibreTranslate, you can uninstall Docker directly from the control panel or Windows settings after stopping LibreTranslate, and LibreTranslate will be completely removed as well.
Remove LibreTranslate from Docker
If you wish to uninstall LibreTranslate while keeping other containers, please follow this guide.
Using Docker Desktop
You can easily remove all images and volumes of LibreTranslate using the GUI of Docker Desktop. Please ensure that LibreTranslate is not running.
Using Docker Command
If you are using Docker Engine for Linux/Mac, you can also remove LibreTranslate using docker command:
docker image rm libretranslate/libretranslate
docker volume rm lt-db
docker volume rm lt-local