Instalowanie za pomocą Dockera¶
Dzięki zadokeryzowanemu wdrożeniu Weblate możesz uruchomić swoją osobistą instancję Weblate w kilka sekund. Wszystkie zależności Weblate są już uwzględnione. PostgreSQL jest skonfigurowany jako domyślna baza danych.
Wymagania sprzętowe¶
Weblate powinien działać bez problemów na każdym współczesnym sprzęcie, poniżej przedstawiono minimalną konfigurację wymaganą do uruchomienia Weblate na jednym hoście (Weblate, baza danych i serwer sieciowy):
2 GB pamięci RAM
2 rdzenie procesora
1 GB miejsca
Im więcej pamięci, tym lepiej - wykorzystywana jest do buforowania na wszystkich poziomach (system plików, baza danych i Weblate).
Wiele użytkowników jednocześnie zwiększa liczbę potrzebnych rdzeni procesora. W przypadku setek elementów tłumaczenia zalecane jest co najmniej 4 GB pamięci RAM.
Typowe użycie magazynu bazy danych wynosi około 300 MB na 1 milion hostowanych słów. Miejsce do magazynowania potrzebne do sklonowanych repozytoriów jest różna, ale Weblate stara się zachować ich minimalny rozmiar, wykonując płytkie klonowanie.
Informacja
Rzeczywiste wymagania dotyczące instalacji Weblate różnią się znacznie w zależności od rozmiaru zarządzanych tłumaczeń.
Instalacja¶
Poniższe przykłady zakładają, że masz działające środowisko Docker z zainstalowanym docker-compose
. Instrukcje można znaleźć w dokumentacji platformy Docker.
Klonowanie repozytorium weblate-docker:
git clone https://github.com/WeblateOrg/docker-compose.git weblate-docker cd weblate-docker
Utwórz plik: docker-compose.override.yml z ustawieniami. Zobacz Zmienne środowiskowe platformy Docker aby zapoznać się z pełną listą zmiennych środowiskowych.
version: '3' services: weblate: ports: - 80:8080 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
Informacja
Jeżeli
WEBLATE_ADMIN_PASSWORD
nie jest ustawione, administrator jest tworzony z losowym hasłem wyświetlanym przy pierwszym uruchomieniu.Podany przykład sprawia, że Weblate nasłuchuje na porcie 80, edytuj mapowanie portów w pliku
docker-compose.override.yml
aby to zmienić.Uruchamianie kontenera Weblate:
docker-compose up
Ciesz się wdrożeniem, Weblate jest teraz dostępne na porcie 80 kontenera `` weblate``.
Zmienione w wersji 2.15-2: Konfiguracja zmieniła się niedawno, wcześniej istniał oddzielny kontener serwera WWW, od wersji 2.15-2 serwer WWW jest osadzony w kontenerze Weblate.
Zmienione w wersji 3.7.1-6: W lipcu 2019 r. (Począwszy od tagu 3.7.1-6) kontenery nie działają jako użytkownik root. Zmieniło to odsłonięty port 80 na 8080.
Zobacz także
Kontener platformy Docker z obsługą protokołu HTTPS¶
Zobacz Instalacja, aby zapoznać się z ogólnymi instrukcjami dotyczącymi wdrażania, ta sekcja wspomina tylko o różnicach w porównaniu z ogólną instrukcją.
Używanie własnych certyfikatów SSL¶
Nowe w wersji 3.8-3.
Jeśli masz własny certyfikat SSL, którego chcesz użyć, po prostu umieść pliki w woluminie danych Weblate (zobacz Woluminy kontenerów platformy Docker):
: file:ssl / fullchain.pem certyfikat zawierający wszystkie potrzebne certyfikaty CA
ssl/privkey.pem
zawierający klucz prywatny
Oba te pliki muszą być własnością tego samego użytkownika, który uruchamia kontener docker i mieć maskę pliku ustawioną na «»600»» (czytelną i zapisywalną tylko przez użytkownika będącego właścicielem).
Dodatkowo, kontener Weblate będzie teraz akceptował połączenia SSL na porcie 4443, będziesz musiał uwzględnić przekierowanie portu dla HTTPS w docker-compose.override.yml:
version: '3'
services:
weblate:
ports:
- 80:8080
- 443:4443
Jeśli masz już inne witryny na tym samym serwerze, prawdopodobnie porty «»80»» i «»443»» są używane przez odwrotny serwer proxy, taki jak NGINX. Aby przekazać połączenie HTTPS z NGINX do kontenera platformy docker, można użyć następującej konfiguracji:
server {
listen 443;
listen [::]:443;
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>;
}
}
Zastąp <SITE_URL>
, <SITE>
i <EXPOSED_DOCKER_PORT>
rzeczywistymi wartościami z twojego środowiska.
Automatyczne certyfikaty SSL z wykorzystaniem 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
Uaktualnianie kontenera platformy Docker¶
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:
docker-compose stop
docker-compose pull
docker-compose up
The Weblate database should be automatically migrated on first startup, and there should be no need for additional manual actions.
Informacja
Upgrades across 3.0 are not supported by Weblate. If you are on 2.x series
and want to upgrade to 3.x, first upgrade to the latest 3.0.1-x (at time of
writing this it is the 3.0.1-7
) image, which will do the migration and then
continue upgrading to newer versions.
You might also want to update the docker-compose
repository, though it’s
not needed in most case. Please beware of PostgreSQL version changes in this
case as it’s not straightforward to upgrade the database, see GitHub issue for more info.
Zaloguj się jako administrator¶
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.
Zobacz także
WEBLATE_ADMIN_PASSWORD
,
WEBLATE_ADMIN_NAME
,
WEBLATE_ADMIN_EMAIL
Number of processes and memory consumption¶
The number of worker processes for both uWSGI 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.
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 also fine-tune individual worker categories:
environment:
UWSGI_WORKERS: 4
CELERY_MAIN_OPTIONS: --concurrency 2
CELERY_NOTIFY_OPTIONS: --concurrency 1
CELERY_TRANSLATE_OPTIONS: --concurrency 1
Scaling horizontally¶
Nowe w wersji 4.6.
Ostrzeżenie
This feature is a technology preview.
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 ordering of the
services matters as well.
You can find example setup in the docker-compose
repo as
docker-compose-split.yml.
Zmienne środowiskowe platformy Docker¶
Many of Weblate’s Konfiguracja can be set in the Docker container using environment variables:
Ustawienia ogólne¶
- WEBLATE_DEBUG¶
Configures Django debug mode using
DEBUG
.Przykład:
environment: WEBLATE_DEBUG: 1
Zobacz także
- WEBLATE_LOGLEVEL¶
Konfiguruje szczegółowość rejestrowania.
- 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.
Zobacz także
- WEBLATE_ADMIN_NAME¶
- WEBLATE_ADMIN_EMAIL¶
Configures the site-admin’s name and e-mail. It is used for both
ADMINS
setting and creating admin user (seeWEBLATE_ADMIN_PASSWORD
for more info on that).Przykład:
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_NAME
andWEBLATE_ADMIN_EMAIL
.
Ostrzeżenie
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_PASSWORD_FILE¶
Sets the path to a file containing the password for the admin user.
Zobacz także
- WEBLATE_SERVER_EMAIL¶
- WEBLATE_DEFAULT_FROM_EMAIL¶
Configures the address for outgoing e-mails.
Zobacz także
- 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.Przykład:
environment: WEBLATE_ALLOWED_HOSTS: weblate.example.com,example.com
- WEBLATE_REGISTRATION_OPEN¶
Configures whether registrations are open by toggling
REGISTRATION_OPEN
.Przykład:
environment: WEBLATE_REGISTRATION_OPEN: 0
- WEBLATE_REGISTRATION_ALLOW_BACKENDS¶
Configure which authentication methods can be used to create new account via
REGISTRATION_ALLOW_BACKENDS
.Przykład:
environment: WEBLATE_REGISTRATION_OPEN: 0 WEBLATE_REGISTRATION_ALLOW_BACKENDS: azuread-oauth2,azuread-tenant-oauth2
- WEBLATE_TIME_ZONE¶
Configures the used time zone in Weblate, see
TIME_ZONE
.Informacja
To change the time zone of the Docker container itself, use the
TZ
environment variable.Przykład:
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.
Podpowiedź
Please see
ENABLE_HTTPS
documentation for possible caveats.Informacja
This does not make the Weblate container accept HTTPS connections, you need to configure that as well, see Kontener platformy Docker z obsługą protokołu HTTPS for examples.
Przykład:
environment: WEBLATE_ENABLE_HTTPS: 1
- 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_PROXY
and setsIP_PROXY_HEADER
.Informacja
The format must conform to Django’s expectations. Django transforms raw HTTP header names as follows:
konwertuje wszystkie znaki na wielkie litery
zastępuje wszystkie łączniki podkreśleniami
poprzedza
HTTP_
prefiks
So
X-Forwarded-For
would be mapped toHTTP_X_FORWARDED_FOR
.Przykład:
environment: WEBLATE_IP_PROXY_HEADER: HTTP_X_FORWARDED_FOR
- WEBLATE_SECURE_PROXY_SSL_HEADER¶
A tuple representing a 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.
Przykład:
environment: WEBLATE_SECURE_PROXY_SSL_HEADER: HTTP_X_FORWARDED_PROTO,https
Zobacz także
- WEBLATE_REQUIRE_LOGIN¶
Enables
REQUIRE_LOGIN
to enforce authentication on whole Weblate.Przykład:
environment: WEBLATE_REQUIRE_LOGIN: 1
- WEBLATE_LOGIN_REQUIRED_URLS_EXCEPTIONS¶
- WEBLATE_ADD_LOGIN_REQUIRED_URLS_EXCEPTIONS¶
- WEBLATE_REMOVE_LOGIN_REQUIRED_URLS_EXCEPTIONS¶
Adds URL exceptions for authentication required for the whole Weblate installation using
LOGIN_REQUIRED_URLS_EXCEPTIONS
.You can either replace whole settings, or modify default value using
ADD
andREMOVE
variables.
- WEBLATE_GOOGLE_ANALYTICS_ID¶
Configures ID for Google Analytics by changing
GOOGLE_ANALYTICS_ID
.
- WEBLATE_GITHUB_USERNAME¶
Configures GitHub username for GitHub pull-requests by changing
GITHUB_USERNAME
.Zobacz także
- WEBLATE_GITHUB_TOKEN¶
Nowe w wersji 4.3.
Configures GitHub personal access token for GitHub pull-requests via API by changing
GITHUB_TOKEN
.Zobacz także
- WEBLATE_GITLAB_USERNAME¶
Configures GitLab username for GitLab merge-requests by changing
GITLAB_USERNAME
Zobacz także
- WEBLATE_GITLAB_TOKEN¶
Configures GitLab personal access token for GitLab merge-requests via API by changing
GITLAB_TOKEN
Zobacz także
- WEBLATE_PAGURE_USERNAME¶
Configures Pagure username for Pagure merge-requests by changing
PAGURE_USERNAME
Zobacz także
- WEBLATE_PAGURE_TOKEN¶
Configures Pagure personal access token for Pagure merge-requests via API by changing
PAGURE_TOKEN
Zobacz także
- WEBLATE_SIMPLIFY_LANGUAGES¶
Configures the language simplification policy, see
SIMPLIFY_LANGUAGES
.
- WEBLATE_DEFAULT_ACCESS_CONTROL¶
Configures the default Kontrola dostępu for new projects, see
DEFAULT_ACCESS_CONTROL
.
- WEBLATE_DEFAULT_RESTRICTED_COMPONENT¶
Configures the default value for Ograniczony dostęp for new components, see
DEFAULT_RESTRICTED_COMPONENT
.
- WEBLATE_DEFAULT_TRANSLATION_PROPAGATION¶
Configures the default value for Zezwól na propagację tłumaczenia for new components, see
DEFAULT_TRANSLATION_PROPAGATION
.
- WEBLATE_DEFAULT_COMMITER_EMAIL¶
Konfiguracja
DEFAULT_COMMITER_EMAIL
.
- WEBLATE_DEFAULT_COMMITER_NAME¶
Konfiguracja
DEFAULT_COMMITER_NAME
.
- WEBLATE_DEFAULT_SHARED_TM¶
Configures
DEFAULT_SHARED_TM
.
- WEBLATE_AKISMET_API_KEY¶
Configures the Akismet API key, see
AKISMET_API_KEY
.
- WEBLATE_GPG_IDENTITY¶
Configures GPG signing of commits, see
WEBLATE_GPG_IDENTITY
.Zobacz także
- WEBLATE_URL_PREFIX¶
Configures URL prefix where Weblate is running, see
URL_PREFIX
.
- WEBLATE_SILENCED_SYSTEM_CHECKS¶
Configures checks which you do not want to be displayed, see
SILENCED_SYSTEM_CHECKS
.
- WEBLATE_CSP_SCRIPT_SRC¶
- WEBLATE_CSP_IMG_SRC¶
- WEBLATE_CSP_CONNECT_SRC¶
- WEBLATE_CSP_STYLE_SRC¶
- WEBLATE_CSP_FONT_SRC¶
Allows to customize
Content-Security-Policy
HTTP header.
- WEBLATE_LICENSE_FILTER¶
Konfiguracja
LICENSE_FILTER
.
- WEBLATE_LICENSE_REQUIRED¶
Konfiguracja
LICENSE_REQUIRED
- WEBLATE_WEBSITE_REQUIRED¶
Konfiguracja
WEBSITE_REQUIRED
- WEBLATE_HIDE_VERSION¶
Konfiguracja
HIDE_VERSION
.
- WEBLATE_BASIC_LANGUAGES¶
Konfiguracja
BASIC_LANGUAGES
.
- WEBLATE_DEFAULT_AUTO_WATCH¶
Configures
DEFAULT_AUTO_WATCH
.
- WEBLATE_RATELIMIT_ATTEMPTS¶
- WEBLATE_RATELIMIT_LOCKOUT¶
- WEBLATE_RATELIMIT_WINDOW¶
Nowe w wersji 4.6.
Configures rate limiter.
Podpowiedź
You can set configuration for any rate limiter scopes. To do that add
WEBLATE_
prefix to any of setting described in Ograniczenie szybkości.Zobacz także
Ograniczenie szybkości,
RATELIMIT_ATTEMPTS
,RATELIMIT_WINDOW
,RATELIMIT_LOCKOUT
- WEBLATE_ENABLE_AVATARS¶
Nowe w wersji 4.6.1.
Configures
ENABLE_AVATARS
.
Ustawienia tłumaczenia maszynowego¶
- WEBLATE_MT_APERTIUM_APY¶
Enables Apertium machine translation and sets
MT_APERTIUM_APY
- WEBLATE_MT_AWS_REGION¶
- WEBLATE_MT_AWS_ACCESS_KEY_ID¶
- WEBLATE_MT_AWS_SECRET_ACCESS_KEY¶
Konfiguracje AWS tłumaczenie maszynowe.
environment: WEBLATE_MT_AWS_REGION: us-east-1 WEBLATE_MT_AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE WEBLATE_MT_AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
- WEBLATE_MT_DEEPL_KEY¶
Enables DeepL machine translation and sets
MT_DEEPL_KEY
- WEBLATE_MT_DEEPL_API_URL¶
Configures DeepL API version to use, see
MT_DEEPL_API_URL
.
- WEBLATE_MT_LIBRETRANSLATE_KEY¶
Enables LibreTranslate machine translation and sets
MT_LIBRETRANSLATE_KEY
- WEBLATE_MT_LIBRETRANSLATE_API_URL¶
Configures LibreTranslate API instance to use, see
MT_LIBRETRANSLATE_API_URL
.
- WEBLATE_MT_GOOGLE_KEY¶
Włącza Google Translate i ustawia
MT_GOOGLE_KEY
- WEBLATE_MT_MICROSOFT_COGNITIVE_KEY¶
Włącza Microsoft Cognitive Services Translator i ustawia
MT_MICROSOFT_COGNITIVE_KEY
- WEBLATE_MT_MICROSOFT_ENDPOINT_URL¶
Sets
MT_MICROSOFT_ENDPOINT_URL
, please note this is supposed to contain domain name only.
- WEBLATE_MT_MICROSOFT_REGION¶
Ustawienia
MT_MICROSOFT_REGION
- WEBLATE_MT_MICROSOFT_BASE_URL¶
Ustawienia
MT_MICROSOFT_BASE_URL
- WEBLATE_MT_MODERNMT_KEY¶
Enables ModernMT and sets
MT_MODERNMT_KEY
.
- WEBLATE_MT_MYMEMORY_ENABLED¶
Enables MyMemory machine translation and sets
MT_MYMEMORY_EMAIL
toWEBLATE_ADMIN_EMAIL
.Przykład:
environment: WEBLATE_MT_MYMEMORY_ENABLED: 1
- WEBLATE_MT_GLOSBE_ENABLED¶
Włącza Glosbe tłumaczenie maszynowe.
environment: WEBLATE_MT_GLOSBE_ENABLED: 1
- WEBLATE_MT_MICROSOFT_TERMINOLOGY_ENABLED¶
Włącza Microsoft Terminology Service maszynowego tłumaczenia.
environment: WEBLATE_MT_MICROSOFT_TERMINOLOGY_ENABLED: 1
- WEBLATE_MT_SAP_BASE_URL¶
- WEBLATE_MT_SAP_SANDBOX_APIKEY¶
- WEBLATE_MT_SAP_USERNAME¶
- WEBLATE_MT_SAP_PASSWORD¶
- WEBLATE_MT_SAP_USE_MT¶
Konfiguruje SAP Translation Hub tłumaczenia maszynowego.
environment: WEBLATE_MT_SAP_BASE_URL: "https://example.hana.ondemand.com/translationhub/api/v1/" WEBLATE_MT_SAP_USERNAME: "user" WEBLATE_MT_SAP_PASSWORD: "password" WEBLATE_MT_SAP_USE_MT: 1
Ustawienia uwierzytelniania¶
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¶
Konfiguracja uwierzytelniania LDAP.
** Przykład bezpośredniego powiązania: **
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)
Zobacz także
GitHub¶
- WEBLATE_SOCIAL_AUTH_GITHUB_KEY¶
- WEBLATE_SOCIAL_AUTH_GITHUB_SECRET¶
Włączanie Uwierzytelnianie GitHub.
Bitbucket¶
- WEBLATE_SOCIAL_AUTH_BITBUCKET_KEY¶
- WEBLATE_SOCIAL_AUTH_BITBUCKET_SECRET¶
Włączanie Uwierzytelnianie Bitbucket.
Facebook¶
- WEBLATE_SOCIAL_AUTH_FACEBOOK_KEY¶
- WEBLATE_SOCIAL_AUTH_FACEBOOK_SECRET¶
Włączanie 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¶
Włączanie Google OAuth 2.
GitLab¶
- WEBLATE_SOCIAL_AUTH_GITLAB_KEY¶
- WEBLATE_SOCIAL_AUTH_GITLAB_SECRET¶
- WEBLATE_SOCIAL_AUTH_GITLAB_API_URL¶
Włączanie GitLab OAuth 2.
Azure Active Directory¶
- WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_KEY¶
- WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET¶
Enables Azure Active Directory authentication, see Microsoft Azure Active Directory.
Azure Active Directory 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 Azure Active Directory authentication with Tenant support, see Microsoft Azure Active Directory.
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¶
Enables Keycloak authentication, see documentation.
Dostawcy linuksa¶
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_UBUNTU¶
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¶
SAML Identity Provider settings, see Uwierzytelnianie SAML.
Konfiguracja bazy danych PostgreSQL¶
The database is created by docker-compose.yml
, so these settings affect
both Weblate and PostgreSQL containers.
Zobacz także
- POSTGRES_PASSWORD¶
Hasło PostgreSQL.
- POSTGRES_PASSWORD_FILE¶
Path to the file containing the PostgreSQL password. Use as an alternative to POSTGRES_PASSWORD.
- POSTGRES_USER¶
Nazwa użytkownika PostgreSQL.
- POSTGRES_DATABASE¶
Nazwa bazy danych PostgreSQL.
- 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 role to alter during migrations, see Konfigurowanie Weblate do korzystania z PostgreSQL.
Ustawienia kopii zapasowej bazy danych¶
Zobacz także
- WEBLATE_DATABASE_BACKUP¶
Configures the daily database dump using
DATABASE_BACKUP
. Defaults toplain
.
Konfiguracja serwera buforowania¶
Using Redis is strongly recommended by Weblate and you have to provide a Redis instance when running Weblate in Docker.
Zobacz także
- REDIS_HOST¶
The Redis server hostname or IP address. Defaults to
cache
.
- REDIS_PORT¶
The Redis server port. Defaults to
6379
.
- REDIS_DB¶
The Redis database number, defaults to
1
.
- REDIS_PASSWORD¶
The Redis server password, not used by default.
- REDIS_TLS¶
Enables using SSL for Redis connection.
- REDIS_VERIFY_SSL¶
Can be used to disable SSL certificate verification for Redis connection.
Konfiguracja serwera poczty e-mail¶
To make outgoing e-mail work, you need to provide a mail server.
Przykładowa konfiguracja protokołu TLS:
environment:
WEBLATE_EMAIL_HOST: smtp.example.com
WEBLATE_EMAIL_HOST_USER: user
WEBLATE_EMAIL_HOST_PASSWORD: pass
Przykładowa konfiguracja SSL:
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
Zobacz także
- WEBLATE_EMAIL_HOST¶
Mail server hostname or IP address.
Zobacz także
WEBLATE_EMAIL_PORT
,WEBLATE_EMAIL_USE_SSL
,WEBLATE_EMAIL_USE_TLS
,EMAIL_HOST
- WEBLATE_EMAIL_PORT¶
Mail server port, defaults to 25.
Zobacz także
- WEBLATE_EMAIL_HOST_USER¶
Uwierzytelnienie za pomocą e-maila.
Zobacz także
- WEBLATE_EMAIL_HOST_PASSWORD¶
Hasło uwierzytelniania poczty e-mail.
Zobacz także
- WEBLATE_EMAIL_HOST_PASSWORD_FILE¶
Path to the file containing the e-mail authentication password.
Zobacz także
- 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
.Zobacz także
- 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
.Zobacz także
- WEBLATE_EMAIL_BACKEND¶
Configures Django back-end to use for sending e-mails.
Zobacz także
Site integration¶
- WEBLATE_GET_HELP_URL¶
Configures
GET_HELP_URL
.
- WEBLATE_STATUS_URL¶
Configures
STATUS_URL
.
Raportowanie błędów¶
It is recommended to collect errors from the installation systematically, see Zbieranie raportów o błędach.
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¶
Twój DSN Sentry.
- SENTRY_ENVIRONMENT¶
Twoje środowisko Sentry (opcjonalnie).
Lokalizacja CDN¶
- WEBLATE_LOCALIZE_CDN_URL¶
- WEBLATE_LOCALIZE_CDN_PATH¶
Nowe w wersji 4.2.1.
Konfiguracja dla Lokalizacja JavaScript CDN.
The
WEBLATE_LOCALIZE_CDN_PATH
is 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
Informacja
You are responsible for setting up serving of the files generated by Weblate, it only does stores the files in configured location.
Changing enabled apps, checks, addons or autofixes¶
Nowe w wersji 3.8-5.
The built-in configuration of enabled checks, addons 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_ADDONS¶
- WEBLATE_REMOVE_ADDONS¶
Przykład:
environment:
WEBLATE_REMOVE_AUTOFIX: weblate.trans.autofixes.whitespace.SameBookendingWhitespace
WEBLATE_ADD_ADDONS: customize.addons.MyAddon,customize.addons.OtherAddon
Zobacz także
Ustawienia kontenera¶
- WEBLATE_WORKERS¶
Nowe w wersji 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_NOTIFY_OPTIONS
,CELERY_MEMORY_OPTIONS
,CELERY_TRANSLATE_OPTIONS
,CELERY_BACKUP_OPTIONS
,CELERY_BEAT_OPTIONS
, andUWSGI_WORKERS
. You can use these settings to fine-tune.
- CELERY_MAIN_OPTIONS¶
- CELERY_NOTIFY_OPTIONS¶
- CELERY_MEMORY_OPTIONS¶
- CELERY_TRANSLATE_OPTIONS¶
- CELERY_BACKUP_OPTIONS¶
- CELERY_BEAT_OPTIONS¶
These variables allow you to adjust Celery worker options. It can be useful to adjust concurrency (
--concurrency 16
) or use different pool implementation (--pool=gevent
).By default, the number of concurrent workers is based on
WEBLATE_WORKERS
.Przykład:
environment: CELERY_MAIN_OPTIONS: --concurrency 16
Zobacz także
- UWSGI_WORKERS¶
Configure how many uWSGI workers should be executed.
It defaults to
WEBLATE_WORKERS
.Przykład:
environment: UWSGI_WORKERS: 32
- WEBLATE_SERVICE¶
Defines which services should be executed inside the container. Use this for Scaling horizontally.
Following services are defined:
celery-beat
Celery 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-backup
Celery worker for backups, only one instance should be running.
celery-celery
Generic Celery worker.
celery-memory
Translation memory Celery worker.
celery-notify
Notifications Celery worker.
celery-translate
Automatic translation Celery worker.
web
Serwer internetowy.
Woluminy kontenerów platformy Docker¶
There are two volumes (data and cache) exported by the Weblate container. The other service containers (PostgreSQL or Redis) have their data volumes as well, but those are not covered by this document.
The data volume is used to store Weblate persistent data such as cloned repositories or to customize Weblate installation.
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).
In the container it is mounted as /app/data
.
The cache volume is mounted as /app/cache
and is used to store static
files. Its content is recreated on container startup and the volume can be
mounted using ephemeral filesystem such as tmpfs.
When creating the volumes manually, the directories should be owned by UID 1000 as that is user used inside the container.
Zobacz także
Dalsze dostosowywanie konfiguracji¶
You can further customize Weblate installation in the data volume, see Woluminy kontenerów platformy Docker.
Niestandardowe pliki konfiguracyjne¶
You can additionally override the configuration in
/app/data/settings-override.py
(see Woluminy kontenerów platformy Docker). This is
executed at the end of built-in settings, after all environment settings
are loaded, and you can adjust or override them.
Replacing logo and other static files¶
Nowe w wersji 3.8-5.
The static files coming with Weblate can be overridden by placing into
/app/data/python/customize/static
(see Woluminy kontenerów platformy Docker). For
example creating /app/data/python/customize/static/favicon.ico
will
replace the favicon.
Podpowiedź
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.
Alternatively you can also include own module (see Dostosowywanie 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
Dodawanie własnych modułów Pythona¶
Nowe w wersji 3.8-5.
You can place own Python modules in /app/data/python/
(see
Woluminy kontenerów platformy Docker) and they can be then loaded by Weblate, most likely by
using Niestandardowe pliki konfiguracyjne.
Zobacz także
Select your machine - local or cloud providers¶
With Docker Machine you can create your Weblate deployment either on your local machine, or on any large number of cloud-based deployments on e.g. Amazon AWS, Greenhost, and many other providers.