Installing using Docker¶
With dockerized Weblate deployment you can get your personal Weblate instance up and running in seconds. All of Weblate’s dependencies are already included. PostgreSQL is set up as the default database and Valkey as a caching backend.
Hardware requirements¶
Weblate should run on any contemporary hardware without problems, the following is the minimal configuration required to run Weblate on a single host (Weblate, database and web server):
3 GB of RAM
2 CPU cores
1 GB of storage space
Nota
Actual requirements for your installation of Weblate vary heavily based on the size of the translations managed in it.
Utilizzo della memoria¶
The more memory the better - it is used for caching on all levels (file system, database and Weblate). For hundreds of translation components, at least 4 GB of RAM is recommended.
Suggerimento
For systems with less memory than recommended, Single-process Celery setup is recommended.
CPU usage¶
Many concurrent users increase the amount of needed CPU cores.
Weblate 2026.8 introduced NumPy as a required dependency. On x86-64 systems, the optimized NumPy build bundled in the Docker image requires an x86-64-v2 compatible CPU. Without the required CPU features, NumPy fails to load and Weblate cannot start.
Before upgrading, check for the required SSE4.2 CPU feature on the Linux system running Docker:
grep sse4_2 /proc/cpuinfo
Empty output indicates that a required CPU feature is unavailable. This is a preliminary check; finding SSE4.2 does not verify all x86-64-v2 CPU features.
If Docker runs in a virtual machine, run the check inside the guest. Virtual machines can hide CPU features supported by the host. Configure the virtual machine to expose the required host CPU features, then reboot the guest. If the physical CPU lacks the required features, upgrade the hardware.
Utilizzo spazio di archiviazione¶
The typical database storage usage is around 300 MB per 1 million hosted words.
Storage space needed for cloned repositories varies, but Weblate tries to keep their size minimal by doing shallow clones.
Storage performance¶
Version control operations perform many filesystem metadata lookups. The
vcs subdirectory in DATA_DIR therefore needs low read
latency; storage with slow metadata access can make operations such as
git status take a long time even when its bulk throughput is good.
Keep CACHE_DIR on low-latency local or temporary storage when
possible.
The deployment checks measure metadata lookup latency for both locations and warn when the median latency exceeds 10 milliseconds. This is an approximate point-in-time measurement affected by filesystem and system load. Rerun weblate check --deploy before changing the storage configuration.
Nodes¶
For small and medium-sized sites (millions of hosted words), all Weblate components (see Panoramica dell’architettura) can be run on a single node.
When you grow to hundreds of millions of hosted words, it is recommended to have a dedicated node for database (see Database setup for Weblate).
Installazione¶
Suggerimento
The following examples assume you have a working Docker environment, with
docker-compose-plugin installed. Please check the Docker documentation
for instructions.
This creates a Weblate deployment server via HTTP, so you should place it behind HTTPS terminating proxy. You can also deploy with a HTTPS proxy, see Automatic SSL certificates using Let’s Encrypt. For larger setups, please see Scaling horizontally.
Clone the weblate-docker repo:
git clone https://github.com/WeblateOrg/docker-compose.git weblate-docker cd weblate-docker
Nota
The Docker Compose files are example deployment configurations. Operators typically customize them for their own deployment and maintain those local changes. Weblate application updates are delivered through Docker image tags; there is no release-bound update path for customized Compose files.
Create a
docker-compose.override.ymlfile with your settings. See Docker environment variables for full list of environment variables.services: weblate: image: weblate/weblate:latest environment: WEBLATE_EMAIL_HOST: smtp.example.com WEBLATE_EMAIL_HOST_USER: user WEBLATE_EMAIL_HOST_PASSWORD: pass WEBLATE_SERVER_EMAIL: weblate@example.com WEBLATE_DEFAULT_FROM_EMAIL: weblate@example.com WEBLATE_SITE_DOMAIN: weblate.example.com WEBLATE_ADMIN_PASSWORD: password for the admin user WEBLATE_ADMIN_EMAIL: weblate.admin@example.com ports: - 80:8080
Nota
If
WEBLATE_ADMIN_PASSWORDis not set, the admin user is created with a random password shown on first startup.The provided example makes Weblate listen on port 80, edit the port mapping in the
docker-compose.override.ymlfile to change it.Start Weblate containers:
docker compose up
Enjoy your Weblate deployment, it’s accessible on port 80 of the weblate container.
Vedi anche
Choosing Docker image registry¶
Weblate containers are published to following registries:
Docker Hub, see https://hub.docker.com/r/weblate/weblate
GitHub Packages registry, see https://github.com/WeblateOrg/docker/pkgs/container/weblate
Nota
All examples currently fetch images from Docker Hub, please adjust the configuration accordingly to use a different registry.
Choosing Docker image tag¶
Please choose a tag that matches your environment and expectations:
Nome dell’etichetta |
Descrizione |
Use case |
|---|---|---|
|
Weblate stable release, matches latest tagged release |
Rolling updates in a production environment |
|
Versione stabile di Weblate |
Rolling updates within a calendar year in a production environment |
|
Versione stabile di Weblate |
Rolling updates within a monthly release in a production environment |
|
Versione stabile di Weblate |
Well defined deploy in a production environment |
|
Weblate stable release with development changes in the Docker container (for example updated dependencies) |
Rolling updates in a staging environment |
|
Weblate stable release with development changes in the Docker container (for example updated dependencies) |
Well defined deploy in a staging environment |
|
Development version Weblate from Git |
Rolling updates to test upcoming Weblate features |
|
Development version Weblate from Git |
Well defined deploy to test upcoming Weblate features |
Every image is tested by our CI before it gets published, so even the bleeding version should be quite safe to use.
Full list of published tags can be found at GitHub Packages
Docker container with HTTPS support¶
Please see Installazione for generic deployment instructions, this section only mentions differences compared to it.
SSL terminating proxy¶
SSL can be terminated outside Weblate container. To make this work well together, several headers need to be passed to the container so that it is aware of its actual environment. In more detail, these headers are described in Running behind reverse proxy.
location / {
proxy_pass http://127.0.0.1:8080;
proxy_read_timeout 3600s;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-Proto https;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Host $server_name;
}
WEBLATE_ENABLE_HTTPS=1
WEBLATE_IP_PROXY_HEADER=HTTP_X_FORWARDED_FOR
WEBLATE_TRUSTED_PROXY_ADDRESSES=192.0.2.10
Replace the example trusted proxy address with the address or network of the reverse proxy as seen by the Weblate container. Make sure that untrusted clients cannot reach a published container port by bypassing the reverse proxy.
If the reverse proxy runs on the Docker host, you can give the host gateway a
persistent name in docker-compose.override.yml and trust that name:
services:
weblate:
extra_hosts:
- "host.docker.internal:host-gateway"
environment:
WEBLATE_TRUSTED_PROXY_ADDRESSES: host.docker.internal
Using own SSL certificates¶
In case you have own SSL certificate you want to use, simply place the files into the Weblate data volume (see Docker container volumes):
ssl/fullchain.pemcontaining the certificate including any needed CA certificatesssl/privkey.pemcontaining the private key
Both of these files must be owned by the same user as the one starting the docker container and have file mask set to 600 (readable and writable only by the owning user).
Additionally, Weblate container will now accept SSL connections on port 4443, you will want to include the port forwarding for HTTPS in docker compose override:
version: '3'
services:
weblate:
ports:
- 80:8080
- 443:4443
If you already host other sites on the same server, it is likely ports 80 and 443 are used by a reverse proxy, such as NGINX. To pass the HTTPS connection from NGINX to the docker container, you can use the following configuration:
server {
listen 443 ssl;
listen [::]:443 ssl;
server_name <SITE_URL>;
ssl_certificate /etc/letsencrypt/live/<SITE>/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/<SITE>/privkey.pem;
location / {
proxy_set_header HOST $host;
proxy_set_header X-Forwarded-Proto https;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Host $server_name;
proxy_pass https://127.0.0.1:<EXPOSED_DOCKER_PORT>;
}
}
Replace <SITE_URL>, <SITE> and <EXPOSED_DOCKER_PORT> with actual values from your environment.
Trusting custom CA certificates¶
Added in version 2026.11.
When Weblate connects to services secured by certificates issued by a private certificate authority (for example an internal SMTP, LDAP, or Git server), place the CA certificates into the Weblate data volume (see Docker container volumes):
ssl/ca-certificates/containing one or more.crtfiles in PEM format
On every container start, the certificates are combined with the system CA
bundle and made available to Python (requests), OpenSSL, libcurl, and Git
via REQUESTS_CA_BUNDLE, SSL_CERT_FILE, CURL_CA_BUNDLE, and
GIT_SSL_CAINFO. The system trust store is not modified, and removing a
.crt file from the directory removes it from the bundle on the next
start.
Nota
Only files with the .crt extension are picked up.
Nota
Weblate runs repository operations (clone, fetch, push) with a cleaned-up
environment, but passes the CA certificate variables (SSL_CERT_FILE,
SSL_CERT_DIR, GIT_SSL_CAINFO, GIT_SSL_CAPATH,
REQUESTS_CA_BUNDLE and CURL_CA_BUNDLE) through to Git and other
subprocesses, so HTTPS Git remotes trust the CA as well.
Automatic SSL certificates using Let’s Encrypt¶
In case you want to use Let’s Encrypt
automatically generated SSL certificates on public installation, you need to
add a reverse HTTPS proxy an additional Docker container, https-portal will be used for that.
This is made use of in the docker-compose-https.yml file. Then create
a docker-compose-https.override.yml file with your settings:
version: '3'
services:
weblate:
environment:
WEBLATE_EMAIL_HOST: smtp.example.com
WEBLATE_EMAIL_HOST_USER: user
WEBLATE_EMAIL_HOST_PASSWORD: pass
WEBLATE_SITE_DOMAIN: weblate.example.com
WEBLATE_ADMIN_PASSWORD: password for admin user
https-portal:
environment:
DOMAINS: 'weblate.example.com -> http://weblate:8080'
Whenever invoking docker compose you need to pass both files to it, and then do:
docker compose -f docker-compose-https.yml -f docker-compose-https.override.yml build
docker compose -f docker-compose-https.yml -f docker-compose-https.override.yml up
Upgrading the Docker container¶
Usually it is good idea to only update the Weblate container and keep the PostgreSQL container at the version you have, as upgrading PostgreSQL is quite painful and in most cases does not bring many benefits.
You can do this by sticking with the existing docker-compose and just pull the latest images and then restart:
# Fetch latest versions of the images
docker compose pull
# Stop and destroy the containers
docker compose down
# Spawn new containers in the background
docker compose up -d
# Follow the logs during upgrade
docker compose logs -f
The Weblate database should be automatically migrated on first startup, and there should be no need for additional manual actions.
Nota
Direct upgrades are only supported for releases from the current or previous calendar year. If you need to upgrade from an older release, upgrade first to an intermediate version listed in Istruzioni specifiche per la versione.
If you use the example Compose files without local changes, you can also
review updates in the docker-compose repository, though this is not needed
for most Weblate upgrades. Customized Compose files need to be maintained as
part of your deployment. See Upgrading PostgreSQL container for upgrading the
PostgreSQL server.
Upgrading PostgreSQL container¶
Nota
PostgreSQL 18 changed the default data directory inside the container. A
common older setup mounted the database volume at
/var/lib/postgresql/data, while PostgreSQL 18 now uses
/var/lib/postgresql by default.
If you are upgrading from an older version, either update the mount target
in your Docker configuration to the new path, or keep the old mount target
and set PGDATA accordingly.
Leaving the old mount target unchanged without setting PGDATA can cause
PostgreSQL to write its data outside the persisted volume.
See PGDATA documentation for more information.
PostgreSQL containers do not support automatic upgrading between version, you need to perform the upgrade manually. Following steps show one of the options of upgrading.
Arresta contenitore Weblate:
docker compose stop weblate cache
Backup the database:
docker compose exec database pg_dumpall --clean --if-exists --username weblate > backup.sql
Stop the database container:
docker compose stop database
Rimuovere il volume PostgreSQL:
docker compose rm -v database docker volume remove weblate-docker_postgres-data
Suggerimento
The volume name contains name of the Docker Compose project, which is by default the directory name what is
weblate-dockerin this documentation.Adjust
docker-compose.ymlto use new PostgreSQL version.Start the database container:
docker compose up -d database
Restore the database from the backup:
cat backup.sql | docker compose exec -T database psql --username weblate --dbname weblate
Suggerimento
Please check that the database name matches
POSTGRES_DB.(Optional) Update password for the Weblate user. This might be needed when migrating to PostgreSQL 14 or 15 as way of storing passwords has been changed:
docker compose exec -T database psql --username weblate --dbname weblate -c "ALTER USER weblate WITH PASSWORD 'weblate'"
Suggerimento
Please check that the database name matches
POSTGRES_DB.Avvia tutti i contenitori rimanenti:
docker compose up -d
Accesso amministratore¶
After container setup, you can sign in as admin user with password provided
in WEBLATE_ADMIN_PASSWORD, or a random password generated on first
start if that was not set.
To reset admin password, restart the container with
WEBLATE_ADMIN_PASSWORD set to new password.
Number of processes and memory consumption¶
The number of worker processes for both the web application and Celery is determined automatically based on number of CPUs. This works well for most cloud virtual machines as these typically have few CPUs and good amount of memory.
By default, one combined Celery worker handles all task queues using a prefork
pool with three times WEBLATE_WORKERS processes. Sharing the initial
application memory between all Celery workers reduces memory usage while the
higher process count increases task throughput.
In case you have a lot of CPU cores and hit out of memory issues, try reducing number of workers:
environment:
WEBLATE_WORKERS: 2
You can fine-tune the combined worker:
environment:
CELERY_COMBINED_OPTIONS: --concurrency 12 --prefetch-multiplier 1
Alternatively, use the split mode to run and fine-tune individual worker categories:
environment:
CELERY_WORKER_MODE: split
WEB_WORKERS: 4
WEB_BLOCKING_THREADS: 4
CELERY_MAIN_OPTIONS: --concurrency 2 --prefetch-multiplier 1
CELERY_NOTIFY_OPTIONS: --concurrency 1 --prefetch-multiplier 4
CELERY_MEMORY_OPTIONS: --concurrency 1 --prefetch-multiplier 1
CELERY_TRANSLATE_OPTIONS: --concurrency 1 --prefetch-multiplier 1
CELERY_BACKUP_OPTIONS: --concurrency 1 --prefetch-multiplier 1
The prefetch multiplier controls how many tasks each worker execution slot can reserve. The default of one avoids reserving additional long-running or payload-heavy tasks. The notification worker uses four in this example because its short tasks can benefit from buffering. Increase the value only after measuring queue latency and worker memory usage.
Memory usage can be further reduced by running Celery in a single process:
environment:
CELERY_WORKER_MODE: single
Scaling horizontally¶
Added in version 4.6.
You can run multiple Weblate containers to scale the service horizontally. The
/app/data volume has to be shared by all containers, it is recommended
to use cluster filesystem such as GlusterFS for this. The /app/cache
volume should be separate for each container.
Each Weblate container has defined role using WEBLATE_SERVICE
environment variable. Please follow carefully the documentation as some of the
services should be running just once in the cluster, and the order of the
services matters as well.
You can find example setup in the docker-compose repo as
docker-compose-split.yml.
Startup configuration warnings¶
The Docker container records actionable configuration warnings from startup
in the shared /app/data volume. They are shown by
weblate check --deploy and in the Rapporto prestazioni
management interface, in addition to being written to the container log.
Each container reports its warnings separately. This keeps warnings from
containers with different WEBLATE_SERVICE roles visible in a
horizontally scaled deployment. Reports are refreshed while their container is
running and are removed during an orderly container shutdown. Reports left by
an abrupt shutdown expire after five minutes, and stale report files are
cleaned up automatically by later container startups.
Docker environment variables¶
Many of Weblate’s Configurazione can be set in the Docker container using the environment variables described below.
If you need to define a setting not exposed through Docker environment variables, see Configurazione oltre le variabili di ambiente.
Segreti di passaggio¶
Added in version 5.0.
Weblate container supports passing secrets as files. To utilize that, append
_FILE suffix to the environment variable and pass secret file via Docker.
Related docker-compose.yml might look like:
services:
weblate:
environment:
POSTGRES_PASSWORD_FILE: /run/secrets/db_password
secrets:
- db_password
database:
environment:
POSTGRES_PASSWORD_FILE: /run/secrets/db_password
secrets:
- db_password
secrets:
db_password:
file: db_password.txt
Vedi anche
Generic settings¶
- WEBLATE_SECRET_KEY¶
Added in version 2026.12.
Configures Django’s
SECRET_KEY. You can provide the key directly or useWEBLATE_SECRET_KEY_FILEto read it from a mounted secret file:environment: WEBLATE_SECRET_KEY_FILE: /run/secrets/weblate_secret_key
The file variant takes precedence over the direct value. If the resolved key is empty or neither variable is configured, Weblate reads
/app/data/secret. An unreadable file configured throughWEBLATE_SECRET_KEY_FILEcauses a configuration error.Keep the key stable across container restarts and use the same key for all containers in the deployment to preserve sessions and signed links.
Vedi anche
- WEBLATE_DEBUG¶
Configures Django debug mode using
DEBUG.Esempio:
environment: WEBLATE_DEBUG: 1
Vedi anche
- WEBLATE_LOGLEVEL¶
Configures the logging verbosity. Set this to
DEBUGto get more detailed logs.Defaults to
INFOwhenWEBLATE_DEBUGis turned off,DEBUGis used when debug mode is turned on.For more silent logging use
ERRORorWARNING.
- WEBLATE_LOGLEVEL_DATABASE¶
Configures the logging of the database queries verbosity.
- WEBLATE_LOG_GELF_HOST¶
Added in version 5.9.
Configures remote logging using GELF TCP connection. Can be used to integrate with Graylog.
- WEBLATE_LOG_GELF_PORT¶
Added in version 5.9.
Use custom port for
WEBLATE_LOG_GELF_HOST, defaults to 12201.
- WEBLATE_SITE_TITLE¶
Changes the site-title shown in the header of all pages.
- WEBLATE_SITE_DOMAIN¶
Configures the site domain. This parameter is required and accepts a hostname or IPv4 address.
Include a port between 1 and 65535 if using a non-standard one. IPv6 addresses are not currently supported.
Esempio:
environment: WEBLATE_SITE_DOMAIN: example.com:8080
Vedi anche
- WEBLATE_ADMIN_NAME¶
- WEBLATE_ADMIN_EMAIL¶
Configures the site-admin’s name and e-mail. It is used for both
ADMINSsetting and creating admin user (seeWEBLATE_ADMIN_PASSWORDfor more info on that).Esempio:
environment: WEBLATE_ADMIN_NAME: Weblate admin WEBLATE_ADMIN_EMAIL: noreply@example.com
- WEBLATE_ADMIN_PASSWORD¶
Sets the password for the admin user.
If not set and admin user does not exist, it is created with a random password shown on first container startup.
If not set and admin user exists, no action is performed.
If set the admin user is adjusted on every container startup to match
WEBLATE_ADMIN_PASSWORD,WEBLATE_ADMIN_NAMEandWEBLATE_ADMIN_EMAIL.
Avvertimento
It might be a security risk to store password in the configuration file. Consider using this variable only for initial setup (or let Weblate generate random password on initial startup) or for password recovery.
- WEBLATE_ADMIN_NOTIFY_ERROR¶
Whether to send e-mail to admins upon server error. Turned on by default.
You might want to use other error collection like Sentry or Rollbar and turn this off.
Vedi anche
- WEBLATE_SERVER_EMAIL¶
The email address that error messages are sent from.
Vedi anche
- WEBLATE_DEFAULT_FROM_EMAIL¶
Configures the address for outgoing e-mails.
Vedi anche
- WEBLATE_ADMINS_CONTACT¶
Configures
ADMINS_CONTACT.
- WEBLATE_CONTACT_FORM¶
Configures contact form behavior, see
CONTACT_FORM.
- WEBLATE_ALLOWED_HOSTS¶
Configures allowed HTTP hostnames using
ALLOWED_HOSTS.Defaults to
*which allows all hostnames.Esempio:
environment: WEBLATE_ALLOWED_HOSTS: weblate.example.com,example.com
- WEBLATE_REGISTRATION_OPEN¶
Configures whether registrations are open by toggling
REGISTRATION_OPEN.Esempio:
environment: WEBLATE_REGISTRATION_OPEN: 0
- WEBLATE_REGISTRATION_CAPTCHA¶
Added in version 5.10.
Configures whether captcha is used for registration and other unauthenticated actions, see
REGISTRATION_CAPTCHA.Esempio:
environment: WEBLATE_REGISTRATION_CAPTCHA: 0
- WEBLATE_REGISTRATION_ALLOW_BACKENDS¶
Configure which authentication methods can be used to create new account via
REGISTRATION_ALLOW_BACKENDS.Esempio:
environment: WEBLATE_REGISTRATION_OPEN: 0 WEBLATE_REGISTRATION_ALLOW_BACKENDS: azuread-oauth2,azuread-tenant-oauth2
- WEBLATE_REGISTRATION_REBIND¶
Added in version 4.16.
Configures
REGISTRATION_REBIND.
- WEBLATE_REGISTRATION_ALLOW_DISPOSABLE_EMAILS¶
Added in version 5.16.1.
Configura
REGISTRATION_ALLOW_DISPOSABLE_EMAILS.Esempio:
environment: WEBLATE_REGISTRATION_ALLOW_DISPOSABLE_EMAILS: 1
- WEBLATE_PROJECT_WEB_RESTRICT_PRIVATE¶
Added in version 5.17.
Configura
PROJECT_WEB_RESTRICT_PRIVATE.Il valore predefinito è abilitato.
- WEBLATE_PROJECT_WEB_RESTRICT_ALLOWLIST¶
Added in version 5.17.
Configures
PROJECT_WEB_RESTRICT_ALLOWLIST.Expects a comma-separated list of trusted project slugs.
- WEBLATE_WEBHOOK_RESTRICT_PRIVATE¶
Added in version 5.17.
Configures
WEBHOOK_RESTRICT_PRIVATE.Il valore predefinito è abilitato.
- WEBLATE_WEBHOOK_PRIVATE_ALLOWLIST¶
Added in version 5.17.
Configures
WEBHOOK_PRIVATE_ALLOWLIST.Expects a comma-separated list of trusted hostnames or domains.
- WEBLATE_ALLOWED_ASSET_SIZE¶
Added in version 2025.7.
Configures
ALLOWED_ASSET_SIZE.
- WEBLATE_ASSET_RESTRICT_PRIVATE¶
Added in version 2025.5.
Configures
ASSET_RESTRICT_PRIVATE.Il valore predefinito è abilitato.
- WEBLATE_ASSET_PRIVATE_ALLOWLIST¶
Added in version 2025.5.
Configures
ASSET_PRIVATE_ALLOWLIST.Expects a comma-separated list of trusted hostnames or domains.
- WEBLATE_TIME_ZONE¶
Configures the used time zone in Weblate, see
TIME_ZONE.Nota
To change the time zone of the Docker container itself, use the
TZenvironment variable.Esempio:
environment: WEBLATE_TIME_ZONE: Europe/Prague
- WEBLATE_ENABLE_HTTPS¶
Makes Weblate assume it is operated behind a reverse HTTPS proxy, it makes Weblate use HTTPS in e-mail and API links or set secure flags on cookies.
Suggerimento
Please see
ENABLE_HTTPSdocumentation for possible caveats.Nota
This does not make the Weblate container accept HTTPS connections, you need to configure that as well, see Docker container with HTTPS support for examples.
Esempio:
environment: WEBLATE_ENABLE_HTTPS: 1
- WEBLATE_NGINX_IPV6¶
Added in version 5.17.
Controls whether the bundled NGINX listens on IPv6 addresses.
I valori supportati sono:
autoto enable IPv6 listeners only when IPv6 is available in the container runtime. This is the default.onto always enable IPv6 listeners.offto disable IPv6 listeners.
Esempio:
environment: WEBLATE_NGINX_IPV6: auto
- WEBLATE_IP_PROXY_HEADER¶
Lets Weblate fetch the IP address from any given HTTP header. Use this when using a reverse proxy in front of the Weblate container.
Enables
IP_BEHIND_REVERSE_PROXYand setsIP_PROXY_HEADER.When set to
HTTP_X_FORWARDED_FOR, the bundled nginx resolves the client address usingWEBLATE_TRUSTED_PROXY_ADDRESSES, uses that address in its logs, and forwards one normalized address to Weblate.Cambiato nella versione 2026.9: The bundled nginx no longer trusts
X-Forwarded-Forfrom all network addresses. Trusted proxy addresses have to be configured explicitly.Nota
The format must conform to Django’s expectations. Django transforms raw HTTP header names as follows:
converts all characters to uppercase
replaces any hyphens with underscores
prepends
HTTP_prefix
So
X-Forwarded-Forwould be mapped toHTTP_X_FORWARDED_FOR.Esempio:
environment: WEBLATE_IP_PROXY_HEADER: HTTP_X_FORWARDED_FOR WEBLATE_TRUSTED_PROXY_ADDRESSES: "192.0.2.10 2001:db8::/64 proxy"
- WEBLATE_TRUSTED_PROXY_ADDRESSES¶
Added in version 2026.9.
Configures the IPv4 or IPv6 addresses, networks, or hostnames of reverse proxies trusted by the bundled nginx to supply
X-Forwarded-For. Separate multiple values by whitespace.This setting is used only when
WEBLATE_IP_PROXY_HEADERisHTTP_X_FORWARDED_FOR. If the list is empty, nginx uses the immediate TCP peer in its logs and forwards that address to Weblate.Only list proxies under your control, and do not expose the Weblate container through a path which bypasses them.
Esempio:
environment: WEBLATE_IP_PROXY_HEADER: HTTP_X_FORWARDED_FOR WEBLATE_TRUSTED_PROXY_ADDRESSES: "192.0.2.10 2001:db8::/64 proxy"
- WEBLATE_IP_PROXY_OFFSET¶
Added in version 5.0.1.
Configures
IP_PROXY_OFFSET.When
WEBLATE_IP_PROXY_HEADERisHTTP_X_FORWARDED_FOR, the bundled nginx forwards one normalized address and the container uses an effective offset of0.
- WEBLATE_USE_X_FORWARDED_PORT¶
Added in version 5.0.1.
A boolean that specifies whether to use the X-Forwarded-Port header in preference to the SERVER_PORT META variable. This should only be enabled if a proxy which sets this header is in use.
Vedi anche
Nota
This is a boolean setting (use
"true"or"false").
- WEBLATE_SECURE_PROXY_SSL_HEADER¶
A tuple representing an HTTP header/value combination that signifies a request is secure. This is needed when Weblate is running behind a reverse proxy doing SSL termination which does not pass standard HTTPS headers.
Esempio:
environment: WEBLATE_SECURE_PROXY_SSL_HEADER: HTTP_X_FORWARDED_PROTO,https
- WEBLATE_REQUIRE_LOGIN¶
Enables
REQUIRE_LOGINto enforce authentication on whole Weblate.Esempio:
environment: WEBLATE_REQUIRE_LOGIN: 1
- WEBLATE_LEGAL_INTEGRATION¶
Enables the Modulo giuridico module in Docker deployments. By default, the integration is disabled; leave this variable unset or empty to disable it.
I valori supportati sono:
tos-confirmto enable the legal module and enforce legal document confirmation during social authentication and for signed-in users.wllegalto enable the same integration and additionally load the hosted legal document templates fromwllegal. These templates are used by services operated by Weblate s.r.o. and are not intended for general use.
To provide your own legal documents in Docker, override the templates in
/app/data/python/customize/templates/legal/documents, see Replacing logo and other static files.Recreate the Docker container after changing this environment variable, for example using docker compose up -d. Restarting an existing container does not apply changed environment values.
Esempio:
environment: WEBLATE_LEGAL_INTEGRATION: tos-confirm
- WEBLATE_LEGAL_DOCUMENT_CSS_CLASS¶
Configures
LEGAL_DOCUMENT_CSS_CLASSin Docker deployments withWEBLATE_LEGAL_INTEGRATIONenabled.Set this to the class targeted by your custom legal stylesheet. Set it to an empty string to render legal documents without a wrapper class.
Esempio:
environment: WEBLATE_LEGAL_DOCUMENT_CSS_CLASS: ""
- WEBLATE_LEGAL_HIDDEN_DOCUMENTS¶
Configures
LEGAL_HIDDEN_DOCUMENTSin Docker deployments withWEBLATE_LEGAL_INTEGRATIONenabled.Provide a comma-separated list of legal document page identifiers.
External legal document URLs take priority over internal page links. The following configuration hides the internal pages, links both documents externally, and requires one agreement covering both:
Esempio:
environment: WEBLATE_LEGAL_INTEGRATION: tos-confirm WEBLATE_LEGAL_HIDDEN_DOCUMENTS: terms,privacy WEBLATE_LEGAL_URL: https://example.com/terms/ WEBLATE_PRIVACY_URL: https://example.com/privacy/
- WEBLATE_PUBLIC_ENGAGE¶
Abilita
PUBLIC_ENGAGE.
- WEBLATE_GOOGLE_ANALYTICS_ID¶
Configures ID for Google Analytics by changing
GOOGLE_ANALYTICS_ID.
- WEBLATE_DEFAULT_PULL_MESSAGE¶
Configures the default title and message for pull requests via API by changing
DEFAULT_PULL_MESSAGE.Vedi anche
- WEBLATE_SIMPLIFY_LANGUAGES¶
Configures the language simplification policy, see
SIMPLIFY_LANGUAGES.
- WEBLATE_HIDE_SHARED_GLOSSARY_COMPONENTS¶
Hides glossary components when shared to other projects, see
HIDE_SHARED_GLOSSARY_COMPONENTS.
- WEBLATE_DEFAULT_ACCESS_CONTROL¶
Configures the default Controllo accessi for new projects, see
DEFAULT_ACCESS_CONTROL.
- WEBLATE_DEFAULT_TRANSLATION_REVIEW¶
Added in version 5.16.
Configures the default value for Abilita revisioni, turned off by default.
- WEBLATE_DEFAULT_SOURCE_REVIEW¶
Added in version 5.16.
Configures the default value for Abilita revisioni sorgente, turned off by default.
- WEBLATE_DEFAULT_RESTRICTED_COMPONENT¶
Configures the default value for Restricted access for new components, see
DEFAULT_RESTRICTED_COMPONENT.
- WEBLATE_DEFAULT_TRANSLATION_PROPAGATION¶
Configures the default value for Permetti propagazione traduzione for new components, see
DEFAULT_TRANSLATION_PROPAGATION.
- WEBLATE_DEFAULT_COMMITER_EMAIL¶
Configures
DEFAULT_COMMITER_EMAIL.
- WEBLATE_DEFAULT_COMMITER_NAME¶
Configures
DEFAULT_COMMITER_NAME.
- WEBLATE_DEFAULT_SHARED_TM¶
Configures
DEFAULT_SHARED_TM.
- WEBLATE_DEFAULT_WORKSPACE_TM¶
Configures
DEFAULT_WORKSPACE_TM.
- WEBLATE_DEFAULT_AUTOCLEAN_TM¶
Configura
DEFAULT_AUTOCLEAN_TM.
- WEBLATE_COMMIT_PENDING_HOURS¶
Configura il valore predefinito per Età modifiche per commit per i nuovi componenti, vedere
COMMIT_PENDING_HOURS.
- WEBLATE_GPG_IDENTITY¶
Configures GPG signing of commits, see
WEBLATE_GPG_IDENTITY.Vedi anche
- WEBLATE_URL_PREFIX¶
Configures URL prefix where Weblate is running, see
URL_PREFIX. Leave it empty to serve Weblate at the root, or use slash-separated path segments starting with a slash, for example/translationsor/tools/translations. Each segment can contain ASCII letters, digits,_, and-.
- WEBLATE_SILENCED_SYSTEM_CHECKS¶
Configures checks which you do not want to be displayed, see
SILENCED_SYSTEM_CHECKS.
- WEBLATE_MEDIA_STORAGE_BACKEND¶
- WEBLATE_MEDIA_STORAGE_OPTIONS¶
Added in version 2026.12.
Configures storage for uploaded files, which are stored in the
datavolume by default. This currently covers screenshots; fonts are always stored in thedatavolume. SetWEBLATE_MEDIA_STORAGE_BACKENDto the storage class andWEBLATE_MEDIA_STORAGE_OPTIONSto its options as a JSON object; they configuredefaultinSTORAGES. The image includes django-storages with the Amazon S3 and Google Cloud Storage backends.For example, to use Amazon S3 or an S3-compatible service with credentials from the
AWS_ACCESS_KEY_IDandAWS_SECRET_ACCESS_KEYenvironment variables:environment: WEBLATE_MEDIA_STORAGE_BACKEND: storages.backends.s3.S3Storage WEBLATE_MEDIA_STORAGE_OPTIONS: '{"bucket_name": "weblate-media", "endpoint_url": "https://s3.example.com", "file_overwrite": false}'
Use
WEBLATE_MEDIA_STORAGE_OPTIONS_FILEto pass options containing credentials as a secret, see Segreti di passaggio.Vedi anche
- WEBLATE_CSP_SCRIPT_SRC¶
- WEBLATE_CSP_IMG_SRC¶
- WEBLATE_CSP_CONNECT_SRC¶
- WEBLATE_CSP_STYLE_SRC¶
- WEBLATE_CSP_FONT_SRC¶
- WEBLATE_CSP_FORM_SRC¶
Allows to customize Content-Security-Policy HTTP header.
- WEBLATE_LICENSE_FILTER¶
Configures
LICENSE_FILTER.
- WEBLATE_LICENSE_REQUIRED¶
Configures
LICENSE_REQUIRED.
- WEBLATE_WEBSITE_REQUIRED¶
Configures
WEBSITE_REQUIRED.
- WEBLATE_VERSION_DISPLAY¶
Configures
VERSION_DISPLAY.
- WEBLATE_HIDE_VERSION¶
Configures
HIDE_VERSION.
- WEBLATE_BASIC_LANGUAGES¶
Configures
BASIC_LANGUAGES.
- WEBLATE_DEFAULT_AUTO_WATCH¶
Configures
DEFAULT_AUTO_WATCH.
- WEBLATE_DEFAULT_NOTIFICATIONS¶
Added in version 2026.10.1.
Configures
DEFAULT_NOTIFICATIONS.Esempio:
environment: WEBLATE_DEFAULT_NOTIFICATIONS: 0:1:MentionCommentNotificaton,10:1:LastAuthorCommentNotificaton
- WEBLATE_RATELIMIT_ATTEMPTS¶
- WEBLATE_RATELIMIT_LOCKOUT¶
- WEBLATE_RATELIMIT_WINDOW¶
- WEBLATE_RATELIMIT_OCR_ATTEMPTS¶
- WEBLATE_RATELIMIT_OCR_WINDOW¶
- WEBLATE_RATELIMIT_OCR_LOCKOUT¶
- WEBLATE_RATELIMIT_BULK_EDIT_ATTEMPTS¶
- WEBLATE_RATELIMIT_BULK_EDIT_WINDOW¶
- WEBLATE_RATELIMIT_BULK_EDIT_LOCKOUT¶
- WEBLATE_RATELIMIT_UPLOAD_ATTEMPTS¶
- WEBLATE_RATELIMIT_UPLOAD_WINDOW¶
- WEBLATE_RATELIMIT_UPLOAD_LOCKOUT¶
- WEBLATE_RATELIMIT_MACHINERY_ATTEMPTS¶
- WEBLATE_RATELIMIT_MACHINERY_WINDOW¶
- WEBLATE_RATELIMIT_MACHINERY_LOCKOUT¶
Added in version 4.6.
Configures rate limiter.
Suggerimento
You can set configuration for any rate limiter scopes. To do that add
WEBLATE_prefix to any of setting described in Rate limiting.Vedi anche
- WEBLATE_API_RATELIMIT_ANON¶
- WEBLATE_API_RATELIMIT_USER¶
Added in version 4.11.
Configures
API_RATELIMIT_ANONandAPI_RATELIMIT_USER. Defaults to100/dayfor anonymous and5000/hourfor authenticated users.Vedi anche
- WEBLATE_API_RATELIMIT_USER_OVERRIDES¶
- WEBLATE_API_RATELIMIT_IP_OVERRIDES¶
Added in version 2026.10.
JSON mappings configuring
API_RATELIMIT_USER_OVERRIDESandAPI_RATELIMIT_IP_OVERRIDES. Both default to empty objects. Use JSONnullto exempt a user, IP address, or network from API throttling.For example, in
compose.override.yaml:services: weblate: environment: WEBLATE_API_RATELIMIT_USER_OVERRIDES: '{"automation":"20000/hour"}' WEBLATE_API_RATELIMIT_IP_OVERRIDES: '{"192.0.2.42":null,"198.51.100.0/24":"10000/hour"}'
Username rules take precedence over IP rules. See API rate limiting for counting behavior and proxy configuration requirements.
- WEBLATE_ENABLE_HOOKS¶
Added in version 4.13.
Configures
ENABLE_HOOKS.
- WEBLATE_ENABLE_AVATARS¶
Added in version 4.6.1.
Configures
ENABLE_AVATARS.
- WEBLATE_AVATAR_URL_PREFIX¶
Added in version 4.15.
Configures
AVATAR_URL_PREFIX.
- WEBLATE_AVATAR_URL_TEMPLATE¶
Added in version 2026.10.
Configures
AVATAR_URL_TEMPLATE.
- WEBLATE_LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH¶
Added in version 4.9.
Configures
LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH.
- WEBLATE_SSH_EXTRA_ARGS¶
Added in version 4.9.
Configures
SSH_EXTRA_ARGS.
- WEBLATE_BORG_EXTRA_ARGS¶
Added in version 4.9.
Configures
BORG_EXTRA_ARGSas a comma separated list of args.Esempio:
environment: WEBLATE_BORG_EXTRA_ARGS: --exclude,vcs/
- WEBLATE_ENABLE_SHARING¶
Added in version 4.14.1.
Configures
ENABLE_SHARING.
- WEBLATE_SUPPORT_STATUS_CHECK¶
Added in version 5.5.
Configures
SUPPORT_STATUS_CHECK.
- WEBLATE_EXTRA_HTML_HEAD¶
Added in version 4.15.
Configures
EXTRA_HTML_HEAD.
- WEBLATE_INTERNAL_BOT_EMAIL_TEMPLATE¶
Added in version 2026.7.1.
Configures
INTERNAL_BOT_EMAIL_TEMPLATE.
- WEBLATE_PRIVATE_COMMIT_EMAIL_TEMPLATE¶
Added in version 4.15.
Configures
PRIVATE_COMMIT_EMAIL_TEMPLATE.Vedi anche
- WEBLATE_PRIVATE_COMMIT_EMAIL_OPT_IN¶
Added in version 4.15.
Configures
PRIVATE_COMMIT_EMAIL_OPT_IN.Vedi anche
- WEBLATE_PRIVATE_COMMIT_NAME_TEMPLATE¶
Added in version 5.16.
Configura
PRIVATE_COMMIT_NAME_TEMPLATE.Vedi anche
- WEBLATE_PRIVATE_COMMIT_NAME_OPT_IN¶
Added in version 5.16.
Configura
PRIVATE_COMMIT_NAME_OPT_IN.Vedi anche
To use private commit e-mails and names by default, set both opt-in variables to
Falseindocker-compose.override.yml:services: weblate: environment: WEBLATE_PRIVATE_COMMIT_EMAIL_OPT_IN: "False" WEBLATE_PRIVATE_COMMIT_NAME_OPT_IN: "False"
The default templates use the user ID for both the private e-mail and name. The template variables are optional customizations. Setting the templates alone leaves private commit identities opt-in.
These defaults apply to new and existing users without explicit commit identity choices. Users can still select their account identity. Existing commits are unchanged.
After changing the environment, run
docker compose up -dto recreate the affected containers. Apply the same configuration to separately deployed workers so both web and worker processes use the new defaults.
- WEBLATE_UNUSED_ALERT_DAYS¶
Added in version 4.17.
Configures
UNUSED_ALERT_DAYS.
- WEBLATE_REPORT_EXPIRY¶
Added in version 2026.8.
Configures
REPORT_EXPIRY.
- WEBLATE_UPDATE_LANGUAGES¶
Added in version 4.3.2.
Configures
UPDATE_LANGUAGES.
- WEBLATE_VCS_ALLOW_HOSTS¶
Added in version 5.15.
Configura
VCS_ALLOW_HOSTS.
- WEBLATE_VCS_PRIVATE_ALLOWLIST¶
Added in version 2026.9.
Configures
VCS_PRIVATE_ALLOWLIST.
- WEBLATE_VCS_ALLOW_SCHEMES¶
Added in version 5.15.
Configura
VCS_ALLOW_SCHEMES.The
filescheme is disabled for security reasons. Including it prevents Weblate from starting.
- WEBLATE_VCS_RESTRICT_PRIVATE¶
Added in version 5.17.
Configures
VCS_RESTRICT_PRIVATE.
- WEBLATE_VCS_CLONE_DEPTH¶
Added in version 5.4.
Configura
VCS_CLONE_DEPTH.
- WEBLATE_VCS_API_DELAY¶
Added in version 5.4.
Configura
VCS_API_DELAY.
- WEBLATE_VCS_API_TIMEOUT¶
Added in version 5.15.
Configura
VCS_API_TIMEOUT.
- WEBLATE_CORS_ALLOWED_ORIGINS¶
Added in version 4.16.
Allow CORS requests to API from given origins.
Esempio:
environment: WEBLATE_CORS_ALLOWED_ORIGINS: https://example.com,https://weblate.org
- WEBLATE_CORS_ALLOW_ALL_ORIGINS¶
Added in version 5.6.1: Allows CORS requests to API from all origins.
- WEBLATE_WEBSITE_ALERTS_ENABLED¶
Added in version 5.17.
Configura
WEBSITE_ALERTS_ENABLED.
- CLIENT_MAX_BODY_SIZE¶
Added in version 4.16.3.
Configures maximal body size accepted by the built-in web server. Use a non-negative integer with an optional
k,m, orgsuffix. The suffix is case-insensitive, and0disables the request body size limit.environment: CLIENT_MAX_BODY_SIZE: 200m
Suggerimento
This variable intentionally lacks
WEBLATE_prefix as it is shared with third-party container used in Automatic SSL certificates using Let’s Encrypt.
- WEBLATE_TRANSLATION_MAX_SIZE¶
Configures
TRANSLATION_MAX_SIZEin bytes. When unset, followsWEBLATE_TRANSLATION_UPLOAD_MAX_SIZE.
- WEBLATE_TRANSLATION_MAX_UNITS¶
Configures
TRANSLATION_MAX_UNITS. Defaults to 200,000.
- WEBLATE_TRANSLATION_UPLOAD_MAX_SIZE¶
Configures
TRANSLATION_UPLOAD_MAX_SIZE.The value is in bytes.
- WEBLATE_COMPONENT_ZIP_UPLOAD_MAX_SIZE¶
Configures
COMPONENT_ZIP_UPLOAD_MAX_SIZE.The value is in bytes.
- WEBLATE_PROJECT_BACKUP_UPLOAD_MAX_SIZE¶
Configures
PROJECT_BACKUP_UPLOAD_MAX_SIZE.The value is in bytes. Make sure
CLIENT_MAX_BODY_SIZEis also large enough for uploaded backup files.
- WEBLATE_PROJECT_BACKUP_IMPORT_MAX_MEMBERS¶
Added in version 2026.5.
Configures
PROJECT_BACKUP_IMPORT_MAX_MEMBERS.
- WEBLATE_PROJECT_BACKUP_IMPORT_MAX_TOTAL_UNCOMPRESSED_SIZE¶
Added in version 2026.5.
Configures
PROJECT_BACKUP_IMPORT_MAX_TOTAL_UNCOMPRESSED_SIZE.The value is in bytes.
- WEBLATE_PROJECT_BACKUP_IMPORT_MAX_COMPRESSED_ENTRY_SIZE¶
Added in version 2026.5.
Configures
PROJECT_BACKUP_IMPORT_MAX_COMPRESSED_ENTRY_SIZE.The value is in bytes.
- WEBLATE_PROJECT_BACKUP_IMPORT_MIN_RATIO_SIZE¶
Added in version 2026.5.
Configures
PROJECT_BACKUP_IMPORT_MIN_RATIO_SIZE.The value is in bytes.
- WEBLATE_PROJECT_BACKUP_IMPORT_MAX_COMPRESSED_ENTRY_RATIO¶
Added in version 2026.5.
Configures
PROJECT_BACKUP_IMPORT_MAX_COMPRESSED_ENTRY_RATIO.
Code-hosting sites credentials¶
In the Docker container, the code-hosting credentials can be configured either in separate variables or using a Python dictionary to set them at once. The following examples are for Richieste di pull GitHub, but apply to all Integrazione controllo versione with appropriately changed variable names.
Importante
All environment variable names must include the WEBLATE_ prefix. For example,
to configure GitHub credentials, use WEBLATE_GITHUB_USERNAME, not GITHUB_USERNAME.
This applies whether you’re configuring for pull requests or any other VCS integration.
An example configuration for GitHub pull requests might look like:
WEBLATE_GITHUB_USERNAME=api-user
WEBLATE_GITHUB_TOKEN=api-token
WEBLATE_GITHUB_HOST=api.github.com
Will be used as:
GITHUB_CREDENTIALS = {
"api.github.com": {
"username": "api-user",
"token": "api-token",
}
}
Alternatively the Python dictionary can be provided as a string:
WEBLATE_GITHUB_CREDENTIALS='{ "api.github.com": { "username": "api-user", "token": "api-token", } }'
Oppure il percorso di un file contenente il dizionario Python:
echo '{ "api.github.com": { "username": "api-user", "token": "api-token", } }' > /path/to/github-credentials
WEBLATE_GITHUB_CREDENTIALS_FILE='/path/to/github-credentials'
- WEBLATE_GITHUB_USERNAME¶
- WEBLATE_GITHUB_TOKEN¶
- WEBLATE_GITHUB_HOST¶
- WEBLATE_GITHUB_CREDENTIALS¶
Configures Richieste di pull GitHub by changing
GITHUB_CREDENTIALS.
- WEBLATE_GITHUB_LEGACY_APP_WEBHOOK_SECRET¶
Added in version 2026.8.
Configures
GITHUB_LEGACY_APP_WEBHOOK_SECRET. The_FILEvariant can be used to load the secret from a file.
GitHub Apps registered through the in-app manifest flow are stored in the database and do not need environment variables. See GitHub notifications.
- WEBLATE_GITLAB_USERNAME¶
- WEBLATE_GITLAB_TOKEN¶
- WEBLATE_GITLAB_HOST¶
- WEBLATE_GITLAB_CREDENTIALS¶
Configures Richieste di unione di GitLab by changing
GITLAB_CREDENTIALS.
- WEBLATE_GITEA_USERNAME¶
- WEBLATE_GITEA_TOKEN¶
- WEBLATE_GITEA_HOST¶
- WEBLATE_GITEA_CREDENTIALS¶
Configures Gitea pull requests by changing
GITEA_CREDENTIALS.
- WEBLATE_PAGURE_USERNAME¶
- WEBLATE_PAGURE_TOKEN¶
- WEBLATE_PAGURE_HOST¶
- WEBLATE_PAGURE_CREDENTIALS¶
Configures Richieste di unione di pagine by changing
PAGURE_CREDENTIALS.
- WEBLATE_BITBUCKETSERVER_USERNAME¶
- WEBLATE_BITBUCKETSERVER_TOKEN¶
- WEBLATE_BITBUCKETSERVER_HOST¶
- WEBLATE_BITBUCKETSERVER_CREDENTIALS¶
Configures Richieste pull di Bitbucket Data Center by changing
BITBUCKETSERVER_CREDENTIALS.
- WEBLATE_BITBUCKETCLOUD_USERNAME¶
- WEBLATE_BITBUCKETCLOUD_WORKSPACE¶
- WEBLATE_BITBUCKETCLOUD_TOKEN¶
- WEBLATE_BITBUCKETCLOUD_HOST¶
- WEBLATE_BITBUCKETCLOUD_CREDENTIALS¶
Configures Richieste pull di Bitbucket Cloud by changing
BITBUCKETCLOUD_CREDENTIALS.
- WEBLATE_AZURE_DEVOPS_USERNAME¶
- WEBLATE_AZURE_DEVOPS_ORGANIZATION¶
- WEBLATE_AZURE_DEVOPS_TOKEN¶
- WEBLATE_AZURE_DEVOPS_HOST¶
- WEBLATE_AZURE_DEVOPS_CREDENTIALS¶
Configures Azure DevOps pull requests by changing
AZURE_DEVOPS_CREDENTIALS.
Translation services settings¶
Cambiato nella versione 4.13: Translation services are now configured in the user interface, see Translation services.
The existing environment variables are imported during the migration to Weblate 4.13, but changing them will not have any further effect.
Authentication settings¶
Suggerimento
The e-mail based authentication is turned on unless disabled by WEBLATE_NO_EMAIL_AUTH.
LDAP¶
- WEBLATE_AUTH_LDAP_SERVER_URI¶
- WEBLATE_AUTH_LDAP_USER_DN_TEMPLATE¶
- WEBLATE_AUTH_LDAP_USER_ATTR_MAP¶
- WEBLATE_AUTH_LDAP_BIND_DN¶
- WEBLATE_AUTH_LDAP_BIND_PASSWORD¶
- WEBLATE_AUTH_LDAP_CONNECTION_OPTION_REFERRALS¶
- WEBLATE_AUTH_LDAP_USER_SEARCH¶
- WEBLATE_AUTH_LDAP_USER_SEARCH_FILTER¶
- WEBLATE_AUTH_LDAP_USER_SEARCH_UNION¶
- WEBLATE_AUTH_LDAP_USER_SEARCH_UNION_DELIMITER¶
LDAP authentication configuration.
Example for direct bind:
environment: WEBLATE_AUTH_LDAP_SERVER_URI: ldap://ldap.example.org WEBLATE_AUTH_LDAP_USER_DN_TEMPLATE: uid=%(user)s,ou=People,dc=example,dc=net # map weblate 'full_name' to ldap 'name' and weblate 'email' attribute to 'mail' ldap attribute. # another example that can be used with OpenLDAP: 'full_name:cn,email:mail' WEBLATE_AUTH_LDAP_USER_ATTR_MAP: full_name:name,email:mail
Example for search and bind:
environment: WEBLATE_AUTH_LDAP_SERVER_URI: ldap://ldap.example.org WEBLATE_AUTH_LDAP_BIND_DN: CN=ldap,CN=Users,DC=example,DC=com WEBLATE_AUTH_LDAP_BIND_PASSWORD: password WEBLATE_AUTH_LDAP_USER_ATTR_MAP: full_name:name,email:mail WEBLATE_AUTH_LDAP_USER_SEARCH: CN=Users,DC=example,DC=com
Example for union search and bind:
environment: WEBLATE_AUTH_LDAP_SERVER_URI: ldap://ldap.example.org WEBLATE_AUTH_LDAP_BIND_DN: CN=ldap,CN=Users,DC=example,DC=com WEBLATE_AUTH_LDAP_BIND_PASSWORD: password WEBLATE_AUTH_LDAP_USER_ATTR_MAP: full_name:name,email:mail WEBLATE_AUTH_LDAP_USER_SEARCH_UNION: ou=users,dc=example,dc=com|ou=otherusers,dc=example,dc=com
Example with search and bind against Active Directory:
environment: WEBLATE_AUTH_LDAP_BIND_DN: CN=ldap,CN=Users,DC=example,DC=com WEBLATE_AUTH_LDAP_BIND_PASSWORD: password WEBLATE_AUTH_LDAP_SERVER_URI: ldap://ldap.example.org WEBLATE_AUTH_LDAP_CONNECTION_OPTION_REFERRALS: 0 WEBLATE_AUTH_LDAP_USER_ATTR_MAP: full_name:name,email:mail WEBLATE_AUTH_LDAP_USER_SEARCH: CN=Users,DC=example,DC=com WEBLATE_AUTH_LDAP_USER_SEARCH_FILTER: (sAMAccountName=%(user)s)
Vedi anche
GitHub¶
- WEBLATE_SOCIAL_AUTH_GITHUB_KEY¶
- WEBLATE_SOCIAL_AUTH_GITHUB_SECRET¶
- WEBLATE_SOCIAL_AUTH_GITHUB_ORG_KEY¶
- WEBLATE_SOCIAL_AUTH_GITHUB_ORG_SECRET¶
- WEBLATE_SOCIAL_AUTH_GITHUB_ORG_NAME¶
- WEBLATE_SOCIAL_AUTH_GITHUB_TEAM_KEY¶
- WEBLATE_SOCIAL_AUTH_GITHUB_TEAM_SECRET¶
- WEBLATE_SOCIAL_AUTH_GITHUB_TEAM_ID¶
Enables GitHub authentication.
GitHub Enterprise Edition¶
- WEBLATE_SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY¶
- WEBLATE_SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET¶
- WEBLATE_SOCIAL_AUTH_GITHUB_ENTERPRISE_URL¶
- WEBLATE_SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL¶
- WEBLATE_SOCIAL_AUTH_GITHUB_ENTERPRISE_SCOPE¶
Enables Autenticazione GitHub EE.
Bitbucket¶
- WEBLATE_SOCIAL_AUTH_BITBUCKET_OAUTH2_KEY¶
- WEBLATE_SOCIAL_AUTH_BITBUCKET_OAUTH2_SECRET¶
Enables Bitbucket authentication.
Facebook¶
- WEBLATE_SOCIAL_AUTH_FACEBOOK_KEY¶
- WEBLATE_SOCIAL_AUTH_FACEBOOK_SECRET¶
Enables Facebook OAuth 2.
Google¶
- WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_KEY¶
- WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET¶
- WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS¶
- WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_EMAILS¶
Enables Google OAuth 2.
GitLab¶
- WEBLATE_SOCIAL_AUTH_GITLAB_KEY¶
- WEBLATE_SOCIAL_AUTH_GITLAB_SECRET¶
- WEBLATE_SOCIAL_AUTH_GITLAB_API_URL¶
Enables GitLab OAuth 2.
Gitea¶
- WEBLATE_SOCIAL_AUTH_GITEA_API_URL¶
- WEBLATE_SOCIAL_AUTH_GITEA_KEY¶
- WEBLATE_SOCIAL_AUTH_GITEA_SECRET¶
Abilita l’autenticazione Gitea.
Microsoft Entra ID¶
- WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_KEY¶
- WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET¶
Enables Microsoft Entra ID authentication, see Microsoft Entra ID.
Microsoft Entra ID with Tenant support¶
- WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_KEY¶
- WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_SECRET¶
- WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_TENANT_ID¶
Enables Microsoft Entra ID authentication with Tenant support, see Microsoft Entra ID.
Keycloak¶
- WEBLATE_SOCIAL_AUTH_KEYCLOAK_KEY¶
- WEBLATE_SOCIAL_AUTH_KEYCLOAK_SECRET¶
- WEBLATE_SOCIAL_AUTH_KEYCLOAK_PUBLIC_KEY¶
- WEBLATE_SOCIAL_AUTH_KEYCLOAK_ALGORITHM¶
- WEBLATE_SOCIAL_AUTH_KEYCLOAK_AUTHORIZATION_URL¶
- WEBLATE_SOCIAL_AUTH_KEYCLOAK_ACCESS_TOKEN_URL¶
- WEBLATE_SOCIAL_AUTH_KEYCLOAK_TITLE¶
- WEBLATE_SOCIAL_AUTH_KEYCLOAK_IMAGE¶
Enables Keycloak authentication.
- WEBLATE_SOCIAL_AUTH_KEYCLOAK_ID_KEY¶
Added in version 5.17.
Configures which claim is used as the unique user identifier from Keycloak. Defaults to the stable subject claim,
sub. Explicit overrides remain supported, but e-mail addresses and usernames can be reassigned and are unsafe account identifiers. See Keycloak authentication for migration and historical-key backfill requirements when upgrading from the earlieremaildefault.Suggerimento
When Keycloak is configured to abstract third-party IDP, you will need to configure
WEBLATE_CSP_FORM_SRCfor the third-party IDP domain.Example when Keycloak is passing authentication to Microsoft.¶environment: WEBLATE_CSP_FORM_SRC: login.microsoftonline.com
- WEBLATE_SOCIAL_AUTH_KEYCLOAK_ALLOW_UNVERIFIED_LEGACY_UID_MIGRATION¶
Added in version 2026.11.2.
Allows migration of historical Keycloak associations without saved subject evidence. Defaults to enabled only when
WEBLATE_SOCIAL_AUTH_KEYCLOAK_ID_KEYis unset; an explicit identifier, includingsub, defaults to disabled. Set to1or0to override this default. When disabled, matching saved subjects are required; associations without this evidence then require account recovery or verified administrative repair. Until migration, enabled fallback retains the risk of historical e-mail address or username reassignment. See Keycloak authentication for upgrade guidance.
Linux vendors¶
You can enable authentication using Linux vendors authentication services by setting following variables to any value.
- WEBLATE_SOCIAL_AUTH_FEDORA¶
- WEBLATE_SOCIAL_AUTH_OPENSUSE¶
- WEBLATE_SOCIAL_AUTH_OPENINFRA¶
- WEBLATE_SOCIAL_AUTH_UBUNTU¶
Slack¶
- WEBLATE_SOCIAL_AUTH_SLACK_KEY¶
OpenID Connect identity provider¶
Added in version 2026.11.
- WEBLATE_OIDC_PROVIDER_ENABLED¶
Enable the optional OpenID Connect identity provider. Defaults to
False. The image must include theoidcinstallation extra; see Configurazione oltre le variabili di ambiente. Enabling the provider installs its Django applications and migrations.
- WEBLATE_OIDC_PROVIDER_RSA_PRIVATE_KEY_FILE¶
Required when
WEBLATE_OIDC_PROVIDER_ENABLEDis enabled. Path to a mounted, unencrypted RSA private key used to sign ID tokens. Generate it as described in OpenID Connect identity provider. Weblate does not generate this key. To retain inactive keys during rotation, configureOAUTH2_PROVIDERinsettings-override.py.
OpenID Connect¶
Added in version 4.13-1.
- WEBLATE_SOCIAL_AUTH_OIDC_OIDC_ENDPOINT¶
- WEBLATE_SOCIAL_AUTH_OIDC_KEY¶
- WEBLATE_SOCIAL_AUTH_OIDC_SECRET¶
- WEBLATE_SOCIAL_AUTH_OIDC_USERNAME_KEY¶
- WEBLATE_SOCIAL_AUTH_OIDC_TITLE¶
- WEBLATE_SOCIAL_AUTH_OIDC_IMAGE¶
Configures generic OpenID Connect integration.
Vedi anche
Weblate OpenID Connect¶
Added in version 2026.11.
- WEBLATE_SOCIAL_AUTH_WEBLATE_KEY¶
- WEBLATE_SOCIAL_AUTH_WEBLATE_SECRET¶
Enable authentication through Hosted Weblate or another Weblate installation (see Weblate OpenID Connect) using the client ID and client secret registered with its OpenID Connect identity provider. Register the exact HTTPS callback URL of this installation, for example
https://weblate.example.com/accounts/complete/weblate/.environment: WEBLATE_SOCIAL_AUTH_WEBLATE_KEY: your-client-id WEBLATE_SOCIAL_AUTH_WEBLATE_SECRET_FILE: /run/secrets/weblate-client-secret
- WEBLATE_SOCIAL_AUTH_WEBLATE_OIDC_ENDPOINT¶
Optional issuer URL. Defaults to
https://hosted.weblate.org/oidc. For another installation, use its base URL followed by/oidc, including any deployment prefix, for examplehttps://example.com/translations/oidc. Do not append/.well-known/openid-configuration.Changing the issuer requires an explicit migration of existing account associations: the same subject identifier on different servers can refer to different people.
- WEBLATE_SOCIAL_AUTH_WEBLATE_TITLE¶
- WEBLATE_SOCIAL_AUTH_WEBLATE_IMAGE¶
Optional sign-in label and icon overrides. By default, the label is Hosted Weblate for Hosted Weblate and Weblate for other installations; both use the Weblate icon.
Vedi anche
Fedora OpenID Connect¶
Added in version 5.15.
- WEBLATE_SOCIAL_AUTH_FEDORA_OIDC_KEY¶
SAML¶
Self-signed SAML keys are automatically generated on first container startup.
In case you want to use own keys, place the certificate and private key in
/app/data/ssl/saml.crt and /app/data/ssl/saml.key.
- WEBLATE_SAML_IDP_ENTITY_ID¶
- WEBLATE_SAML_IDP_URL¶
- WEBLATE_SAML_IDP_X509CERT¶
- WEBLATE_SAML_IDP_IMAGE¶
- WEBLATE_SAML_IDP_TITLE¶
SAML Identity Provider settings, see SAML authentication.
- WEBLATE_SAML_SECURITY_CONFIG¶
Added in version 2026.6.
SAML security configuration as a JSON object, passed to
SOCIAL_AUTH_SAML_SECURITY_CONFIG. For example, to disable therequestedAuthnContext(needed for some identity providers such as Microsoft Entra ID with multi-factor authentication):environment: WEBLATE_SAML_SECURITY_CONFIG: '{"requestedAuthnContext": false}'
Vedi anche
- WEBLATE_SAML_ID_ATTR_FULL_NAME¶
- WEBLATE_SAML_ID_ATTR_FIRST_NAME¶
- WEBLATE_SAML_ID_ATTR_LAST_NAME¶
- WEBLATE_SAML_ID_ATTR_USERNAME¶
- WEBLATE_SAML_ID_ATTR_EMAIL¶
- WEBLATE_SAML_ID_ATTR_USER_PERMANENT_ID¶
Added in version 4.18.
SAML attributes mapping.
Other authentication settings¶
- WEBLATE_NO_EMAIL_AUTH¶
Disables e-mail authentication when set to any value. See Turning off password authentication.
PostgreSQL database setup¶
The database is created by docker-compose.yml, so these settings affect
both Weblate and PostgreSQL containers.
Vedi anche
- POSTGRES_PASSWORD¶
PostgreSQL password.
Vedi anche
- POSTGRES_USER¶
PostgreSQL username.
- POSTGRES_DB¶
PostgreSQL database name.
- POSTGRES_HOST¶
PostgreSQL server hostname or IP address. Defaults to
database.
- POSTGRES_PORT¶
PostgreSQL server port. Defaults to none (uses the default value).
- POSTGRES_SSL_MODE¶
Configure how PostgreSQL handles SSL in connection to the server, for possible choices see SSL Mode Descriptions.
- POSTGRES_ALTER_ROLE¶
Configures name of the PostgreSQL role to alter during the database migration, see Configuring Weblate to use PostgreSQL.
Defaults to
POSTGRES_USER.
- POSTGRES_CONN_MAX_AGE¶
Added in version 4.8.1.
The lifetime of a database connection, as an integer of seconds. Use 0 to close database connections at the end of each request.
Cambiato nella versione 5.1: The default behavior is to have unlimited persistent database connections.
Enabling connection persistence will typically, cause more open connection to the database. Please adjust your database configuration prior enabling.
Example configuration:
environment: POSTGRES_CONN_MAX_AGE: 3600
Vedi anche
- POSTGRES_DISABLE_SERVER_SIDE_CURSORS¶
Added in version 4.9.1.
Disable server side cursors in the database. This is necessary in some pgbouncer setups.
Example configuration:
environment: POSTGRES_DISABLE_SERVER_SIDE_CURSORS: 1
- WEBLATE_DATABASES¶
Added in version 5.1.
Set to false to disable environment based configuration of the database connection. Use Overriding settings from the data volume to configure the database connection manually.
Database backup settings¶
Vedi anche
- WEBLATE_DATABASE_BACKUP¶
Configures the daily database dump using
DATABASE_BACKUP. Defaults toplain.
Datastore server setup¶
Using Valkey or Redis is required by the Weblate container and you have to provide a connection parameters when running Weblate in Docker.
The datastore and any proxy must support RESP3.
Vedi anche
Configura cache for version requirements and troubleshooting
unknown command HELLO errors.
- REDIS_HOST¶
The datastore server hostname or IP address. Defaults to
cache.
- REDIS_PORT¶
The datastore server port. Defaults to
6379.
- REDIS_DB¶
Il numero del database del datastore, per impostazione predefinita è
1.
- REDIS_USER¶
Added in version 5.13: L’utente del database dell’archivio dati, non utilizzato per impostazione predefinita.
- REDIS_PASSWORD¶
La password del server dell’archivio dati, non utilizzata per impostazione predefinita.
Vedi anche
- REDIS_TLS¶
Enables using SSL for the datastore connection.
- REDIS_VERIFY_SSL¶
Can be used to disable SSL certificate verification for the datastore connection.
Email server setup¶
To make outgoing e-mail work, you need to provide a mail server.
Example TLS configuration:
environment:
WEBLATE_EMAIL_HOST: smtp.example.com
WEBLATE_EMAIL_HOST_USER: user
WEBLATE_EMAIL_HOST_PASSWORD: pass
Example SSL configuration:
environment:
WEBLATE_EMAIL_HOST: smtp.example.com
WEBLATE_EMAIL_PORT: 465
WEBLATE_EMAIL_HOST_USER: user
WEBLATE_EMAIL_HOST_PASSWORD: pass
WEBLATE_EMAIL_USE_TLS: 0
WEBLATE_EMAIL_USE_SSL: 1
Vedi anche
- WEBLATE_EMAIL_HOST¶
Mail server hostname or IP address.
- WEBLATE_EMAIL_PORT¶
Mail server port, defaults to 25.
Vedi anche
- WEBLATE_EMAIL_HOST_USER¶
E-mail per l’autenticazione.
Vedi anche
- WEBLATE_EMAIL_HOST_PASSWORD¶
Password di autenticazione della posta elettronica.
Vedi anche
- WEBLATE_EMAIL_USE_SSL¶
Whether to use an implicit TLS (secure) connection when talking to the SMTP server. In most e-mail documentation, this type of TLS connection is referred to as SSL. It is generally used on port 465. If you are experiencing problems, see the explicit TLS setting
WEBLATE_EMAIL_USE_TLS.Cambiato nella versione 4.11: The SSL/TLS support is automatically enabled based on the
WEBLATE_EMAIL_PORT.Vedi anche
- WEBLATE_EMAIL_USE_TLS¶
Whether to use a TLS (secure) connection when talking to the SMTP server. This is used for explicit TLS connections, generally on port 587 or 25. If you are experiencing connections that hang, see the implicit TLS setting
WEBLATE_EMAIL_USE_SSL.Cambiato nella versione 4.11: The SSL/TLS support is automatically enabled based on the
WEBLATE_EMAIL_PORT.Vedi anche
- WEBLATE_EMAIL_BACKEND¶
Configures Django back-end to use for sending e-mails.
Set to
django_ses.SESBackendto use AWS SES.Vedi anche
- WEBLATE_AWS_SES_REGION_NAME¶
AWS region for SES (e.g.
us-east-1). SetsAWS_SES_REGION_NAMEand derivesWEBLATE_AWS_SES_REGION_ENDPOINTautomatically unless that variable is set explicitly. If not set, the region must be available through the standard boto3 credential chain (e.g.AWS_DEFAULT_REGIONor an AWS profile).
- WEBLATE_AWS_SES_REGION_ENDPOINT¶
SES endpoint hostname. When set, it is passed to django-ses directly regardless of
WEBLATE_AWS_SES_REGION_NAME. When not set butWEBLATE_AWS_SES_REGION_NAMEis provided, defaults toemail.<region>.amazonaws.com. Override when using a VPC or custom endpoint.
- WEBLATE_USE_SES_V2¶
Set to
trueto use the SES v2 API (SendEmail) instead of the legacySendRawEmailcall. Boolean setting (use"true"or"false").
- WEBLATE_AUTO_UPDATE¶
Configures if and how Weblate should update repositories.
The default,
"false", fetches remote changes daily without merging them into the working copy; it does not disable daily updates. Set to"true"to also merge remote changes into the working copy.Vedi anche
AUTO_UPDATEfor details on how updates are scheduled throughout the day.Nota
This is a Boolean setting (use
"true"or"false").
Integrazione del sito¶
- WEBLATE_GET_HELP_URL¶
Configures
GET_HELP_URL.
- WEBLATE_STATUS_URL¶
Configures
STATUS_URL.
- WEBLATE_PRIVACY_URL¶
Configures
PRIVACY_URL.
- WEBLATE_PASSWORD_RESET_URL¶
Configures
PASSWORD_RESET_URL.
Collecting error reports and monitoring performance¶
It is recommended to collect errors from the installation systematically, see Collecting error reports and monitoring performance.
To enable support for Rollbar, set the following:
- ROLLBAR_KEY¶
Your Rollbar post server access token.
- ROLLBAR_ENVIRONMENT¶
Your Rollbar environment, defaults to
production.
To enable support for Sentry, set following:
- SENTRY_DSN¶
Your Sentry DSN, see
SENTRY_DSN.
- SENTRY_ENVIRONMENT¶
Your Sentry Environment (optional), defaults to
WEBLATE_SITE_DOMAIN.
- SENTRY_MONITOR_BEAT_TASKS¶
Whether to monitor Celery Beat tasks with Sentry, defaults to
True.
- SENTRY_TRACES_SAMPLE_RATE¶
Configures
SENTRY_TRACES_SAMPLE_RATE.Esempio:
environment: SENTRY_TRACES_SAMPLE_RATE: 0.5
- SENTRY_PROFILES_SAMPLE_RATE¶
Configures
SENTRY_PROFILES_SAMPLE_RATE.Esempio:
environment: SENTRY_PROFILES_SAMPLE_RATE: 0.5
- SENTRY_SEND_PII¶
Configures
SENTRY_SEND_PII.
To enable support for Google Cloud Error Reporting, set following:
- GOOGLE_CLOUD_ERROR_REPORTING_ENABLED¶
Enables
GOOGLE_CLOUD_ERROR_REPORTING, defaults toFalse.
- GOOGLE_CLOUD_ERROR_REPORTING_PROJECT¶
Google Cloud project to report errors to. If omitted, the Google client uses application default credentials to detect the project.
- GOOGLE_CLOUD_ERROR_REPORTING_SERVICE¶
Service name to use in Google Cloud Error Reporting, defaults to
weblate.
To enable support for OpenTelemetry tracing, set following:
- OPENTELEMETRY_ENABLED¶
Enables
OPENTELEMETRY_ENABLED, defaults toFalse.
- OPENTELEMETRY_EXPORTER_OTLP_ENDPOINT¶
Configures
OPENTELEMETRY_EXPORTER_OTLP_ENDPOINT.Esempio:
environment: OPENTELEMETRY_ENABLED: true OPENTELEMETRY_EXPORTER_OTLP_ENDPOINT: https://collector.example.com/v1/traces OPENTELEMETRY_TRACES_SAMPLE_RATE: 0.1
- OPENTELEMETRY_EXPORTER_OTLP_HEADERS¶
Configures
OPENTELEMETRY_EXPORTER_OTLP_HEADERSas a comma-separatedname:valuemapping.
- OPENTELEMETRY_EXTRA_RESOURCE_ATTRIBUTES¶
Configures
OPENTELEMETRY_EXTRA_RESOURCE_ATTRIBUTESas a comma-separatedname:valuemapping.
- OPENTELEMETRY_SERVICE_NAME¶
Configures
OPENTELEMETRY_SERVICE_NAME.
- OPENTELEMETRY_TRACES_SAMPLE_RATE¶
Configures
OPENTELEMETRY_TRACES_SAMPLE_RATE.
Localizzazione CDN¶
- WEBLATE_LOCALIZE_CDN_URL¶
- WEBLATE_LOCALIZE_CDN_PATH¶
Added in version 4.2.1.
Configuration for CDN add-ons, including CDN localizzazione JavaScript and File di traduzione CDN.
The
WEBLATE_LOCALIZE_CDN_PATHis path within the container. It should be stored on the persistent volume and not in the transient storage.One of possibilities is storing that inside the Weblate data dir:
environment: WEBLATE_LOCALIZE_CDN_URL: https://cdn.example.com/ WEBLATE_LOCALIZE_CDN_PATH: /app/data/l10n-cdn
Nota
You are responsible for setting up serving of the files generated by Weblate, it only stores the files in configured location. See Localizzazione CDN for secure serving guidance.
Changing enabled apps, checks, formats, add-ons, translation services, or autofixes¶
The built-in configuration of enabled checks, file formats, add-ons, translation services, or autofixes can be adjusted by the following variables:
- WEBLATE_ADD_APPS¶
- WEBLATE_REMOVE_APPS¶
- WEBLATE_ADD_CHECK¶
- WEBLATE_REMOVE_CHECK¶
- WEBLATE_ADD_AUTOFIX¶
- WEBLATE_REMOVE_AUTOFIX¶
- WEBLATE_ADD_FORMATS¶
- WEBLATE_REMOVE_FORMATS¶
- WEBLATE_ADD_ADDONS¶
- WEBLATE_REMOVE_ADDONS¶
- WEBLATE_ADD_MACHINERY¶
Added in version 5.6.1.
- WEBLATE_REMOVE_MACHINERY¶
Added in version 5.6.1.
Esempio:
environment:
WEBLATE_REMOVE_AUTOFIX: weblate.trans.autofixes.whitespace.SameBookendingWhitespace
WEBLATE_REMOVE_FORMATS: weblate.formats.ttkit.PoFormat
WEBLATE_ADD_ADDONS: customize.addons.MyAddon,customize.addons.OtherAddon
Impostazioni del contenitore¶
- WEBLATE_WORKERS¶
Added in version 4.6.1.
Base number of worker processes running in the container. When not set it is determined automatically on container startup based on number of CPU cores available.
It is used to determine
CELERY_MAIN_OPTIONS,CELERY_COMBINED_OPTIONS,CELERY_NOTIFY_OPTIONS,CELERY_MEMORY_OPTIONS,CELERY_TRANSLATE_OPTIONS,CELERY_BACKUP_OPTIONS,WEB_WORKERS, andWEB_BLOCKING_THREADS. You can use these settings to fine-tune.
- CELERY_WORKER_MODE¶
Added in version 2026.9.1.
Selects how Celery workers are run in the container. Supported modes are:
combinedRuns one prefork worker for all queues. This is the default and reduces memory usage by sharing the application startup memory. Its concurrency defaults to three times
WEBLATE_WORKERS, and its prefetch multiplier defaults to one.splitRuns a separate prefork worker for each queue. This matches the behavior of container versions before 2026.9.1 and allows each queue to be tuned independently.
singleRuns all queues in one process using the solo pool. This minimizes memory usage, but noticeably reduces task throughput.
Explicit
WEBLATE_SERVICEselection takes precedence over this setting in horizontally scaled deployments.
- CELERY_COMBINED_OPTIONS¶
Added in version 2026.9.1.
Configures the worker used by
CELERY_WORKER_MODE=combined. By default, its concurrency is three timesWEBLATE_WORKERS. The worker uses a prefetch multiplier of one unless overridden here.environment: CELERY_COMBINED_OPTIONS: --concurrency 12 --prefetch-multiplier 1
- CELERY_MAIN_OPTIONS¶
- CELERY_NOTIFY_OPTIONS¶
- CELERY_MEMORY_OPTIONS¶
- CELERY_TRANSLATE_OPTIONS¶
- CELERY_BACKUP_OPTIONS¶
These variables allow you to adjust Celery worker options in
CELERY_WORKER_MODE=split. It can be useful to adjust concurrency (--concurrency 16), prefetching (--prefetch-multiplier 4), or use different pool implementation (--pool=gevent). Command-line options take precedence over corresponding Celery settings, allowing each worker category to use a different prefetch multiplier. When any of these variables is set incombinedorsinglemode, the container logs a startup warning that it is ignored.By default, the number of concurrent workers is based on
WEBLATE_WORKERS.Esempio:
environment: CELERY_MAIN_OPTIONS: --concurrency 16 --prefetch-multiplier 1
- CELERY_BEAT_OPTIONS¶
Configures the Celery beat scheduler in all worker modes.
- CELERY_SINGLE_OPTIONS¶
Configures the worker used by
CELERY_WORKER_MODE=single.Vedi anche
- CELERY_SINGLE_PROCESS¶
Added in version 5.7.1.
Deprecato dalla versione 2026.9.1.
Compatibility alias for
CELERY_WORKER_MODE=single. When set to1withoutCELERY_WORKER_MODE, the container starts insinglemode and logs a warning asking you to update the setting. If both variables are set,CELERY_WORKER_MODEtakes precedence.Vedi anche
- WEBLATE_ASGI¶
Added in version 2026.8.
Set to
1to run the web application using ASGI instead of WSGI. This is an opt-in setting intended for testing the transition to ASGI. WSGI remains the default for now, but a future release will run ASGI only and remove this setting.environment: WEBLATE_ASGI: 1
- WEB_WORKERS¶
Configure how many web application workers should be executed.
It defaults to half of
WEBLATE_WORKERS, but is always at least 2.Esempio:
environment: WEB_WORKERS: 4
Cambiato nella versione 5.13:
WEB_WORKERSconfigures how many worker processes will be used by granian.
- WEB_BLOCKING_THREADS¶
Configure how many blocking WSGI threads each granian worker can use. It defaults to twice
WEBLATE_WORKERSand is ignored whenWEBLATE_ASGIis enabled.The maximum number of simultaneous WSGI requests is approximately
WEB_WORKERSmultiplied byWEB_BLOCKING_THREADS. Each thread can hold its own database connection, so keep the resulting total within the database connection limit.Esempio:
environment: WEB_WORKERS: 2 WEB_BLOCKING_THREADS: 8
- WEBLATE_SERVICE¶
Defines which services should be executed inside the container. Use this for Scaling horizontally.
Sono definiti i seguenti servizi:
celery-beatCelery task scheduler, only one instance should be running. This container is also responsible for the database structure migrations and it should be started prior others.
celery-backupCelery worker for backups, only one instance should be running.
celery-combinedCombined Celery worker for all task queues.
celery-celeryGeneric Celery worker.
celery-memoryTranslation memory Celery worker.
celery-notifyNotifiche assistente Celery.
celery-singleSingle-process Celery worker for all task queues.
celery-translateTraduzione automatica assistente Celery.
webWeb server.
Vedi anche
- WEBLATE_ANUBIS_URL¶
Added in version 5.11.4.
URL of Anubis server to handle subrequest authentication. This can be useful to filter incoming HTTP requests using proof-of-work to stop AI crawlers. You need to configure Anubis for Subrequest Authentication to make it work.
Use an
http://orhttps://URL with a valid hostname or IPv4 address. The URL can include a port and a simple slash-separated path using ASCII letters, digits,_, and-. Credentials, queries, fragments, and IPv6 addresses are not supported.Vedi anche
Docker container volumes¶
There are two volumes (data and cache) exported by the Weblate
container.
Nota
The other service containers (such as PostgreSQL or Valkey) have their data volumes as well and are required to maintain Weblate persistence.
The PostgreSQL container stores the database in the
/var/lib/postgresql volume and Valkey in the /data volume.
Valkey container does not save the data by default and needs additional
configuration to enable persistence.
Base your configuration on Weblate-provided examples or consult their documentation for more information.
The data volume is mounted as /app/data and is used to store
Weblate persistent data such as cloned repositories or to customize Weblate
installation. DATA_DIR describes in more detail what is stored here.
Screenshots can be stored outside of this volume, see
WEBLATE_MEDIA_STORAGE_BACKEND.
The data volume is also place to store Weblate customization such as
Overriding settings from the data volume, Replacing logo and other static files or
Codice di personalizzazione.
The placement of the Docker volume on host system depends on your Docker
configuration, but usually it is stored in
/var/lib/docker/volumes/weblate-docker_weblate-data/_data/ (the path
consist of name of your docker-compose directory, container, and volume names).
The cache volume is mounted as /app/cache and is used to store static
files and CACHE_DIR. Its content is recreated on container startup
and the volume can be mounted using ephemeral filesystem such as tmpfs, but
the mount has to allow execution because Weblate stores generated helper files
there.
When mounting /app/cache explicitly as tmpfs in Docker Compose,
enable execution:
tmpfs:
- /app/cache:exec
When also setting ownership options, keep the exec option:
tmpfs:
- /app/cache:exec,uid=1000,gid=1000
When creating the volumes manually, the directories should be owned by UID 1000 as that is user used inside the container.
Weblate container can also be executed with a read-only root file system. In
this case, two additional tmpfs volumes should be mounted: /tmp and
/run.
Vedi anche
Filesystem root di sola lettura¶
Added in version 4.18.
When running the container with a read-only root filesystem, two additional
tmpfs volumes are required - /tmp and /run.
Configurazione oltre le variabili di ambiente¶
Docker environment variables are intended to expose most configuration settings of relevance for Weblate installations.
If you find a setting that is not exposed as an environment variable, and you believe that it should be, feel free to ask for it to be exposed in a future version of Weblate.
If you need to modify a setting that is not exposed as a Docker environment variable, you can still do so, either from the data volume or extending the Docker image.
Vedi anche
Overriding settings from the data volume¶
You can create a file at /app/data/settings-override.py, i.e. at the
root of the data volume, to extend or override settings
defined through environment variables.
Overriding settings by extending the Docker image¶
To override settings at the Docker image level instead of from the data volume:
Add a module to your package that imports all settings from
weblate.settings_docker.For example, within the example package structure defined at Creating a Python module, you could create a file at
weblate_customization/weblate_customization/settings.pywith the following initial code:from weblate.settings_docker import *
Create a custom
Dockerfilethat inherits from the official Weblate Docker image, and then installs your package and points theDJANGO_SETTINGS_MODULEenvironment variable to your settings module:FROM weblate/weblate USER root COPY weblate_customization /usr/src/weblate_customization RUN source /app/venv/bin/activate && uv pip install --no-cache-dir /usr/src/weblate_customization ENV DJANGO_SETTINGS_MODULE=weblate_customization.settings USER 1000
Instead of using the official Weblate Docker image, build a custom image from this
Dockerfilefile.There is no clean way to do this with
docker-compose.override.yml. You could addbuild: .to theweblatenode in that file, but then your custom image will be tagged asweblate/weblatein your system, which could be problematic.So, instead of using the
docker-compose.ymlstraight from the official repository, unmodified, and extending it throughdocker-compose.override.yml, you may want to make a copy of the officialdocker-compose.ymlfile, and edit your copy to replaceimage: weblate/weblatewithbuild: ..See the Compose file build reference for details on building images from source when using
docker-compose.Extend your custom settings module to define or redefine settings.
You can define settings before or after the import statement above to determine which settings take precedence. Settings defined before the import statement can be overridden by environment variables and setting overrides defined in the data volume. Setting defined after the import statement cannot be overridden.
You can also go further. For example, you can reproduce some of the things that
weblate.docker_settingsdoes, such as exposing settings as environment variables, or allow overriding settings from Python files in the data volume.
Replacing logo and other static files¶
The static files coming with Weblate can be overridden by placing into
/app/data/python/customize/static (see Docker container volumes). For
example creating /app/data/python/customize/static/favicon.ico will
replace the favicon.
Suggerimento
The files are copied to the corresponding location upon container startup, so a restart of Weblate is needed after changing the content of the volume.
This approach can be also used to override Weblate templates. For example, custom Modulo giuridico documents and styles can be provided as described in Customizing legal documents and styles.
Alternatively you can also include own module (see Customizing Weblate) and add it as separate volume to the Docker container, for example:
weblate:
volumes:
- weblate-data:/app/data
- ./weblate_customization/weblate_customization:/app/data/python/weblate_customization
environment:
WEBLATE_ADD_APPS: weblate_customization
Codice di personalizzazione¶
Nota
The internal Weblate API may vary significantly between releases and is not meant to be stable. Please review your custom code interacting with Weblate internals on each upgrade.
You can place additional Python code into /app/data/python/customize
(see Docker container volumes). It is already installed as a Django application
inside Weblate (this is used for customizing templates and static files as
described above).
This can be used to place any code (for example Writing own checks) or to add custom maintenance tasks to the Celery task scheduler.
/app/data/python/customize/tasks.py.¶"""Custom scheduled task."""
from __future__ import annotations
# ruff: ignore[suspicious-subprocess-import]
import subprocess
from typing import TYPE_CHECKING
from celery.schedules import crontab
from weblate.utils.celery import app
if TYPE_CHECKING:
from celery import Celery
@app.task
def custom_task() -> None:
"""Execute custom task code."""
# ruff: ignore[start-process-with-partial-path]
subprocess.run(["sleep", "1"], check=True)
@app.on_after_finalize.connect
def setup_periodic_tasks(sender: Celery, **kwargs: object) -> None:
"""Configure when periodic task is triggered."""
sender.add_periodic_task(
crontab(hour=1, minute=0), custom_task.s(), name="custom-task"
)
Integrazione di contenitori di terze parti¶
The Weblate Docker setup can be extended with additional containers to provide complementary services such as machine translation, spell checking, or other tools that enhance the translation workflow. These services can be integrated into your Docker Compose configuration and work alongside Weblate.
Quando aggiungi contenitori di terze parti, considera quanto segue:
Network connectivity: Ensure containers can communicate with each other by placing them on the same Docker network
Data persistence: Use volumes for services that need to persist data
Security: Configure appropriate access controls and avoid exposing unnecessary ports
Integrazione del contenitore Docker di LibreTranslate¶
LibreTranslate is a free and open-source machine translation service that can be self-hosted. Integrating it with Weblate provides offline machine translation capabilities without relying on external services.
You can incorporate the LibreTranslate service into your Weblate deployment by including it in a docker-compose.override.yml file. Since it runs within the Docker network, it’s only accessible to Weblate and not exposed to the public internet.
Basic setup using docker-compose.override.yml:
services:
libretranslate:
image: libretranslate/libretranslate:latest
command: --disable-web-ui
restart: unless-stopped
environment:
LT_UPDATE_MODELS: true
volumes:
- libretranslate_models:/home/libretranslate/.local:rw
healthcheck:
test: ['CMD-SHELL', './venv/bin/python scripts/healthcheck.py']
interval: 10s
timeout: 4s
retries: 4
start_period: 5s
volumes:
libretranslate_models:
For GPU-accelerated translation (if you have NVIDIA GPU available):
services:
libretranslate:
image: libretranslate/libretranslate:latest-cuda
command: --disable-web-ui
restart: unless-stopped
environment:
LT_UPDATE_MODELS: true
PUID: root
volumes:
- libretranslate_models:/home/libretranslate/.local:rw
healthcheck:
test: ['CMD-SHELL', './venv/bin/python scripts/healthcheck.py']
interval: 10s
timeout: 4s
retries: 4
start_period: 5s
deploy:
resources:
reservations:
devices:
- driver: nvidia
count: 1
capabilities: [gpu]
volumes:
libretranslate_models:
After starting the services with docker compose down && docker compose up -d,
configure LibreTranslate in Weblate:
Accedi all’interfaccia di amministrazione Weblate
Navigate to Manage → Translation services
Add a new LibreTranslate service with:
- Servizio:
LibreTranslate
- URL API:
http://libretranslate:5000- Chiave API:
Leave empty
LibreTranslate è ora configurato e disponibile per la traduzione automatica in Weblate.
Nota
The LibreTranslate service runs without the web UI (
--disable-web-ui) and is only accessible via the API within the Docker network.Models are automatically updated when the container starts. (
LT_UPDATE_MODELS: true)Data is persisted using Docker volumes for optimal performance and data safety.
Health checks ensure that the Docker engine properly observes the state of the service.
For GPU acceleration, use the CUDA image variant and ensure your system has NVIDIA Docker support. This container runs as a privileged user to be able to use the GPU.
No external ports are exposed, making the setup secure by default.
Integrazione del contenitore Anubis Docker¶
Anubis is a web AI firewall utility to block AI scrapers and other disruptive traffic on the server. It is typically needed for publicly open Weblate installations to avoid excessive load caused by scraping.
Anubis can be deployed using Docker Compose:
anubis:
image: ghcr.io/techarohq/anubis:latest
environment:
BIND: ":8923"
DIFFICULTY: "4"
METRICS_BIND: ":9090"
SERVE_ROBOTS_TXT: "false"
OG_PASSTHROUGH: "false"
# The single space in TARGET enables subrequest authentication
TARGET: " "
# The redirect domain has to match WEBLATE_SITE_DOMAIN
REDIRECT_DOMAINS: weblate.example.com
# Generate a random private key using: openssl rand -hex 32
ED25519_PRIVATE_KEY_HEX: "..."
# Customize your Anubis policy
POLICY_FNAME: /data/botPolicies.yaml
healthcheck:
test: ["CMD", "anubis", "--healthcheck"]
interval: 5s
timeout: 30s
retries: 5
start_period: 500ms
volumes:
- anubis-data:/data
volumes:
anubis-data:
Nota
The anubis-data volume in the above configuration is expected to contain
botPolicies.yaml with a bot policy configured to your needs.
At minimum, you need to adjust status codes as described in https://anubis.techaro.lol/docs/admin/configuration/subrequest-auth.
It is also recommended to configure persistent storage backend as described in https://anubis.techaro.lol/docs/admin/policies/#storage-backends.
Restrict Anubis’s REDIRECT_DOMAINS to your intended public hostnames, matching
WEBLATE_SITE_DOMAIN as shown above.
Challenge redirects and their return destinations use WEBLATE_SITE_DOMAIN,
including when a request arrives through an alias. Set WEBLATE_ENABLE_HTTPS
to 1 when a reverse proxy terminates TLS so these redirects use the public
HTTPS origin. Built-in TLS also selects HTTPS automatically. Include any public
nonstandard port in WEBLATE_SITE_DOMAIN.
You can then turn on the Anubis usage in Weblate using:
environment:
WEBLATE_ANUBIS_URL: http://anubis:8923
Vedi anche
Application-aware proof of work¶
Added in version 2026.11.
This integration is a technology preview. See Anonymous bot protection for its stability and maintenance policy.
- WEBLATE_BOT_PROTECTION_ENABLED¶
- WEBLATE_BOT_PROTECTION_DIFFICULTY¶
- WEBLATE_BOT_PROTECTION_CHALLENGE_AGE¶
- WEBLATE_BOT_PROTECTION_COOKIE_AGE¶
- WEBLATE_BOT_PROTECTION_CACHE_ALIAS¶
- WEBLATE_BOT_PROTECTION_EXEMPT_PATHS¶
- WEBLATE_BOT_PROTECTION_EXEMPT_AGENTS¶
- WEBLATE_BOT_PROTECTION_CRAWLER_FILE¶
- WEBLATE_BOT_PROTECTION_CRAWLER_RULES¶
- WEBLATE_BOT_PROTECTION_UNWANTED_AGENTS¶
- WEBLATE_BOT_PROTECTION_UNWANTED_ACTION¶
Enable Anonymous bot protection with WEBLATE_BOT_PROTECTION_ENABLED set to
1. The Django gate works without an Anubis container. During migration,
remove WEBLATE_ANUBIS_URL from the container environment and recreate the
container to remove the NGINX Anubis subrequest gate. Keeping both enabled can
produce two challenges; application authentication cannot bypass an upstream
Anubis challenge. Existing Anubis configuration and cookies are not modified or
trusted by the application gate.
Every BOT_PROTECTION_* setting has a matching WEBLATE_BOT_PROTECTION_*
environment variable: DIFFICULTY (4), CHALLENGE_AGE (300), COOKIE_AGE
(3600), CACHE_ALIAS (default), EXEMPT_PATHS (empty list),
EXEMPT_AGENTS (empty list), CRAWLER_FILE (empty), CRAWLER_RULES (empty
JSON object), UNWANTED_AGENTS (empty list), and UNWANTED_ACTION (challenge). Lists use the standard comma-separated
Docker setting syntax. Configure a persistent writable crawler snapshot and run
weblate update_crawler_ranges daily from an external scheduler; application
workers do not perform refreshes. Restart application workers after updating
the snapshot; ranges are loaded only at startup and do not expire by age. Use
the existing shared cache for replay protection and best-effort verification
counters, shown in the management overview.
Set WEBLATE_BOT_PROTECTION_EXEMPT_AGENTS to comma-separated,
case-insensitive User-Agent regular expressions for monitoring exemptions.
For example, ^Weblate-Uptime/1\.0$ exempts a monitor using that exact agent.
Matching requests bypass bot protection for all methods and paths, including
unwanted-agent denial. This trusts a spoofable header and does not grant
application access; see BOT_PROTECTION_EXEMPT_AGENTS.
HTTPS, trusted proxy IP handling, same-origin challenge assets, and bypassing shared proxy caches for protected application routes are required. Deployments with CDN-hosted static files must provide these challenge assets at the same origin as Weblate.
Configurazione del server PostgreSQL¶
The PostgreSQL container uses default PostgreSQL configuration and it won’t effectively utilize your CPU cores or memory. It is recommended to customize the configuration to improve the performance.
The configuration can be adjusted as described in Database Configuration at https://hub.docker.com/_/postgres. The configuration matching your environment can be generated using https://pgtune.leopard.in.ua/.
Interni del contenitore¶
The container is using supervisor to start individual services. In case of Scaling horizontally, it only starts single service in a container.
To check the services status use:
docker compose exec --user weblate weblate supervisorctl status
The Celery services depend on CELERY_WORKER_MODE. The default
combined mode runs celery-combined, while single mode runs
celery-single. You can stop all task processing in the default mode using:
docker compose exec --user weblate weblate supervisorctl stop celery-combined
The split mode runs an individual service for each Celery queue (see
Background tasks using Celery for details). In this mode, you can stop processing some tasks by
stopping the appropriate worker:
docker compose exec --user weblate weblate supervisorctl stop celery-translate