You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Piero Toffanin d714ce2342 Bump version 6 days ago
.github/workflows Fix test workflow 7 months ago
app Add HTML note in README, tweak swagger def 1 week ago
tests Fixed all pep8 errors 4 months ago
.dockerignore fixup! fix(docker): ignore .git 8 months ago
.gitignore API keys support, bug fixes, improvements 7 months ago
.gitmodules Removed models submodule 7 months ago
Dockerfile add an option to include the language models into the Docker image 6 months ago Update 2 months ago
LICENSE Initial commit 9 months ago Update 1 week ago
docker-compose.yml Add Dockerfile to build and run LibreTranslate as a Docker image. Also added a docker-compose.yml file to provide a reproducible way to run the Docker image. And finally added how to build and run the Docker image to the Tested with local deployment on port 5000 and public HTTPS deployment using a docker based nginx-proxy 9 months ago Fixed all pep8 errors 4 months ago Update 7 months ago API keys support, bug fixes, improvements 7 months ago
requirements.txt Add translatehtml as requirement 1 week ago
setup.cfg Update setup.cfg 4 months ago Bump version 6 days ago wsgi support 2 months ago


Try it online! | API Docs | Community Forum

Python versions Run tests Publish to DockerHub Publish to GitHub Container Registry Awesome Humane Tech

Free and Open Source Machine Translation API, entirely self-hosted. Unlike other APIs, it doesn't rely on proprietary providers such as Google or Azure to perform translations. Instead, its translation engine is powered by the open source Argos Translate library.


Try it online! | API Docs

API Examples

Plain Text


