Установлення за допомогою Docker¶
Якщо Weblate розгорнуто у середовищі Docker, ви зможете отримати ваш працездатний і запущений особистий екземпляр Weblate за декілька секунд. Усі залежності Weblate вже включено. Типовим засобом роботи із базою даних у таких екземплярах є PostgreSQL та Redis як модуль кешування.
Вимоги щодо обладнання¶
Weblate повинен без проблем працювати на будь-якому сучасному обладнанні, нижче наведено мінімальну конфігурацію, необхідну для запуску Weblate на одному хості (Weblate, база даних і веб-сервер):
3 ГБ оперативної пам’яті
2 ядра процесора
1 ГБ вільного місця на диску
Примітка
Реальні вимоги до встановленого вами Weblate значно залежать від розміру перекладів, які ним керуються.
Використання пам’яті¶
Чим більше пам’яті, тим краще - вона використовується для кешування на всіх рівнях (файлова система, база даних і Weblate). Для сотень компонентів перекладу рекомендується щонайменше 4 ГБ оперативної пам’яті.
Підказка
Для систем з меншим обсягом пам’яті, ніж рекомендовано, рекомендується використовувати Налаштування однопроцесорного Celery.
Використання CPU¶
Багато одночасних користувачів збільшують кількість необхідних ядер процесора.
Використання сховища¶
Типове використання сховища бази даних становить близько 300 МБ на 1 мільйон розміщених слів.
Обсяг пам’яті, необхідний для клонованих репозиторіїв варіюється, але Weblate намагається тримати його мінімальним, роблячи неглибокі клони.
Вузли¶
Для малих сайтів та сайтів середнього розміру (мільйони розміщених слів), усі складники Weblate (див. Огляд архітектури) можна запустити на одному вузлі.
Якщо кількість розміщених рядків зросте до сотень мільйонів, рекомендуємо розмістити базу даних на окремому вузлі (див. Налаштування бази даних для Weblate).
Установлення¶
Підказка
У наведених нижче прикладах припускається, що у вас є працездатне середовище Docker із встановленим docker-compose-plugin
. Будь ласка, ознайомтеся із документацією до Docker, щоб отримати додаткові настанови.
Створює сервер розгортання Weblate за допомогою HTTP, тому ви маєте розмістити його за проксі-сервером із перериванням HTTPS. Ви також можете розгорнути систему з проксі-сервером HTTPS, див. Автоматична сертифікація SSL за допомогою Let’s Encrypt. Для більших конфігурацій, будь ласка, див. Горизонтальне масштабування.
Клонування сховища weblate-docker:
git clone https://github.com/WeblateOrg/docker-compose.git weblate-docker cd weblate-docker
Створіть файл
docker-compose.override.yml
з вашими параметрами. Із повним списком змінних середовища можна ознайомитися у розділі Змінні середовища Docker.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
Примітка
Якщо
WEBLATE_ADMIN_PASSWORD
не встановлено, для адміністративного користувача буде створено випадковий пароль, який буде показано під час першого запуску.У наданому прикладі Weblate очікуватиме на дані на порту 80. Змініть прив’язку портів у файлі
docker-compose.override.yml
, щоб скоригувати цю типову поведінку.Запуск контейнерів Weblate:
docker compose up
Насолоджуйтеся розгорнутим Weblate. Доступ до нього можна отримати за допомогою порту 80 контейнера weblate
.
Дивись також
Вибір реєстру образів Docker¶
Контейнери Weblate оприлюднено у таких реєстрах:
Docker Hub, див. https://hub.docker.com/r/weblate/weblate
Реєстр пакунків GitHub, див. https://github.com/WeblateOrg/docker/pkgs/container/weblate
Примітка
В усіх прикладах образи отримують з Docker Hub. Будь ласка, скоригуйте відповідним чином налаштування, щоб скористатися іншим реєстром.
Вибір образу концентратора Docker¶
Будь ласка, виберіть мітку, яка відповідає вашому середовищу і очікуванням:
Назва теґу |
Опис |
Варіант використання |
---|---|---|
|
Стабільний випуск Weblate, відповідає найновішому випуску |
Оновлення-накладки у промисловому середовищі |
|
Стабільний випуск Weblate |
Оновлення-накладки у межах основної версії у промисловому середовищі |
|
Стабільний випуск Weblate |
Оновлення-накладки у межах проміжної версії у промисловому середовищі |
|
Стабільний випуск Weblate |
Надійний розгорнутий екземпляр у промисловому середовищі |
|
Стабільний випуск Weblate із змінами з гілки розробки у контейнері Docker (наприклад, із оновленими залежностями) |
Оновлення-накладки у проміжному тестовому середовищі |
|
Стабільний випуск Weblate із змінами з гілки розробки у контейнері Docker (наприклад, із оновленими залежностями) |
Надійний розгорнутий екземпляр у тестовому середовищі |
|
Версії Weblate у розробці з Git |
Оновлення-накладки для тестування новітніх можливостей Weblate |
|
Версії Weblate у розробці з Git |
Надійний розгорнутий екземпляр для тестування новітніх можливостей Weblate |
Тестування усіх образів виконується перед оприлюдненням у нашій системі неперервної інтеграції, тому навіть версія bleeding має бути безпечною для користування.
Повний список оприлюднених міток можна знайти серед GitHub Packages
Контейнер Docker із підтримкою HTTPS¶
Будь ласка, ознайомтеся із розділом Установлення, щоб отримати загальні настанови щодо розгортання. У цьому розділі наведено лише відмінності від типової процедури.
Використання власних сертифікатів SSL¶
Якщо у вас є власний сертифікат SSL, яким ви хочете скористатися, просто розмістіть його файли на томі даних Weblate (див. Томи контейнера Docker):
ssl/fullchain.pem
містить сертифікат, включно із будь-якими потрібними сертифікатами служби сертифікаціїssl/privkey.pem
містить закритий ключ
Власником обох цих файлів має бути той самий користувач, що і користувач, від імені якого запускається контейнер Docker. Маскою прав доступу до цих файлів має бути 600
(читання і запис лише для користувача-власника).
Крім того, контейнер Weblate прийматиме з’єднання на порту SSL 4443. Вам варто включити переспрямування портів для HTTPS у перевизначення композицій Docker:
version: '3'
services:
weblate:
ports:
- 80:8080
- 443:4443
Якщо на сервері вже обробляються дані інших сайтів, ймовірно, порти 80
і 443
використовуються оберненим проксі, наприклад NGINX. Щоб передати з’єднання HTTPS від NGINX до контейнера Docker, ви можете скористатися такими налаштуваннями:
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>;
}
}
Замініть <SITE_URL>
, <SITE>
і <EXPOSED_DOCKER_PORT>
реальними значенням з вашого середовища.
Автоматична сертифікація SSL за допомогою Let’s Encrypt¶
Якщо ви хочете скористатися автоматично створеними сертифікатами SSL від Let’s Encrypt на загальнодоступній встановленій версії, вам слід додати обернений проксі HTTPS . Для цього буде використано додатковий контейнер Docker, https-portal. Використання цього контейнера виконується за допомогою файла docker-compose-https.yml
. Далі, вам слід створити файл docker-compose-https.override.yml
із вашими параметрами:
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'
Під час кожного виклику docker-compose вам слід передавати програмі обидва файли, а потім виконати:
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
Оновлення контейнера Docker¶
Зазвичай, варто оновлювати лише контейнер Weblate, а версію контейнера PostgreSQL лишати незмінною, оскільки оновлення PostgreSQL є доволі болючою процедурою і, у більшості випадків, не дає значних переваг.
Змінено в версії 4.17-1: З моменту випуску Weblate 4.10-1 у контейнері Docker використано Django 4.0. Це потребує встановлення PostgreSQL 10 або новішої версії. Будь ласка, оновіть пакунки до оновлення Weblate. Докладніший опис можна знайти у розділі Оновлення контейнера PostgreSQL.
Ви можете досягти цього фіксацією наявного docker-compose із простим отриманням найсвіжіших образів і наступним перезапуском:
# 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
Базу даних Weblate має бути автоматично перенесено на нову версію при першому запуску. Потреби у додаткових діях вручну виникнути не повинно.
Примітка
Підтримки оновлення до основних версій у Weblate не передбачено. Якщо ви працюєте із версією 3.x і хочете оновитися до 4.x, спочатку оновіться до найсвіжішої версії 4.0.x-y (на час написання цього підручника такою версією була 4.0.4-5
), а далі продовжуйте оновлення до новіших версій.
Ймовірно, вам також варто оновити сховище docker-compose
, хоча, у більшості випадків, потреби у цьому немає. Див. Оновлення контейнера PostgreSQL щодо оновлення сервера PostgreSQL.
Оновлення контейнера PostgreSQL¶
У контейнерах PostgreSQL не передбачено підтримки автоматичного оновлення до нових версій. Вам доведеться виконати оновлення вручну. Нижче показано кроки одного із варіантів оновлення.
Дивись також
Зупинення контейнера Weblate:
docker compose stop weblate cache
Резервне копіювання бази даних:
docker compose exec database pg_dumpall --clean --if-exists --username weblate > backup.sql
Зупинення контейнера бази даних:
docker compose stop database
Вилучення тому PostgreSQL:
docker compose rm -v database docker volume remove weblate-docker_postgres-data
Підказка
Назва тому містить назву проєкту Docker Compose, яка типово є назвою каталогу, яким у цій документації є
weblate-docker
.Скоригуйте ваш
docker-compose.yml
так, щоб у ньому було використано нову версію PostgreSQL.Запуск контейнера бази даних:
docker compose up -d database
Відновлення бази даних з резервної копії:
cat backup.sql | docker compose exec -T database psql --username weblate --dbname weblate
Підказка
Будь ласка, переконайтеся, що назва бази даних відповідає
POSTGRES_DB
.(Необов’язкове) Оновити пароль для користувача Weblate. У цьому може виникнути потреба при перенесенні на PostgreSQL 14 або 15, оскільки спосіб зберігання паролів було змінено:
docker compose exec -T database psql --username weblate --dbname weblate -c "ALTER USER weblate WITH PASSWORD 'weblate'"
Підказка
Будь ласка, переконайтеся, що назва бази даних відповідає
POSTGRES_DB
.Запуск решти контейнерів:
docker compose up -d
Вхід від імені адміністратора¶
Після налаштовування контейнера ви можете увійти до системи від імені користувача admin із використанням пароля, який надається у змінній WEBLATE_ADMIN_PASSWORD
, або випадкового пароля, який створено під час першого запуску, якщо пароль не було встановлено за допомогою змінної.
Щоб скинути пароль admin, перезапустіть контейнер зі змінною WEBLATE_ADMIN_PASSWORD
, значенням якої є новий пароль.
Дивись також
WEBLATE_ADMIN_PASSWORD
,
WEBLATE_ADMIN_NAME
,
WEBLATE_ADMIN_EMAIL
Кількість процесів і споживання пам’яті¶
Кількість процесів обробки у uWSGI і Celery визначається автоматично на основі кількості процесорів. Це добре працює для більшості «хмарних» віртуальних машин, оскільки у них, зазвичай, встановлено декілька процесорів і доволі багато оперативної пам’яті.
Якщо на вашому комп’ютері багато процесорів і виникають проблеми нестачі пам’яті, спробуйте скоротити кількість обробників:
environment:
WEBLATE_WORKERS: 2
Ви також можете скоригувати окремі категорії обробників:
environment:
WEB_WORKERS: 4
CELERY_MAIN_OPTIONS: --concurrency 2
CELERY_NOTIFY_OPTIONS: --concurrency 1
CELERY_TRANSLATE_OPTIONS: --concurrency 1
Memory usage can be further reduced by running only a single Celery process:
environment:
CELERY_SINGLE_PROCESS: 1
Горизонтальне масштабування¶
Added in version 4.6.
Ви можете запускати кілька контейнерів Weblate для горизонтального масштабування служби. Том /app/data
має бути спільним для всіх контейнерів. Радимо використовувати для нього кластерну файлову систему, зокрема GlusterFS. Том /app/cache
має бути власним для кожного з контейнерів.
У кожного контейнера Weblate є визначена за допомогою змінної середовища :envvar:`WEBLATE_SERVICE`роль. Будь ласка, точно виконуйте настанови з документації, оскільки деякі служби у кластері мають запускатися лише один раз, крім того, має значення порядок запуску служб.
Прикладом налаштувань у сховищі docker-compose
є файл docker-compose-split.yml.
Змінні середовища Docker¶
Багато з параметрів налаштовування може бути встановлено у контейнері Docker за допомогою змінних середовища, які описано нижче.
Якщо вам потрібно визначити параметр, який не буде відкрито за допомогою змінних середовища Docker, див. Налаштовування поза змінними середовища.
Передавання реєстраційних даних¶
Added in version 5.0.
У контейнері Weblate передбачено підтримку передавання реєстраційних даних у форматі файлів. Щоб скористатися цим, допишіть суфікс _FILE
до змінної середовища і передайте файл реєстраційних даних через Docker.
Відповідний docker-compose.yml
може виглядати так:
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
Дивись також
Загальні параметри¶
- WEBLATE_DEBUG¶
Налаштовує режим діагностики Django за допомогою
DEBUG
.Приклад:
environment: WEBLATE_DEBUG: 1
Дивись також
- WEBLATE_LOGLEVEL¶
Налаштовує докладність журналу. Встановіть значення
DEBUG
, щоб отримати докладніший журнал.Типовим значенням є
INFO
, якщоWEBLATE_DEBUG
увімкнено,DEBUG
буде використано, якщо увімкнено режим діагностики.Для скорочення розміру журналу скористайтеся
ERROR
абоWARNING
.
- WEBLATE_LOGLEVEL_DATABASE¶
Налаштовує докладність ведення журналу для запитів до бази даних.
- WEBLATE_SITE_TITLE¶
Налаштовує заголовок сайта, який буде показано у верхньому колонтитулі усіх сторінок.
- WEBLATE_SITE_DOMAIN¶
Налаштовує домен сайта. Цей параметр слід вказати обов’язково.
Дивись також
- WEBLATE_ADMIN_NAME¶
- WEBLATE_ADMIN_EMAIL¶
Налаштовує ім’я та адресу електронної пошти адміністратора сайта. Використовується одразу для встановлення
ADMINS
і створення користувача admin (див.WEBLATE_ADMIN_PASSWORD
, щоб дізнатися про це більше).Приклад:
environment: WEBLATE_ADMIN_NAME: Weblate admin WEBLATE_ADMIN_EMAIL: noreply@example.com
- WEBLATE_ADMIN_PASSWORD¶
Установлює пароль для користувача admin.
Якщо не встановлено і користувача admin не існує, його буде створено із випадковим паролем, який буде показано при першому запуску контейнера.
Якщо не встановлено, а запис користувача admin існує, ніяких дій не виконуватиметься.
Якщо встановлено, запис користувача admin буде скориговано під час кожного запуску контейнера відповідно до
WEBLATE_ADMIN_PASSWORD
,WEBLATE_ADMIN_NAME
іWEBLATE_ADMIN_EMAIL
.
Попередження
Зберігання пароля у файлі налаштувань може знизити рівень захищеності вашої системи. Цією змінною варто користуватися лише для початкового налаштовування (або для надання змоги Weblate створити випадковий пароль при початковому запуску) або для відновлення доступу до сервера після втрати пароля.
- WEBLATE_ADMIN_NOTIFY_ERROR¶
Whether to sent 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.
Дивись також
- WEBLATE_SERVER_EMAIL¶
Адреса електронної пошти, з якої надіслано повідомлення про помилки.
Дивись також
- WEBLATE_DEFAULT_FROM_EMAIL¶
Налаштовує адресу для вихідних повідомлень електронної пошти.
- WEBLATE_ADMINS_CONTACT¶
Налаштовує
ADMINS_CONTACT
.
- WEBLATE_CONTACT_FORM¶
Налаштовує поведінку форми зв’язку, див.
CONTACT_FORM
.
- WEBLATE_ALLOWED_HOSTS¶
Налаштовує дозволені назви вузлів HTTP за допомогою
ALLOWED_HOSTS
.Типове значення —
*
, що дозволяє використання будь-яких адрес.Приклад:
environment: WEBLATE_ALLOWED_HOSTS: weblate.example.com,example.com
- WEBLATE_REGISTRATION_OPEN¶
Налаштовує, чи відкрита реєстрація перемиканням
REGISTRATION_OPEN
.Приклад:
environment: WEBLATE_REGISTRATION_OPEN: 0
- WEBLATE_REGISTRATION_ALLOW_BACKENDS¶
Налаштувати, які способи розпізнавання може бути використано для створення облікового запису за допомогою
REGISTRATION_ALLOW_BACKENDS
.Приклад:
environment: WEBLATE_REGISTRATION_OPEN: 0 WEBLATE_REGISTRATION_ALLOW_BACKENDS: azuread-oauth2,azuread-tenant-oauth2
- WEBLATE_REGISTRATION_REBIND¶
Added in version 4.16.
Налаштовує
REGISTRATION_REBIND
.
- WEBLATE_TIME_ZONE¶
Налаштовує використаний часовий пояс у Weblate, див.
TIME_ZONE
.Примітка
Щоб змінити часовий пояс самого контейнера Docker, скористайтеся змінною середовища
TZ
.Приклад:
environment: WEBLATE_TIME_ZONE: Europe/Prague
- WEBLATE_ENABLE_HTTPS¶
Вказує Weblate, що слід працювати за оберненим проксі HTTPS. У результаті Weblate використовує HTTPS у посиланнях електронної пошти та програмного інтерфейсу та встановлює прапорці захищеності у куках.
Підказка
Будь ласка, ознайомтеся із документацією до
ENABLE_HTTPS
, щоб дізнатися більше про можливі проблеми.Примітка
Це не призводить до того, що контейнер Weblate починає приймати з’єднання HTTPS. Прийняття таких з’єднань слід налаштувати окремо, див. приклади у розділі Контейнер Docker із підтримкою HTTPS.
Приклад:
environment: WEBLATE_ENABLE_HTTPS: 1
- WEBLATE_INTERLEDGER_PAYMENT_POINTERS¶
Added in version 4.12.1.
Надає Weblate змогу встановлювати поле meta[name=monetization] у заголовку документа. Якщо вказано декілька, значення буде вибрано випадковим чином.
Дивись також
- WEBLATE_IP_PROXY_HEADER¶
Дозволяє Weblate отримувати IP-адресу з будь-якого вказаного заголовка HTTP. Скористайтеся цим, якщо використовуєте обернений проксі перед контейнером Weblate.
Вмикає
IP_BEHIND_REVERSE_PROXY
і встановлюєIP_PROXY_HEADER
.Примітка
Формат має відповідати очікуванням Django. Django перетворює прості назви заголовків HTTP ось так:
перетворює усі символи до верхнього регістру
замінює усі дефіси символами підкреслення
дописує префікс
HTTP_
Отже
X-Forwarded-For
буде пов’язано ізHTTP_X_FORWARDED_FOR
.Приклад:
environment: WEBLATE_IP_PROXY_HEADER: HTTP_X_FORWARDED_FOR
- WEBLATE_IP_PROXY_OFFSET¶
Added in version 5.0.1.
Налаштовує
IP_PROXY_OFFSET
.
- WEBLATE_USE_X_FORWARDED_PORT¶
Added in version 5.0.1.
Булеве значення, яке визначає, чи слід надавати перевагу використанню заголовка X-Forwarded-Port перед змінною середовища SERVER_PORT META. Слід використовувати, лише при роботі з проксі-сервером, який встановлює цей заголовок.
Дивись також
Примітка
Це булевий параметр (скористайтеся значенням
"true"
або"false"
).
- WEBLATE_SECURE_PROXY_SSL_HEADER¶
Кортеж, який складається з заголовка HTTP і комбінації значень. Вказує на те, що запит є захищеним. Потрібен, якщо Weblate працює за оберненим проксі, який виконує обривання SSL без передавання стандартних заголовків HTTPS.
Приклад:
environment: WEBLATE_SECURE_PROXY_SSL_HEADER: HTTP_X_FORWARDED_PROTO,https
Дивись також
- WEBLATE_REQUIRE_LOGIN¶
Вмикає
REQUIRE_LOGIN
для примусового розпізнавання в усьому Weblate.Приклад:
environment: WEBLATE_REQUIRE_LOGIN: 1
- WEBLATE_LOGIN_REQUIRED_URLS_EXCEPTIONS¶
- WEBLATE_ADD_LOGIN_REQUIRED_URLS_EXCEPTIONS¶
- WEBLATE_REMOVE_LOGIN_REQUIRED_URLS_EXCEPTIONS¶
Додає винятки URL-адрес для розпізнавання, потрібного для всього встановлення Weblate, за допомогою
LOGIN_REQUIRED_URLS_EXCEPTIONS
.Ви можете або замінити усі параметри, або змінити типове значення за допомогою змінних
ADD
іREMOVE
.Для примусового використання форми контакту виконайте такі дії:
environment: WEBLATE_REMOVE_LOGIN_REQUIRED_URLS_EXCEPTIONS: /contact/$
- WEBLATE_GOOGLE_ANALYTICS_ID¶
Налаштовує ідентифікатор для Google Analytics зміною
GOOGLE_ANALYTICS_ID
.
- WEBLATE_DEFAULT_PULL_MESSAGE¶
Налаштовує типовий заголовок та повідомлення для запитів щодо об’єднання, які створено за допомогою програмного інтерфейсу за допомогою зміни
DEFAULT_PULL_MESSAGE
Дивись також
- WEBLATE_SIMPLIFY_LANGUAGES¶
Налаштовує правила спрощення мов, див.
SIMPLIFY_LANGUAGES
.
- WEBLATE_DEFAULT_ACCESS_CONTROL¶
Налаштовує типове Керування доступом для нових проєктів, див.
DEFAULT_ACCESS_CONTROL
.
- WEBLATE_DEFAULT_RESTRICTED_COMPONENT¶
Налаштовує типове значення Обмежений доступ для нових складників, див.
DEFAULT_RESTRICTED_COMPONENT
.
- WEBLATE_DEFAULT_TRANSLATION_PROPAGATION¶
Налаштовує типове значення Дозволити поширення перекладу для нових складників, див.
DEFAULT_TRANSLATION_PROPAGATION
.
- WEBLATE_DEFAULT_COMMITER_EMAIL¶
Налаштовує
DEFAULT_COMMITER_EMAIL
.
- WEBLATE_DEFAULT_COMMITER_NAME¶
Налаштовує
DEFAULT_COMMITER_NAME
.
- WEBLATE_DEFAULT_SHARED_TM¶
Налаштовує
DEFAULT_SHARED_TM
.
- WEBLATE_AKISMET_API_KEY¶
Налаштовує ключ до програмного інтерфейсу Akismet, див.
AKISMET_API_KEY
.
- WEBLATE_GPG_IDENTITY¶
Налаштовує підписування внесків за допомогою GPG, див.
WEBLATE_GPG_IDENTITY
.Дивись також
- WEBLATE_URL_PREFIX¶
Налаштовує префікс адреси, на якій запущено Weblate, див.
URL_PREFIX
.
- WEBLATE_SILENCED_SYSTEM_CHECKS¶
Налаштовує перевірки, підсумки яких ви не хочете бачити, див.
SILENCED_SYSTEM_CHECKS
.
- WEBLATE_CSP_SCRIPT_SRC¶
- WEBLATE_CSP_IMG_SRC¶
- WEBLATE_CSP_CONNECT_SRC¶
- WEBLATE_CSP_STYLE_SRC¶
- WEBLATE_CSP_FONT_SRC¶
- WEBLATE_CSP_FORM_SRC¶
Надає змогу налаштовувати заголовок HTTP
Content-Security-Policy
.
- WEBLATE_LICENSE_FILTER¶
Налаштовує
LICENSE_FILTER
.
- WEBLATE_LICENSE_REQUIRED¶
Налаштовує
LICENSE_REQUIRED
- WEBLATE_WEBSITE_REQUIRED¶
Налаштовує
WEBSITE_REQUIRED
- WEBLATE_HIDE_VERSION¶
Налаштовує
HIDE_VERSION
.
- WEBLATE_BASIC_LANGUAGES¶
Налаштовує
BASIC_LANGUAGES
.
- WEBLATE_DEFAULT_AUTO_WATCH¶
Налаштовує
DEFAULT_AUTO_WATCH
.
- WEBLATE_RATELIMIT_ATTEMPTS¶
- WEBLATE_RATELIMIT_LOCKOUT¶
- WEBLATE_RATELIMIT_WINDOW¶
Added in version 4.6.
Налаштовує обмеження частоти.
Підказка
Ви можете встановити налаштування для будь-яких діапазонів обмежень частоти. Для цього додайте префікс
WEBLATE_
до будь-якого з параметрів, які описано у Обмеження частоти.Дивись також
Обмеження частоти,
RATELIMIT_ATTEMPTS
,RATELIMIT_WINDOW
,RATELIMIT_LOCKOUT
- WEBLATE_API_RATELIMIT_ANON¶
- WEBLATE_API_RATELIMIT_USER¶
Added in version 4.11.
Визначає обмеження на частоту використання програмного інтерфейсу. За типових налаштувань можна виконувати не більше 100 запитів на день для анонімних користувачів і не більше 5000 запитів на годину для користувачів, які пройшли розпізнавання у системі.
Дивись також
- WEBLATE_ENABLE_HOOKS¶
Added in version 4.13.
Налаштовує
ENABLE_HOOKS
.
- WEBLATE_ENABLE_AVATARS¶
Added in version 4.6.1.
Налаштовує
ENABLE_AVATARS
.
- WEBLATE_AVATAR_URL_PREFIX¶
Added in version 4.15.
Налаштовує
AVATAR_URL_PREFIX
.
- WEBLATE_LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH¶
Added in version 4.9.
Налаштовує
LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH
.
- WEBLATE_SSH_EXTRA_ARGS¶
Added in version 4.9.
Налаштовує
SSH_EXTRA_ARGS
.
- WEBLATE_BORG_EXTRA_ARGS¶
Added in version 4.9.
Налаштовує
BORG_EXTRA_ARGS
як список відокремлених комами аргументів.Приклад:
environment: WEBLATE_BORG_EXTRA_ARGS: --exclude,vcs/
- WEBLATE_ENABLE_SHARING¶
Added in version 4.14.1.
Налаштовує
ENABLE_SHARING
.
- WEBLATE_SUPPORT_STATUS_CHECK¶
Added in version 5.5.
Налаштовує
SUPPORT_STATUS_CHECK
.
- WEBLATE_EXTRA_HTML_HEAD¶
Added in version 4.15.
Налаштовує
EXTRA_HTML_HEAD
.
- WEBLATE_PRIVATE_COMMIT_EMAIL_TEMPLATE¶
Added in version 4.15.
Налаштовує
PRIVATE_COMMIT_EMAIL_TEMPLATE
.
- WEBLATE_PRIVATE_COMMIT_EMAIL_OPT_IN¶
Added in version 4.15.
Налаштовує
PRIVATE_COMMIT_EMAIL_OPT_IN
.
- WEBLATE_UNUSED_ALERT_DAYS¶
Added in version 4.17.
Налаштовує
UNUSED_ALERT_DAYS
.
- WEBLATE_CORS_ALLOWED_ORIGINS¶
Added in version 4.16.
Allow CORS requests to API from given origins.
Приклад:
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.
- CLIENT_MAX_BODY_SIZE¶
Added in version 4.16.3.
Налаштовує максимальний розмір вмісту, який приймається вбудованим вебсервером.
environment: CLIENT_MAX_BODY_SIZE: 200m
Підказка
У назві цієї змінної навмисне пропущено префікс
WEBLATE_
, оскільки вона є змінною спільного використання із стороннім контейнером, що використовується у Автоматична сертифікація SSL за допомогою Let’s Encrypt.
Реєстраційні дані сайтів, де зберігається код¶
У контейнері Docker реєстраційні дані на місці збереження коду можна налаштувати або за допомогою окремих змінних, або за допомогою словника Python для одночасного їхнього встановлення. У наведених нижче прикладах використано Запити щодо злиття GitHub, або дані можна застосувати до всіх Інтеграція з системою керування версіями із відповідною зміною назв змінних.
Зразок налаштувань для GitHub може мати такий вигляд:
WEBLATE_GITHUB_USERNAME=api-user
WEBLATE_GITHUB_TOKEN=api-token
WEBLATE_GITHUB_HOST=api.github.com
Буде використано так:
GITHUB_CREDENTIALS = {
"api.github.com": {
"username": "api-user",
"token": "api-token",
}
}
Крім того, словник Python може бути наданий у вигляді рядка:
WEBLATE_GITHUB_CREDENTIALS='{ "api.github.com": { "username": "api-user", "token": "api-token", } }'
Або шлях до файлу, що містить словник 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¶
Налаштовує Запити щодо злиття GitHub зміною
GITHUB_CREDENTIALS
.
- WEBLATE_GITLAB_USERNAME¶
- WEBLATE_GITLAB_TOKEN¶
- WEBLATE_GITLAB_HOST¶
- WEBLATE_GITLAB_CREDENTIALS¶
Налаштовує Запити щодо об’єднання GitLab зміною
GITLAB_CREDENTIALS
.
- WEBLATE_GITEA_USERNAME¶
- WEBLATE_GITEA_TOKEN¶
- WEBLATE_GITEA_HOST¶
- WEBLATE_GITEA_CREDENTIALS¶
Налаштовує Запити щодо злиття Gitea зміною
GITEA_CREDENTIALS
.
- WEBLATE_PAGURE_USERNAME¶
- WEBLATE_PAGURE_TOKEN¶
- WEBLATE_PAGURE_HOST¶
- WEBLATE_PAGURE_CREDENTIALS¶
Налаштовує Запити щодо об’єднання Pagure зміною
PAGURE_CREDENTIALS
.
- WEBLATE_BITBUCKETSERVER_USERNAME¶
- WEBLATE_BITBUCKETSERVER_TOKEN¶
- WEBLATE_BITBUCKETSERVER_HOST¶
- WEBLATE_BITBUCKETSERVER_CREDENTIALS¶
Налаштовує Запит щодо злиття для сервера Bitbucket зміною
BITBUCKETSERVER_CREDENTIALS
.
- WEBLATE_AZURE_DEVOPS_USERNAME¶
- WEBLATE_AZURE_DEVOPS_ORGANIZATION¶
- WEBLATE_AZURE_DEVOPS_TOKEN¶
- WEBLATE_AZURE_DEVOPS_HOST¶
- WEBLATE_AZURE_DEVOPS_CREDENTIALS¶
Налаштовує Запити щодо об’єднання Azure DevOps зміною
AZURE_DEVOPS_CREDENTIALS
.
Параметри автоматичних пропозицій¶
Змінено в версії 4.13: У новій версії автоматичні пропозиції можна налаштувати за допомогою інтерфейсу користувача, див. Автоматичні пропозиції.
Наявні змінні середовища буде імпортовано під час перенесення даних на Weblate 4.13, але внесення до них змін більше ні на що не впливатиме.
Параметри розпізнавання¶
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.
Приклад безпосередньої прив’язки:
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
Приклад пошуку і прив’язки:
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
Приклад пошуку і прив’язки об’єднання:
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
Приклад із пошуком і прив’язкою до 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)
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¶
Вмикає Розпізнавання за GitHub.
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¶
Вмикає Розпізнавання EE GitHub.
Bitbucket¶
- WEBLATE_SOCIAL_AUTH_BITBUCKET_OAUTH2_KEY¶
- WEBLATE_SOCIAL_AUTH_BITBUCKET_OAUTH2_SECRET¶
- WEBLATE_SOCIAL_AUTH_BITBUCKET_KEY¶
- WEBLATE_SOCIAL_AUTH_BITBUCKET_SECRET¶
Вмикає Розпізнавання за Bitbucket.
Facebook¶
- WEBLATE_SOCIAL_AUTH_FACEBOOK_KEY¶
- WEBLATE_SOCIAL_AUTH_FACEBOOK_SECRET¶
Вмикає 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¶
Вмикає Google OAuth 2.
GitLab¶
- WEBLATE_SOCIAL_AUTH_GITLAB_KEY¶
- WEBLATE_SOCIAL_AUTH_GITLAB_SECRET¶
- WEBLATE_SOCIAL_AUTH_GITLAB_API_URL¶
Вмикає GitLab OAuth 2.
Gitea¶
- WEBLATE_SOCIAL_AUTH_GITEA_API_URL¶
- WEBLATE_SOCIAL_AUTH_GITEA_KEY¶
- WEBLATE_SOCIAL_AUTH_GITEA_SECRET¶
Вмикає розпізнавання за допомогою Gitea.
Azure Active Directory¶
- WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_KEY¶
- WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET¶
Вмикає розпізнавання за даними Active Directory в Azure, див. Microsoft Azure Active Directory.
Azure Active Directory із підтримкою Tenant¶
- WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_KEY¶
- WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_SECRET¶
- WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_TENANT_ID¶
Вмикає розпізнавання за даними Active Directory в Azure із підтримкою Tenant, див. 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¶
- WEBLATE_SOCIAL_AUTH_KEYCLOAK_TITLE¶
- WEBLATE_SOCIAL_AUTH_KEYCLOAK_IMAGE¶
Вмикає розпізнавання за допомогою Keycloak, див. документацію.
Постачальники Linux¶
Ви можете увімкнути розпізнавання за допомогою служб розпізнавання постачальників Linux, встановивши для вказаних нижче змінних довільне значення.
- WEBLATE_SOCIAL_AUTH_FEDORA¶
- WEBLATE_SOCIAL_AUTH_OPENSUSE¶
- WEBLATE_SOCIAL_AUTH_OPENINFRA¶
- WEBLATE_SOCIAL_AUTH_UBUNTU¶
Ідентифікатор¶
- WEBLATE_SOCIAL_AUTH_SLACK_KEY¶
- SOCIAL_AUTH_SLACK_SECRET¶
Вмикає розпізнавання за допомогою Slack, див. Ідентифікатор.
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¶
Налаштовує типову інтеграцію з OpenID Connect.
Дивись також
SAML¶
При першому запуску контейнера автоматично створюються самопідписані ключі SAML. Якщо ви хочете скористатися власними ключами, розмістіть сертифікат і закритий ключ у /app/data/ssl/saml.crt
і /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, див. Розпізнавання за SAML.
- WEBLATE_SAML_ID_ATTR_NAME¶
- WEBLATE_SAML_ID_ATTR_USERNAME¶
- WEBLATE_SAML_ID_ATTR_EMAIL¶
- WEBLATE_SAML_ID_ATTR_USER_PERMANENT_ID¶
Added in version 4.18.
Прив’язка атрибутів SAML.
Інші параметри розпізнавання¶
- WEBLATE_NO_EMAIL_AUTH¶
Вимикає розпізнавання за допомогою електронної пошти, якщо встановлено будь-яке значення. Див. Вимикання розпізнавання за паролем.
Налаштування бази даних PostgreSQL¶
База даних створюється docker-compose.yml
, отже ці параметри стосуються одразу контейнерів Weblate і PostgreSQL.
Дивись також
- POSTGRES_PASSWORD¶
Пароль до PostgreSQL.
Дивись також
- POSTGRES_USER¶
Ім’я користувача PostgreSQL.
- POSTGRES_DB¶
Назва бази даних PostgreSQL.
- POSTGRES_HOST¶
Назва вузла сервера PostgreSQL або його IP-адреса. Типове значення —
database
.
- POSTGRES_PORT¶
Порт сервера PostgreSQL. Типового порту немає (використовується типове значення порту).
- POSTGRES_SSL_MODE¶
Налаштовує спосіб обробки SSL у PostgreSQL при з’єднанні із сервером. Можливі варіанти можна знайти у розділі Опис режимів SSL
- POSTGRES_ALTER_ROLE¶
Налаштовує назву ролі для зміни під час перенесення даних, див. Налаштовування Weblate на використання PostgreSQL.
- POSTGRES_CONN_MAX_AGE¶
Added in version 4.8.1.
Час життя з’єднання з базою даних, як ціле число секунд. Використовуйте 0, щоб закривати з’єднання з базою даних в кінці кожного запиту.
Змінено в версії 5.1: Типова поведінка передбачає необмежену кількість постійних з’єднань з базою даних.
Вмикання відліку тривалості з’єднання типово спричиняє збільшення кількості відкритих з’єднань із базою даних. Будь ласка, скоригуйте налаштування бази даних, перш ніж вмикати цю можливість.
Приклад налаштувань:
environment: POSTGRES_CONN_MAX_AGE: 3600
Дивись також
- POSTGRES_DISABLE_SERVER_SIDE_CURSORS¶
Added in version 4.9.1.
Вимкнути вказівники на боці сервера у базі даних. Це необхідно у деяких конфігураціях pgbouncer.
Приклад налаштувань:
environment: POSTGRES_DISABLE_SERVER_SIDE_CURSORS: 1
- WEBLATE_DATABASES¶
Added in version 5.1.
Установіть значення false, щоб вимкнути конфігурацію з’єднання з базою даних на основі середовища. Використовуйте Перевизначення параметрів з тому даних для налаштування під’єднання до бази даних вручну.
Сервер MySQL або MariaDB¶
Ані MySQL, ані MariaDB не можна налаштовувати за допомогою змінних оточення. Дивіться MySQL і MariaDB для отримання інформації про використання цих змінних з Weblate. Використовуйте WEBLATE_DATABASES
для налаштування під’єднання до бази даних вручну.
Параметри резервного копіювання бази даних¶
Дивись також
- WEBLATE_DATABASE_BACKUP¶
Налаштовує щоденне створення дампу бази даних за допомогою
DATABASE_BACKUP
. Типовим значенням єplain
.
Налаштування сервера кешування¶
Наполегливо рекомендуємо користуватися Redis. Вам слід надати екземпляр Redis, якщо ви запускаєте Weblate у Docker.
Дивись також
- REDIS_HOST¶
Назва вузла сервера Redis або IP-адреса. Типовою є
cache
.
- REDIS_PORT¶
Порт сервера Redis. Типовим є
6379
.
- REDIS_DB¶
Номер бази даних Redis. Типовим є
1
.
- REDIS_PASSWORD¶
Пароль до сервера Redis. Типово, не використовується.
Дивись також
- REDIS_TLS¶
Вмикає використання SSL для з’єднання Redis.
- REDIS_VERIFY_SSL¶
Може бути використано для вимикання перевірки сертифікатів SSL для з’єднання Redis.
Налаштування сервера електронної пошти¶
Для забезпечення роботи з надсилання електронної пошти вам слід вказати поштовий сервер.
Приклад налаштувань TLS:
environment:
WEBLATE_EMAIL_HOST: smtp.example.com
WEBLATE_EMAIL_HOST_USER: user
WEBLATE_EMAIL_HOST_PASSWORD: pass
Приклад налаштувань 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
Дивись також
- WEBLATE_EMAIL_HOST¶
Назва вузла або IP-адреса поштового сервера.
Дивись також
WEBLATE_EMAIL_PORT
,WEBLATE_EMAIL_USE_SSL
,WEBLATE_EMAIL_USE_TLS
,EMAIL_HOST
- WEBLATE_EMAIL_PORT¶
Порт поштового сервера. Типовим є 25.
Дивись також
- WEBLATE_EMAIL_HOST_USER¶
Користувач для розпізнавання для доступу до електронної пошти.
Дивись також
- WEBLATE_EMAIL_HOST_PASSWORD¶
Пароль для розпізнавання для доступу до електронної пошти.
Дивись також
- WEBLATE_EMAIL_USE_SSL¶
Визначає, чи слід використовувати неявне з’єднання TLS (захищене) при обміні даними із сервером SMTP. У більшій частині документації з електронної пошти цей тип з’єднання TLS називають SSL. Зазвичай, ним користуються на порту 465. Якщо у вас виникають проблеми, див. явне визначення TLS за допомогою
WEBLATE_EMAIL_USE_TLS
.Змінено в версії 4.11: Підтримка SSL/TLS вмикається автоматично на основі значення
WEBLATE_EMAIL_PORT
.Дивись також
- WEBLATE_EMAIL_USE_TLS¶
Визначає, чи слід використовувати з’єднання TLS (захищене) при обміні даними із сервером SMTP. Використовується для явних з’єднань TLS, зазвичай, на портах 587 і 25. Якщо у вас виникають проблеми із зависанням з’єднання, див. неявний параметр TLS
WEBLATE_EMAIL_USE_SSL
.Змінено в версії 4.11: Підтримка SSL/TLS вмикається автоматично на основі значення
WEBLATE_EMAIL_PORT
.Дивись також
- WEBLATE_EMAIL_BACKEND¶
Налаштовує модуль обробки Django на використання для надсилання повідомлень електронної пошти.
Дивись також
- WEBLATE_AUTO_UPDATE¶
Налаштовує, чи має Weblate оновлювати сховища і те, як це слід робити.
Дивись також
Примітка
Це булевий параметр (скористайтеся значенням
"true"
або"false"
).
Інтеграція сайта¶
- WEBLATE_GET_HELP_URL¶
Налаштовує
GET_HELP_URL
.
- WEBLATE_STATUS_URL¶
Налаштовує
STATUS_URL
.
- WEBLATE_PRIVACY_URL¶
Налаштовує
PRIVACY_URL
.
Збирання звітів щодо помилок та стеження за швидкодією¶
Рекомендуємо збирати помилки щодо встановленого екземпляра систематично, див. Збирання звітів щодо помилок та стеження за швидкодією.
Щоб увімкнути підтримку Rollbar, встановіть таке:
- ROLLBAR_KEY¶
Ваш ключ доступу до сервера надсилання Rollbar.
- ROLLBAR_ENVIRONMENT¶
Ваше середовище Rollbar, типове значення —
production
.
Щоб увімкнути підтримку Sentry, встановіть таке:
- SENTRY_DSN¶
Ваш DSN Sentry, див.
SENTRY_DSN
.
- SENTRY_ENVIRONMENT¶
Ваше середовище Sentry (необов’язкове), типовим значенням є
WEBLATE_SITE_DOMAIN
.
- SENTRY_TRACES_SAMPLE_RATE¶
Налаштовує
SENTRY_TRACES_SAMPLE_RATE
.Приклад:
environment: SENTRY_TRACES_SAMPLE_RATE: 0.5
- SENTRY_PROFILES_SAMPLE_RATE¶
Налаштовує
SENTRY_PROFILES_SAMPLE_RATE
.Приклад:
environment: SENTRY_PROFILES_SAMPLE_RATE: 0.5
- SENTRY_SEND_PII¶
Налаштовує
SENTRY_SEND_PII
.
CDN локалізації¶
- WEBLATE_LOCALIZE_CDN_URL¶
- WEBLATE_LOCALIZE_CDN_PATH¶
Added in version 4.2.1.
Налаштування для CDN локалізації JavaScript.
WEBLATE_LOCALIZE_CDN_PATH
є шляхом у контейнері. Сховище даних має перебувати на постійному томі, а не у тимчасовому сховищі зберігання даних.Одним із можливих варіантів є зберігання даних у каталозі даних Weblate:
environment: WEBLATE_LOCALIZE_CDN_URL: https://cdn.example.com/ WEBLATE_LOCALIZE_CDN_PATH: /app/data/l10n-cdn
Примітка
Ви несете відповідальність за налаштування обслуговування файлів, згенерованих Weblate, файли зберігаються лише в налаштованому місці.
Changing enabled apps, checks, add-ons, machine translation or autofixes¶
Вбудовані налаштування увімкнених перевірок, додатків або автоматичних виправлень можна скоригувати за допомогою таких змінних:
- WEBLATE_ADD_APPS¶
- WEBLATE_REMOVE_APPS¶
- WEBLATE_ADD_CHECK¶
- WEBLATE_REMOVE_CHECK¶
- WEBLATE_ADD_AUTOFIX¶
- WEBLATE_REMOVE_AUTOFIX¶
- WEBLATE_ADD_ADDONS¶
- WEBLATE_REMOVE_ADDONS¶
- WEBLATE_ADD_MACHINERY¶
Added in version 5.6.1.
- WEBLATE_REMOVE_MACHINERY¶
Added in version 5.6.1.
Приклад:
environment:
WEBLATE_REMOVE_AUTOFIX: weblate.trans.autofixes.whitespace.SameBookendingWhitespace
WEBLATE_ADD_ADDONS: customize.addons.MyAddon,customize.addons.OtherAddon
Дивись також
CHECK_LIST
,
AUTOFIX_LIST
,
WEBLATE_ADDONS
,
INSTALLED_APPS
WEBLATE_MACHINERY
Параметри контейнерів¶
- WEBLATE_WORKERS¶
Added in version 4.6.1.
Базова кількість процесів-обробників, які працюють у контейнері. Якщо не вказано, визначається автоматично при запуску контейнера на основі кількості доступних ядер процесора.
Використовується для визначення
CELERY_MAIN_OPTIONS
,CELERY_NOTIFY_OPTIONS
,CELERY_MEMORY_OPTIONS
,CELERY_TRANSLATE_OPTIONS
,CELERY_BACKUP_OPTIONS
,CELERY_BEAT_OPTIONS
, andWEB_WORKERS
. Ви можете скористатися цими параметрами для коригування параметрів.
- CELERY_MAIN_OPTIONS¶
- CELERY_NOTIFY_OPTIONS¶
- CELERY_MEMORY_OPTIONS¶
- CELERY_TRANSLATE_OPTIONS¶
- CELERY_BACKUP_OPTIONS¶
- CELERY_BEAT_OPTIONS¶
За допомогою цих змінних ви можете скоригувати параметри обробника Celery. Цим можна скористатися для коригування паралельної обробки (
--concurrency 16
) або використання іншої реалізації буфера (--pool=gevent
).Типово, кількість конкурентних обробників визначається на основі
WEBLATE_WORKERS
.Приклад:
environment: CELERY_MAIN_OPTIONS: --concurrency 16
- CELERY_SINGLE_PROCESS¶
Added in version 5.7.1: This variable can be set to
1
to run only one celery process. This reduces memory usage but may impact Weblate performance.environment: CELERY_SINGLE_PROCESS: 1
Дивись також
- WEB_WORKERS¶
Налаштувати кількість обробників uWSGI, які має бути виконано.
Типовим значенням є
WEBLATE_WORKERS
.Приклад:
environment: WEB_WORKERS: 32
- WEBLATE_SERVICE¶
Визначає, які служби слід запускати всередині контейнера. Скористайтеся цим для масштабування <docker-scaling.
Визначено такі перевірки:
celery-beat
Планувальник завдань Celery, має бути запущено лише один екземпляр. Цей контейнер також відповідає за перенесення структури бази даних, його має бути запущено перед усіма іншими.
celery-backup
Обробник Celery для резервного копіювання, має бути запущено лише один екземпляр.
celery-celery
Загальний обробник Celery.
celery-memory
Обробник пам’яті перекладів Celery.
celery-notify
Обробник сповіщень Celery.
celery-translate
Обробник автоматичних перекладів Celery.
web
Вебсервер.
Томи контейнера 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 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.
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.
Під час створення томів власноруч, каталоги повинні належати UID 1000, як користувачеві, що використовується всередині контейнера.
Дивись також
Призначена лише для читання коренева файлова система¶
Added in version 4.18.
Якщо запущено контейнер із призначеної лише для читання кореневої файлової системи, потрібні два додаткових томи tmpfs — /tmp
і /run
.
Налаштовування поза змінними середовища¶
Доступ до більшості параметрів налаштувань, які пов’язано із встановленим Weblate, має здійснюватися за допомогою змінних середовища Docker.
Якщо вами буде виявлено параметр, доступу до якого немає зі змінної середовища, і ви вважаєте, що такий доступ має бути реалізовано, попросіть про відкриття доступу у майбутніх версіях Weblate.
Якщо вам потрібно змінити значення параметра, доступу до якого немає зі змінних середовища Docker, ви можете це зробити або за допомогою тому даних, або за допомогою розширення образу Docker.
Дивись також
Перевизначення параметрів з тому даних¶
Ви можете створити файл з адресою /app/data/settings-override.py
, тобто у корені тому даних, з метою розширення або перевизначення параметрів, значення яких встановлено за допомогою змінних середовища.
Перевизначення параметрів за допомогою розширення образу Docker¶
Щоб перевизначити параметри на рівні образу Docker, а не з тому даних, виконайте такі дії:
Додайте до вашого пакунка модуль, який імпортує усі параметри з
weblate.settings_docker
.Наприклад, у структурі пакунка-прикладу, яку визначено у Створення модуля Python, ви можете створити файл
weblate_customization/weblate_customization/settings.py
із таким початковим кодом:from weblate.settings_docker import *
Створіть нетиповий
Dockerfile
, який успадковуватиме офіційний образ Docker Weblate, а потім встановіть ваш пакунок і вкажіть для змінної середовищаDJANGO_SETTINGS_MODULE
ваш модуль параметрів:FROM weblate/weblate USER root COPY weblate_customization /usr/src/weblate_customization RUN /app/venv/bin/uv pip install --no-cache-dir /usr/src/weblate_customization ENV DJANGO_SETTINGS_MODULE=weblate_customization.settings USER 1000
Замість використання офіційного образу Docker Weblate, зберіть нетиповий образ з цього файла
Dockerfile
.Немає простого способу зробити це за допомогою
docker-compose.override.yml
. Можна було б додатиbuild: .
до вузлаweblate
у цьому файлі, але тоді б ваш нетиповий образ було б позначено якweblate/weblate
у вашій системі, що призвело б до проблем.Тому, замість використання
docker-compose.yml
безпосередньо з офіційного сховища, без змін, і його розширення за допомогоюdocker-compose.override.yml
, вам варто створити копію офіційного файлаdocker-compose.yml
і внести до неї зміни, замінившиimage: weblate/weblate
наbuild: .
.Див. Compose file build reference, щоб дізнатися більше про збирання образів з початкового коду за допомогою
docker-compose
.Розширте ваш модуль нетипових параметрів, визначивши або перевизначивши параметри.
Ви можете визначити параметри до або після інструкції з імпортування, наведеної вище, щоб визначити, які параметри мають пріоритет. Параметри, які визначено до інструкції з імпортування, може бути перевизначено змінними середовища та перевизначеннями параметрів у томі даних. Параметри, які визначено після інструкції з імпортування, не може бути перевизначено.
Ви можете піти і далі. Наприклад, ви можете відтворити деякі з речей, які робить
weblate.docker_settings
, зокрема, надання доступу до параметрів через змінні середовища або уможливлення перевизначення параметрів з файлів Python у томі даних.
Заміна логотипа та інших статичних файлів¶
Статичні файли, які постачаються із Weblate, можна перевизначити розташуванням змінених варіантів у /app/data/python/customize/static
(див. Томи контейнера Docker). Наприклад, шляхом створення /app/data/python/customize/static/favicon.ico
можна замінити favicon.
Підказка
Файли копіюються до відповідного місця під час запуску контейнера, отже після внесення змін до вмісту тому потрібен перезапуск Weblate.
Цей підхід можна також використати для перевизначення шаблонів Weblate. Наприклад, документи Правові відомості можна розташувати у /app/data/python/customize/templates/legal/documents
.
Крім того, ви можете включити власний модуль (див. Налаштовування Weblate) і додати його як окремий том до контейнера Docker. Приклад:
weblate:
volumes:
- weblate-data:/app/data
- ./weblate_customization/weblate_customization:/app/data/python/weblate_customization
environment:
WEBLATE_ADD_APPS: weblate_customization
Налаштування сервера PostgreSQL¶
У контейнері для PostgreSQL використано типові налаштування PostgreSQL, він не зможе ефективно використати ваші ядра процесора або пам’ять. Для підвищення швидкодії рекомендуємо додатково налаштувати контейнер.
Налаштування можна скоригувати, як це описано у розділі Database Configuration на https://hub.docker.com/_/postgres. Налаштування, які відповідають вашому середовищу можна створити за допомогою https://pgtune.leopard.in.ua/.
Нутрощі контейнера¶
Контейнер використовує для запуску окремих служб supervisor. У випадку Горизонтальне масштабування ця програма запускає єдину службу у контейнері.
Для перевірки стану служб скористайтеся таким:
docker compose exec --user weblate weblate supervisorctl status
Для кожної черги Celery передбачено окремі служби (щоб дізнатися більше, див. Фонові завдання з використанням Celery). Ви можете зупинити обробку певних завдань, зупинивши відповідний обробник:
docker compose exec --user weblate weblate supervisorctl stop celery-translate