const res = await fetch("", {
	method: "POST",
	body: JSON.stringify({
		q: "Hello!",
		source: "en",
		target: "es"
	headers: { "Content-Type": "application/json" }

console.log(await res.json());


    "translatedText": "¡Hola!"

HTML (beta)


const res = await fetch("", {
	method: "POST",
	body: JSON.stringify({
		q: '<p class="green">Hello!</p>',
		source: "en",
		target: "es",
		format: "html"
	headers: { "Content-Type": "application/json" }

console.log(await res.json());


    "translatedText": "<p class=\"green\">¡Hola!</p>"

Install and Run

You can run your own API server in just a few lines of setup!

Make sure you have installed Python (3.8 or higher is recommended), then simply issue:

pip install libretranslate
libretranslate [args]

Then open a web browser to http://localhost:5000

If you're on Windows, we recommend you Run with Docker instead.

On Ubuntu 20.04 you can also use the install script available on

Build and Run

If you want to make some changes to the code, you can build from source, and run the API:

git clone
cd LibreTranslate
pip install -e .
libretranslate [args]

# Or
python [args]

Then open a web browser to http://localhost:5000

Run with Docker

Simply run:

docker run -ti --rm -p 5000:5000 libretranslate/libretranslate

Then open a web browser to http://localhost:5000

Build with Docker

docker build [--build-arg with_models=true] -t libretranslate .

If you want to run the Docker image in a complete offline environment, you need to add the --build-arg with_models=true parameter. Then the language models get downloaded during the build process of the image. Otherwise these models get downloaded on the first run of the image/container.

Run the built image:

docker run -it -p 5000:5000 libretranslate [args]

Or build and run using docker-compose:

docker-compose up -d --build

Feel free to change the docker-compose.yml file to adapt it to your deployment needs, or use an extra file for your deployment configuration.


Argument Description Default Env. name
--host Set host to bind the server to LT_HOST
--port Set port to bind the server to 5000 LT_PORT
--char-limit Set character limit No limit LT_CHAR_LIMIT
--req-limit Set maximum number of requests per minute per client No limit LT_REQ_LIMIT
--batch-limit Set maximum number of texts to translate in a batch request No limit LT_BATCH_LIMIT
--ga-id Enable Google Analytics on the API client page by providing an ID No tracking LT_GA_ID
--debug Enable debug environment False LT_DEBUG
--ssl Whether to enable SSL False LT_SSL
--frontend-language-source Set frontend default language - source en LT_FRONTEND_LANGUAGE_SOURCE
--frontend-language-target Set frontend default language - target es LT_FRONTEND_LANGUAGE_TARGET
--frontend-timeout Set frontend translation timeout 500 LT_FRONTEND_TIMEOUT
--api-keys Enable API keys database for per-user rate limits lookup Don't use API keys LT_API_KEYS
--require-api-key-origin Require use of an API key for programmatic access to the API, unless the request origin matches this domain No restrictions on domain origin LT_REQUIRE_API_KEY_ORIGIN
--load-only Set available languages all from argostranslate LT_LOAD_ONLY

Note that each argument has an equivalent env. variable that can be used instead. The env. variables overwrite the default values but have lower priority than the command aguments. They are particularly useful if used with Docker. Their name is the upper-snake case of the command arguments' ones, with a LT prefix.

Run with Gunicorn

pip install gunicorn
gunicorn --bind 'wsgi:app'

You can pass application arguments directly to Gunicorn via:

gunicorn --bind 'wsgi:app(api_keys=True)'

Manage API Keys

LibreTranslate supports per-user limit quotas, e.g. you can issue API keys to users so that they can enjoy higher requests limits per minute (if you also set --req-limit). By default all users are rate-limited based on --req-limit, but passing an optional api_key parameter to the REST endpoints allows a user to enjoy higher request limits.

To use API keys simply start LibreTranslate with the --api-keys option.

Add New Keys

To issue a new API key with 120 requests per minute limits:

ltmanage keys add 120

Remove Keys

ltmanage keys remove <api-key>

View Keys

ltmanage keys

Language Bindings

You can use the LibreTranslate API using the following bindings:

More coming soon!

Discourse Plugin

You can use this discourse translator plugin to translate Discourse topics. To install it simply modify /var/discourse/containers/app.yml:

## Plugins go here
## see for details
    - exec:
        cd: $home/plugins
          - git clone
          - git clone

Then issue ./launcher rebuild app. From the Discourse's admin panel then select "LibreTranslate" as a translation provider and set the relevant endpoint configurations.

Mobile Apps

Web browser


This is a list of online resources that serve the LibreTranslate API. Some require an API key. If you want to add a new URL, please open a pull request.

URL API Key Required Contact Cost ✔️ UAV4GEO $9 / month, 80 requests / minute limit - - - - - - - -


Help us by opening a pull request!


Can I use your API server at for my application in production?

The API on should be used for testing, personal or infrequent use. If you're going to run an application in production, please get in touch to get an API key or discuss other options.

Can I use this behind a reverse proxy, like Apache2?

Yes, here is an example Apache2 config that redirects a subdomain (with HTTPS certificate) to LibreTranslate running on a docker at localhost.

sudo docker run -ti --rm -p libretranslate/libretranslate

You can remove on the above command if you want to be able to access it from domain.tld:5000, in addition to subdomain.domain.tld (this can be helpful to determine if there is an issue with Apache2 or the docker container).

Add --restart unless-stopped if you want this docker to start on boot, unless manually stopped.

Apache config

Replace [YOUR_DOMAIN] with your full domain; for example, translate.domain.tld or libretranslate.domain.tld.

Remove # on the ErrorLog and CustomLog lines to log requests.


#Redirect http to https
<VirtualHost *:80>
    ServerName http://[YOUR_DOMAIN]
    Redirect / https://[YOUR_DOMAIN]
    # ErrorLog ${APACHE_LOG_DIR}/error.log
    # CustomLog ${APACHE_LOG_DIR}/tr-access.log combined

<VirtualHost *:443>
    ServerName https://[YOUR_DOMAIN]
    ProxyPass /
    ProxyPassReverse /

    SSLEngine on
    SSLCertificateFile /etc/letsencrypt/live/[YOUR_DOMAIN]/fullchain.pem
    SSLCertificateKeyFile /etc/letsencrypt/live/[YOUR_DOMAIN]/privkey.pem
    SSLCertificateChainFile /etc/letsencrypt/live/[YOUR_DOMAIN]/fullchain.pem
    # ErrorLog ${APACHE_LOG_DIR}/tr-error.log
    # CustomLog ${APACHE_LOG_DIR}/tr-access.log combined

Add this to an existing site config, or a new file in /etc/apache2/sites-available/new-site.conf and run sudo a2ensite new-site.conf.

To get a HTTPS subdomain certificate, install certbot (snap), run sudo certbot certonly --manual --preferred-challenges dns and enter your information (with subdomain.domain.tld as the domain). Add a DNS TXT record with your domain registrar when asked. This will save your certificate and key to /etc/letsencrypt/live/{subdomain.domain.tld}/. Alternatively, comment the SSL lines out if you don't want to use HTTPS.


This work is largely possible thanks to Argos Translate, which powers the translation engine.


GNU Affero General Public License v3