Конфигурация#

Все настройки хранятся в файле settings.py (как обычно для проектов Django).

Примечание

После изменения любого из этих параметров вам необходимо перезапустить Weblate — как процесс WSGI, так и процесс Celery.

В случае, если Weblate работает через mod_wsgi, для перезагрузки конфигурации вам нужно перезапустить Apache.

См.также

Также, пожалуйста, ознакомьтесь с документацией Django по настройке параметров самого Django.

ADMINS_CONTACT#

Настройка, указывающая, куда отправлять электронные письма из контактной формы. Если не настроена, будут использованы адреса электронной почты из ADMINS.

Настройте это как список адресов электронной почты:

ADMINS_CONTACT = ["admin@example.com", "support@example.com"]

См.также

CONTACT_FORM, ADMINS

AKISMET_API_KEY#

Weblate может использовать Akismet для проверки входящих анонимных предложений на спам. Посетите akismet.com, чтобы приобрести ключ API и связать его с сайтом.

ANONYMOUS_USER_NAME#

Имена пользователей, которые не входят в систему.

AUDITLOG_EXPIRY#

Сколько дней Weblate должен хранить журналы аудита, в которых содержится информация о деятельности учётной записи.

По умолчанию установлен в 180 дней.

AUTH_LOCK_ATTEMPTS#

Максимальное количество неудачных попыток авторизации до применения ограничения частоты запросов.

В настоящее время оно применяется в следующих местах:

  • Страница входа. Удаляет пароль учётной записи, не позволяя пользователю войти в систему без запроса нового пароля.

  • Страница сброса пароля. Предотвращает отправку новых писем, избегая рассылки спама пользователям со слишком большим количеством попыток сброса пароля.

По умолчанию установлен в 10.

AUTO_UPDATE#

Обновление всех репозиториев на ежедневной основе.

Подсказка

Полезно, если вы не используете обработчики для автоматического обновления репозиториев Weblate.

Примечание

Варианты включено/выключено в дополнение к строкам существуют для обратной совместимости.

Возможны следующие варианты:

"none"

Никаких ежедневных обновлений.

"remote" или False

Только вытягиваются изменения из удалённых репозиториев.

"full" или True

Вытягиваются изменения из удалённых репозиториев и сливаются с рабочей копией.

Примечание

Для включения этого параметра необходима работа фоновых задач Celery, также он вступит в силу после их перезапуска.

AVATAR_URL_PREFIX#

Префикс для генерирования URL-адресов аватаров в выражении ${AVATAR_URL_PREFIX}/avatar/${MAIL_HASH}?${PARAMS}. Сервисы аватаров работают следующим образом:

Gravatar (по умолчанию), согласно https://gravatar.com/

AVATAR_URL_PREFIX = 'https://www.gravatar.com/'

Libravatar, согласно https://www.libravatar.org/

AVATAR_URL_PREFIX = 'https://www.libravatar.org/'

AUTH_TOKEN_VALID#

Сколько времени действует токен авторизации и временный пароль из писем сброса пароля. Устанавливается в количество секунд, по умолчанию равен 172800 (2 дня).

AUTH_PASSWORD_DAYS#

Сколько дней Weblate не принимает повторное использование ранее использованного пароля для пользователя.

Проверка основана на журнале аудита, параметр: AUDITLOG_EXPIRY должен быть как минимум таким же, как этот.

Примечание

Смена паролей, сделанная в версиях Weblate до версии 2.15, в этой политике учтена не будет.

По умолчанию установлен в 180 дней.

AUTOFIX_LIST#

Список автоматических исправлений, применяемых при сохранении строки.

Примечание

Предоставьте полный путь к классу Python, реализующему интерфейс автоматического исправления.

Доступные исправления:

weblate.trans.autofixes.whitespace.SameBookendingWhitespace

Выравнивает количество начальных и конечных пробельных символов в переводе с исходной строкой.

weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis

Заменяет конечные точки (…) на многоточие (…), если оно есть в исходной строке.

weblate.trans.autofixes.chars.RemoveZeroSpace

Удаляет пробельные символы нулевой ширины, если исходная строка их не содержит.

weblate.trans.autofixes.chars.RemoveControlChars

Удаляет управляющие символы, если исходная строка их не содержит.

weblate.trans.autofixes.chars.DevanagariDanda

Заменяет точку в предложении на бангла символом деванагари данда.

weblate.trans.autofixes.html.BleachHTML

Удаляет небезопасную HTML-разметку из строк, помеченных флагом safe-html (смотрите проверку Небезопасный HTML-код).

Вы можете выбрать, какие исправления использовать:

AUTOFIX_LIST = (
    "weblate.trans.autofixes.whitespace.SameBookendingWhitespace",
    "weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis",
)

BACKGROUND_TASKS#

Добавлено в версии 4.5.2.

Определяет, как часто для компонента должны запускаться задачи длительного обслуживания.

В данный момент оно управляет:

Возможные варианты:

  • monthly (ежемесячно) (по умолчанию)

  • weekly

  • daily

  • never

Примечание

Увеличение частоты не рекомендуется, если Weblate содержит тысячи компонентов.

BASIC_LANGUAGES#

Добавлено в версии 4.4.

Список языков, который будет предлагаться пользователям при создании нового перевода. Если не задан, то будет использоваться встроенный список, который включает все распространённые языки, но без добавления вариантов для конкретных стран.

Это не даёт непривилегированным пользователям добавлять нежелательные языки. Это не влияет на администраторов проектов — они всё также могут выбирать из полного списка языков, доступных в Weblate.

Примечание

Это также не определяет новые языки в Weblate, а только фильтрует те, что уже присутствуют в базе данных.

Пример:

BASIC_LANGUAGES = {"cs", "it", "ja", "en"}

BORG_EXTRA_ARGS#

Добавлено в версии 4.9.

Вы можете передать дополнительные аргументы в команде borg create, когда запускается встроенное резервное копирование.

Пример:

BORG_EXTRA_ARGS = ["--exclude", "vcs/"]

CACHE_DIR#

Добавлено в версии 4.16.

Каталог, в котором Weblate хранит файлы кэша. По умолчанию используется подпапка :file:“cache“ в :setting:“DATA_DIR“.

Измените это значение на локальную или временную файловую систему, если DATA_DIR находится на сетевой файловой системе.

Docker-контейнер использует для этого отдельный том, смотреть раздел Тома контейнеров Docker’а.

Обычно существуют следующие подкаталоги:

fonts

Кэш font-config для Управление шрифтами.

avatar

Кэшированные аватары пользователей, см. Аватары.

static

Расположение статических файлов Django по умолчанию, определяемых переменной STATIC_ROOT. Смотреть раздел Обслуживание статических файлов.

tesseract

Обученные данные OCR для снимков экрана.

CSP_SCRIPT_SRC, CSP_IMG_SRC, CSP_CONNECT_SRC, CSP_STYLE_SRC, CSP_FONT_SRC#

Настройте заголовок Content-Security-Policy для Weblate. Заголовок автоматически создаётся на основе включённых интеграций со сторонними сервисами (Matomo, Google Analytics, Sentry, …).

Все они по умолчанию установлены в пустой список.

Пример:

# Enable Cloudflare Javascript optimizations
CSP_SCRIPT_SRC = ["ajax.cloudflare.com"]

CHECK_LIST#

Список выполняемых для перевода проверок качества.

Примечание

Предоставьте полный путь к классу Python, реализующему интерфейс проверки.

Подправьте список проверок так, чтобы включить в него только нужные вам.

По умолчанию включены все встроенные проверки, оттуда вы можете изменить эти настройки. В примере файла настроек они по умолчанию закомментированы, так что используются значения по умолчанию. В каждой новой версии Weblate туда добавляются новые проверки, если таковые появляются.

Вы можете отключить все проверки:

CHECK_LIST = ()

Можете включить только некоторые:

CHECK_LIST = (
    "weblate.checks.chars.BeginNewlineCheck",
    "weblate.checks.chars.EndNewlineCheck",
    "weblate.checks.chars.MaxLengthCheck",
)

Примечание

Изменение этого параметра влияет только на недавно изменённые переводы, результаты существующих проверок будут по-прежнему сохранены в базе данных. Чтобы также применить изменения к сохранённым переводам, запустите команду updatechecks.

COMMENT_CLEANUP_DAYS#

Удаление комментариев через заданное количество дней. По умолчанию None, что означает, что комментарии не удаляются.

COMMIT_PENDING_HOURS#

Количество часов до коммита ожидающих изменений фоновой задачей.

CONTACT_FORM#

Добавлено в версии 4.6.

Настраивает способ отправки электронной почты из контактной формы. Выберите конфигурацию, соответствующую конфигурации вашего почтового сервера.

``»reply-to»``(ответить)

Отправитель используется в качестве :mailheader:`Reply-To`(ответить), это поведение по умолчанию.

``»from»``(от)

Отправитель используется в качестве :mailheader:`From`(от). Ваш почтовый сервер должен разрешать отправку таких писем.

См.также

ADMINS_CONTACT

DATA_DIR#

Каталог, в котором Weblate хранит все свои данные. Он содержит ссылки на репозитории систем контроля версий, индекс для полнотекстового поиска и различные файлы настроек для внешних инструментов.

Обычно существуют следующие подкаталоги:

home

Домашний каталог, используемый при вызове скриптов.

ssh

Ключи и конфигурация SSH.

media

Расположение медиа-файлов Django по умолчанию, определяемых переменной MEDIA_ROOT. Содержит загруженные снимки экрана, смотреть раздел Визуальный контекст для строк.

vcs

Репозитории с контролем версий для переводов.

backups

Данные ежедневных резервных копий, для получения подробной информации обратитесь к разделу Дампы данных для резервного копирования.

fonts:

Шрифты, загруженные пользователем, смотреть раздел Управление шрифтами.

cache

Различные кэши. Могут быть размещены в другом месте с помощью CACHE_DIR.

Docker-контейнер использует для этого отдельный том, смотреть раздел Тома контейнеров Docker’а.

Примечание

Этот каталог должен быть доступен для записи Weblate. Запуск его как uWSGI означает, что пользователь www-data должен иметь к нему доступ с правами на запись.

Простейший способ этого достичь — сделать пользователя владельцем каталога:

sudo chown www-data:www-data -R $DATA_DIR

По умолчанию /home/weblate/data, но ожидается, что это будет настроено.

DATABASE_BACKUP#

Должны ли резервные копии базы данных храниться в виде простого текста, сжатого файла или не храниться вовсе. Допустимые значения:

  • "plain"

  • "compressed"

  • "none"

DEFAULT_ACCESS_CONTROL#

Настройка контроля доступа по умолчанию для новых проектов:

0

Публичный

1

Защищённый

100

Частный

200

Пользовательский

Используйте Настраиваемый, если списками контроля доступа вы управляете вручную, что означает, что вы не полагаетесь на внутреннее управление Weblate.

DEFAULT_AUTO_WATCH#

Добавлено в версии 4.5.

Настраивает, должен ли параметр Автоматически добавлять проект в отслеживаемые при правке быть включён по умолчанию для новых пользователей. Значение по умолчанию: True.

См.также

Уведомления

DEFAULT_RESTRICTED_COMPONENT#

Добавлено в версии 4.1.

Значение по умолчанию для ограничения компонента.

DEFAULT_ADD_MESSAGE, DEFAULT_ADDON_MESSAGE, DEFAULT_COMMIT_MESSAGE, DEFAULT_DELETE_MESSAGE, DEFAULT_MERGE_MESSAGE#

Умолчательные сообщения коммита для различных операций, для получения подробной информации обратитесь к разделу Настройки компонента.

DEFAULT_ADDONS#

Установка дополнений по умолчанию для каждого созданного компонента.

Примечание

Этот параметр влияет только на новые создаваемые компоненты.

Пример:

DEFAULT_ADDONS = {
    # Add-on with no parameters
    "weblate.flags.target_edit": {},
    # Add-on with parameters
    "weblate.autotranslate.autotranslate": {
        "mode": "suggest",
        "filter_type": "todo",
        "auto_source": "mt",
        "component": "",
        "engines": ["weblate-translation-memory"],
        "threshold": "80",
    },
}

См.также

install_addon, Надстройки, WEBLATE_ADDONS

DEFAULT_COMMITER_EMAIL#

Адрес электронной почты отправившего изменения, по умолчанию равен noreply@weblate.org.

См.также

DEFAULT_COMMITER_NAME

DEFAULT_COMMITER_NAME#

Имя отправившего изменения, по умолчанию равен Weblate.

См.также

DEFAULT_COMMITER_EMAIL

DEFAULT_LANGUAGE#

Добавлено в версии 4.3.2.

Исходный язык для любых новых компонентов.

По умолчанию — en. Соответствующая запись для данного языка должна присутствовать в базе данных.

DEFAULT_MERGE_STYLE#

Стиль слияния для любых новых компонентов.

  • rebase — по умолчанию

  • merge

DEFAULT_SHARED_TM#

Настраивает значение по умолчанию для Использовать совместную память переводов и Вносить вклад в совместную память переводов.

DEFAULT_TRANSLATION_PROPAGATION#

Значение по умолчанию для настройки распространения перевода, по умолчанию установлен в True.

DEFAULT_PULL_MESSAGE#

Настраивает заголовок и сообщение по умолчанию для запросов на извлечение.

ENABLE_AVATARS#

Следует ли включать аватары на основе Gravatar для пользователей. По умолчанию включено.

Аватары извлекаются и кэшируются на сервере, что снижает риск утечки персональной информации и ускоряет взаимодействие с пользователем.

ENABLE_HOOKS#

Включить ли анонимные удалённые обработчики.

ENABLE_HTTPS#

Отправлять ли ссылки на Weblate по протоколу HTTPS или HTTP. Этот параметр влияет на отправленные сообщения электронной почты и сгенерированные абсолютные URL-адреса.

В конфигурации по умолчанию он также используется для нескольких связанных с HTTPS параметров Django — он включает безопасные куки, переключает HSTS или включает перенаправление на HTTPS-адрес.

С перенаправлением HTTPS иногда могут возникать проблемы: если вы используете обратный прокси, который выполняет терминацию SSL, вследствие чего заголовки протокола не передаются Django в корректном виде, то вы можете столкнуться с бесконечным перенаправлением. В таком случае исправьте настройки своего обратного прокси, чтобы он добавлял заголовки X-Forwarded-Proto или Forwarded, или настройте SECURE_PROXY_SSL_HEADER, чтобы Django мог верно определять статус SSL.

ENABLE_SHARING#

Включает/выключает меню Поделиться, с помощью которого пользователи могут делиться прогрессом перевода в социальных сетях.

EXTRA_HTML_HEAD#

Добавлено в версии 4.15.

Вставить дополнительную разметку в заголовок HTML. Может использоваться для подтверждения права собственности на сайт, например:

EXTRA_HTML_HEAD = '<link href="https://fosstodon.org/@weblate" rel="me">'

Предупреждение

Строка не обрабатывается, она вставляется в заголовок HTML как есть.

GET_HELP_URL#

Добавлено в версии 4.5.2.

URL, где можно найти поддержку для вашего экземпляра Weblate.

GITEA_CREDENTIALS#

Добавлено в версии 4.12.

Список учётных данных для серверов Gitea.

GITEA_CREDENTIALS = {
    "try.gitea.io": {
        "username": "weblate",
        "token": "your-api-token",
    },
}

Словарь конфигурации состоит из учётных данных, определённых для каждого сервера API. Структура словаря одинакова практически для всех интеграций с системой управления версиями и описана в Настройка учётных данных контроля версий.

GITLAB_CREDENTIALS#

Добавлено в версии 4.3.

Список учётных данных для серверов GitLab.

GITLAB_CREDENTIALS = {
    "gitlab.com": {
        "username": "weblate",
        "token": "your-api-token",
    },
}

Словарь конфигурации состоит из учётных данных, определённых для каждого сервера API. Структура словаря одинакова практически для всех интеграций с системой управления версиями и описана в Настройка учётных данных контроля версий.

GITHUB_CREDENTIALS#

Добавлено в версии 4.3.

Список учётных данных для серверов GitHub.

GITHUB_CREDENTIALS = {
    "api.github.com": {
        "username": "weblate",
        "token": "your-api-token",
    },
}

Подсказка

Используйте api.github.com в качестве сервера API для https://github.com/.

Словарь конфигурации состоит из учётных данных, определённых для каждого сервера API. Структура словаря одинакова практически для всех интеграций с системой управления версиями и описана в Настройка учётных данных контроля версий.

BITBUCKETSERVER_CREDENTIALS#

Добавлено в версии 4.16.

Список учётных данных для серверов Bitbucket.

BITBUCKETSERVER_CREDENTIALS = {
    "git.self-hosted.com": {
        "username": "weblate",
        "token": "http-access-token",
    },
}

Словарь конфигурации состоит из учётных данных, определённых для каждого сервера API. Структура словаря одинакова практически для всех интеграций с системой управления версиями и описана в Настройка учётных данных контроля версий.

AZURE_DEVOPS_CREDENTIALS#

Добавлено в версии 5.2.

Список учётных данных для серверов Azure DevOps.

AZURE_DEVOPS_CREDENTIALS = {
    "dev.azure.com": {
        "username": "project-name",
        "token": "your-api-token",
        "organization": "organization-name",
    },
}

Словарь конфигурации состоит из учётных данных, определённых для каждого сервера API. Сервер API может отличаться от того, который используется в веб-браузере, например, доступ к API GitHub осуществляется по адресу api.github.com.

Для каждого сервера доступна следующая конфигурация:

username

Имя проекта Azure DevOps. Это не имя репозитория.

organization

Название организации проекта.

workItemIds

Необязательный список идентификаторов рабочих элементов из вашей организации. При его предоставлении к новым запросам на поставку будут прикрепляться эти идентификаторы.

token

Требуется API-токен для пользователя API.

Дополнительные настройки, не описанные здесь, можно найти в Настройка учётных данных контроля версий.

GOOGLE_ANALYTICS_ID#

Идентификатор Google Analytics для включения мониторинга Weblate с помощью Google Analytics.

HIDE_REPO_CREDENTIALS#

Скрыть учётные данные репозитория в веб-интерфейсе. В случае, если в URL репозитория содержится пользователь и пароль, Weblate спрячет их, когда соответствующая информация будет показываться пользователям.

Например, вместо https://user:password@git.example.com/repo.git будет показано просто https://git.example.com/repo.git. Аналогичным образом он пытается очистить и сообщения об ошибках системы контроля версий.

Примечание

Включено по умолчанию.

HIDE_VERSION#

Добавлено в версии 4.3.1.

Прячет информацию о версии от неавторизованных пользователей. Это также перенаправляет все ссылки на документацию последней версии вместо той, которая на самом деле установлена.

Скрытие версии является рекомендованной практикой безопасности в некоторых корпорациях, но не мешает злоумышленнику выяснить версию путём пробного поведения.

Примечание

По умолчанию этот параметр выключен.

INTERLEDGER_PAYMENT_POINTERS#

Добавлено в версии 4.12.1.

Список указателей платежей Interledger (ILP) для веб-монетизации.

Если их указано несколько, распределение доходов достигается путем случайного выбора одного из них.

Пожалуйста, посетите <https://webmonetization.org/> для получения подробной информации.

Подсказка

Значение по умолчанию позволяет пользователям финансировать Weblate.

IP_BEHIND_REVERSE_PROXY#

Указывает, работает ли Weblate за обратным прокси.

Если установлен в ``True`, то Weblate получает IP адрес из заголовка, определённого параметром IP_PROXY_HEADER.

Предупреждение

Убедитесь, что вы и в самом деле используете обратный прокси и что он устанавливает этот заголовок, иначе пользователи смогут подделать IP адрес.

Примечание

По умолчанию этот параметр не включён.

IP_PROXY_HEADER#

Указывает, из какого заголовка Weblate должен получить IP-адрес при включении параметра IP_BEHIND_REVERSE_PROXY.

По умолчанию установлен в HTTP_X_FORWARDED_FOR.

IP_PROXY_OFFSET#

Изменено в версии 5.0.1: Значение по умолчанию изменено с 1 на -1.

Указывает, какая часть параметра IP_PROXY_HEADER используется в качестве IP-адреса клиента.

В зависимости от вашей установки, этот заголовок может состоять из нескольких IP-адресов (например, X-Forwarded-For: client-ip, proxy-a, proxy-b), и здесь вы можете настроить, какой адрес из заголовка используется в качестве IP-адреса клиента.

Предупреждение

Задание этого параметра влияет на безопасность вашей установки, вы должны настроить его на использование только доверенных прокси для определения IP-адреса. Пожалуйста, ознакомьтесь с <https://developer.mozilla.org/ru-RU/docs/Web/HTTP/Headers/X-Forwarded-For#security_and_privacy_concerns> для получения более подробной информации.

По умолчанию -1.

LICENSE_EXTRA#

Дополнительные лицензии для включения в список вариантов лицензий.

Примечание

Описание каждой лицензии должно быть кортежем, состоящим из её краткого наименования, длинного наименования и URL-адреса.

Например:

LICENSE_EXTRA = [
    (
        "AGPL-3.0",
        "GNU Affero General Public License v3.0",
        "https://www.gnu.org/licenses/agpl-3.0-standalone.html",
    ),
]

LICENSE_FILTER#

Изменено в версии 4.3: Присваивание данному параметру пустой строки теперь отключает предупреждение о лицензиях.

Список с фильтром лицензий, которые надлежит показывать. Если задано пустое множество, то предупреждение о лицензиях отключается.

Примечание

Этот фильтр использует сокращённые имена лицензий.

Например:

LICENSE_FILTER = {"AGPL-3.0", "GPL-3.0-or-later"}

Следующее отключает предупреждение о лицензиях:

LICENSE_FILTER = set()

LICENSE_REQUIRED#

Определяет, требуется ли атрибут лицензии в конфигурации компонента.

Примечание

По умолчанию этот параметр выключен.

LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH#

Должна ли длина данного перевода быть ограничена. Ограничение — длина исходной строки × 10 символов.

Подсказка

Установите значение в False для разрешения более длинных переводов (до 10 000 символов) независимо от длины исходной строки.

Примечание

По умолчанию установлен в True.

LOCALIZE_CDN_URL и LOCALIZE_CDN_PATH#

Эти параметры конфигурируют надстройку CDN локализации JavaScript. Параметр LOCALIZE_CDN_URL определяет корневой URL-адрес, по которому доступен CDN локализации, а параметр LOCALIZE_CDN_PATH определяет путь, по которому Weblate должен сохранять сгенерированные файлы, которые затем будут раздаваться с LOCALIZE_CDN_URL.

Подсказка

На Hosted Weblate для этого параметра используется значение https://weblate-cdn.com/.

LOGIN_REQUIRED_URLS#

Список URL-адресов, для посещения которых требуется выполнить вход. (Помимо встроенных в Weblate стандартных правил).

Подсказка

Он позволяет вам защитить паролем всю установку:

LOGIN_REQUIRED_URLS = (r"/(.*)$",)
REST_FRAMEWORK["DEFAULT_PERMISSION_CLASSES"] = [
    "rest_framework.permissions.IsAuthenticated"
]

Подсказка

Также желательно заблокировать доступ к API, как показано в примере выше.

См.также

REQUIRE_LOGIN

LOGIN_REQUIRED_URLS_EXCEPTIONS#

Список исключений для LOGIN_REQUIRED_URLS. Если не указан, пользователям будет разрешён доступ к странице входа.

See the Пример файла настроек for recommended configuration of this setting.

MATOMO_SITE_ID#

Идентификатор (ID) сайта в Matomo (ранее Piwik), который вы хотите использовать для отслеживания Weblate.

Примечание

Эта интеграция не поддерживает Matomo Tag Manager.

См.также

MATOMO_URL

MATOMO_URL#

Полный URL-адрес (включая завершающую косую черту) установки Matomo (бывшего Piwik), которую вы хотите использовать для отслеживания использования Weblate. Для получения более подробной информации обратитесь к <https://matomo.org/>.

Подсказка

Эта интеграция не поддерживает Matomo Tag Manager.

Например:

MATOMO_SITE_ID = 1
MATOMO_URL = "https://example.matomo.cloud/"

См.также

MATOMO_SITE_ID

NEARBY_MESSAGES#

Сколько показывать строк около переводимой в настоящее время строки. Это просто значение по умолчанию, пользователи могут настроить его в своём профиле.

DEFAULT_PAGE_LIMIT#

Добавлено в версии 4.7.

Количество элементов по умолчанию, отображаемых при активной нумерации страниц .

PAGURE_CREDENTIALS#

Добавлено в версии 4.3.2.

Список учётных данных для серверов Pagure.

PAGURE_CREDENTIALS = {
    "pagure.io": {
        "username": "weblate",
        "token": "your-api-token",
    },
}

Словарь конфигурации состоит из учётных данных, определённых для каждого сервера API. Структура словаря одинакова практически для всех интеграций с системой управления версиями и описана в Настройка учётных данных контроля версий.

PRIVACY_URL#

Добавлено в версии 4.8.1.

URL-адрес, по которому ваш экземпляр Weblate показывает свою политику конфиденциальности.

Подсказка

Полезно, если вы размещаете свои юридические документы за пределами Weblate для их встраивания в Weblate, пожалуйста, проверьте Правовые вопросы для получения подробной информации.

Пример:

PRIVACY_URL = "https://weblate.org/terms/"

См.также

LEGAL_URL

PRIVATE_COMMIT_EMAIL_OPT_IN#

Добавлено в версии 4.15.

Определяет, является ли личное электронное письмо о фиксации согласия или отказа (по умолчанию это согласие).

Подсказка

Эта настройка применяется только к тем пользователям, которые не выбрали в явном виде эл. почту для коммита.

PRIVATE_COMMIT_EMAIL_TEMPLATE#

Добавлено в версии 4.15.

Шаблон для создания личного сообщения электронной почты о фиксации для пользователя. По умолчанию "{username}@users.noreply.{site_domain}".

Установите пустую строку, чтобы отключить.

Примечание

Использование другого адреса электронной почты для фиксации разрешено для пользователей, если это не настроено с помощью PRIVATE_COMMIT_EMAIL_OPT_IN. Пользователи могут настроить отправку электронной почты в Профиль.

PROJECT_BACKUP_KEEP_COUNT#

Добавлено в версии 4.14.

Определяет, сколько резервных копий на проект хранится на сервере. По умолчанию 3.

PROJECT_BACKUP_KEEP_DAYS#

Добавлено в версии 4.14.

Определяет, как долго резервные копии проекта будут храниться на сервере. По умолчанию 30 дней.

PROJECT_NAME_RESTRICT_RE#

Добавлено в версии 4.15.

Определяет регулярное выражение для ограничения именования проектов. Все совпадающие имена будут отклонены.

PROJECT_WEB_RESTRICT_HOST#

Добавлено в версии 4.16.2.

Запрет на использование определённых серверов на сайте проекта. При этом проверяется любой поддомен, так что включение example.com заблокирует и test.example.com. Список должен содержать строки только в нижнем регистре, разобранный домен перед проверкой выравнивается по нижнему регистру.

Стандартная конфигурация:

PROJECT_WEB_RESTRICT_HOST = {"localhost"}

PROJECT_WEB_RESTRICT_NUMERIC#

Добавлено в версии 4.16.2.

Запретить использование числового IP-адреса на сайте проекта. По умолчанию включено.

PROJECT_WEB_RESTRICT_RE#

Добавлено в версии 4.15.

Определяет регулярное выражение для ограничения сайтов проекта. Все совпадающие URL-адреса будут отклонены.

RATELIMIT_ATTEMPTS#

Максимальное количество попыток авторизации до применения ограничения частоты запросов.

По умолчанию установлен в 5.

RATELIMIT_WINDOW#

Как долго будет приниматься авторизация после применения ограничения частоты запросов.

Количество секунд, по умолчанию равен 300 (5 минут).

RATELIMIT_LOCKOUT#

Как долго авторизация будет заблокирована после применения ограничения частоты запросов.

Количество секунд, по умолчанию равен 600 (10 минут).

REGISTRATION_ALLOW_BACKENDS#

Добавлено в версии 4.1.

Список методов авторизации (backends), с помощью которых доступна регистрация. Это вводит ограничения только на новые регистрации. Независимо от данного параметра пользователи смогут добавлять и использовать любые разрешённые в параметрах и настроенные методы авторизации.

Рекомендуется держать параметр REGISTRATION_OPEN включённым, но ограничить доступные методы регистрации, иначе пользователи смогут регистрироваться, но Weblate не будет показывать ссылки на регистрацию в пользовательском интерфейсе.

Пример:

REGISTRATION_ALLOW_BACKENDS = ["azuread-oauth2", "azuread-tenant-oauth2"]

Подсказка

Имена бэкэндов совпадают с именами, используемыми в URL-адресах для авторизации.

REGISTRATION_CAPTCHA#

Защищать ли регистрацию новых учётных записей с помощью CAPTCHA. По умолчанию значение включено.

Если он включён, ко всем страницам, на которых пользователь вводит свой адрес электронной почты, добавляется капча:

  • Регистрация новой учётной записи.

  • Восстановление пароля.

  • Добавление в учётную запись адреса электронной почты.

  • Контактная форма для пользователей, не вошедших в систему.

REGISTRATION_EMAIL_MATCH#

Позволяет вам отфильтровать допустимые для регистрации адреса электронной почты.

По умолчанию равен .*, что позволяет зарегистрироваться с любым адресом электронной почты.

Вы можете использовать этот параметр для ограничения регистрации одним доменом электронной почты:

REGISTRATION_EMAIL_MATCH = r"^.*@weblate\.org$"

REGISTRATION_OPEN#

Разрешена ли в данный момент регистрация новых учётных записей. По умолчанию значение включено.

Этот параметр влияет на встроенную авторизацию по адресу электронной почты или через Python Social Auth (при помощи параметра REGISTRATION_ALLOW_BACKENDS вы можете занести определённые бэкэнды в белый список).

Примечание

При использовании сторонних методов авторизации, вроде авторизации через LDAP, этот параметр просто скрывает форму регистрации, но новые пользователи всё равно смогут входить в систему и создавать учётные записи.

REGISTRATION_REBIND#

Добавлено в версии 4.16.

Разрешить повторную привязку бэкэндов проверки подлинности для существующих пользователей. Включите этот параметр при миграции между поставщиками проверки авторизации.

Примечание

По умолчанию отключено, чтобы не разрешать добавление других бэкэндов авторизации к существующей учётной записи. Повторная привязка может привести к компрометации учётной записи при использовании большего количества сторонних бэкэндов авторизации.

REPOSITORY_ALERT_THRESHOLD#

Добавлено в версии 4.0.2.

Порог срабатывания предупреждения для устаревших репозиториев или репозиториев, содержащих слишком много изменений. По умолчанию равен 25.

REQUIRE_LOGIN#

Добавлено в версии 4.1.

Этот параметр включает LOGIN_REQUIRED_URLS и настраивает его так, что будет запрашиваться авторизация пользователя для всех API-вызовов REST.

Примечание

Этот параметр реализован в примере файла настроек. В Docker используйте переменную. WEBLATE_REQUIRE_LOGIN.

SENTRY_DSN#

DSN Sentry для сбора отчетов об ошибках.

SENTRY_ENVIRONMENT#

Настраивает окружение для Sentry. По умолчанию devel.

SENTRY_PROFILES_SAMPLE_RATE#

Настройте частоту выборки для мониторинга производительности. Установите значение 1 для отслеживания всех событий, значение 0 (по умолчанию) отключает отслеживание.

SENTRY_SEND_PII#

Разрешить Sentry собирать определённую персональную информацию. Включено по умолчанию.

SENTRY_TRACES_SAMPLE_RATE#

Настройте частоту выборки для мониторинга профилирования. Установите значение 1 для отслеживания всех событий, значение 0 (по умолчанию) отключает отслеживание.

SIMPLIFY_LANGUAGES#

Использовать простые коды языка для умолчательных комбинаций языка/страны. Например, при переводе ru_RU будет использоваться код языка ru. Обычно это желательное поведение, поскольку для таких умолчательных комбинаций оно упрощает перечисление языков.

Выключите этот параметр, если вы хотите разделять переводы для каждого варианта.

SITE_DOMAIN#

Настраивает домен сайта. Это необходимо для получения правильных абсолютных ссылок во многих местах (например, в письмах активации, в уведомлениях или в RSS-каналах).

Если Weblate работает на нестандартном порту, укажите его здесь.

Примеры:

# Production site with domain name
SITE_DOMAIN = "weblate.example.com"

# Local development with IP address and port
SITE_DOMAIN = "127.0.0.1:8000"

Примечание

Этот параметр должен содержать только доменное имя. Для настройки протокола (включения и принудительного включения HTTPS) используйте параметр ENABLE_HTTPS, а для изменения URL-адреса — параметр URL_PREFIX.

Подсказка

В контейнере Docker домен сайта настраивается через переменную окружения WEBLATE_ALLOWED_HOSTS.

SITE_TITLE#

Заголовок сайта, который будет использоваться как на самом сайте, так и указываться в электронных письмах.

SPECIAL_CHARS#

Дополнительные символы для включения в визуальную клавиатуру, смотрите раздел Визуальная клавиатура.

Значение по умолчанию:

SPECIAL_CHARS = ("\t", "\n", "\u00a0", "…")

SINGLE_PROJECT#

Перенаправляет пользователей непосредственно в проект или компонент вместо отображения панели управления. Вы можете установить значение True, в этом случае он будет работать тогда, когда в Weblate и в самом деле есть только один проект. Или же можно задать ссылку проекта, тогда пользователь будет безоговорочно перенаправлен в этот проект.

Пример:

SINGLE_PROJECT = "test"

SSH_EXTRA_ARGS#

Добавлено в версии 4.9.

Позволяет добавлять пользовательские параметры, когда Weblate вызывает SSH. Это полезно при подключении к серверам, использующим устаревшее шифрование или другие нестандартные функции.

Например, когда SSH-соединение в Weblate не работает с сообщением Unable to negotiate with legacyhost: no matching key exchange method found. Their offer: diffie-hellman-group1-sha1, вы можете включить его, используя:

SSH_EXTRA_ARGS = "-oKexAlgorithms=+diffie-hellman-group1-sha1"

Подсказка

Строка оценивается оболочкой, поэтому все пробельные и специальные символы должны быть заключены в кавычки.

STATUS_URL#

URL-адрес, по которому ваш экземпляр Weblate сообщает о своем статусе.

SUGGESTION_CLEANUP_DAYS#

Автоматическое удаление предложения через заданное количество дней. По умолчанию установлен в ``None`, что означает отсутствие удалений.

SUPPORT_STATUS_CHECK#

Добавлено в версии 5.5.

Disables semiannual support status check and redirecting superusers upon login to the donation page in case there is no active support subscription.

Подсказка

Improve your Weblate experience by purchasing a support subscription and boosting Weblate progress instead of turning this off.

UNUSED_ALERT_DAYS#

Добавлено в версии 4.17.

Настраивает, когда срабатывает предупреждение «Компонент кажется неиспользуемым».

По умолчанию установлено значение 365 дней, для отключения установите значение 0.

UPDATE_LANGUAGES#

Добавлено в версии 4.3.2.

Определяет, должна ли база данных языков обновляться во время общей миграции базы данных. По умолчанию включено. Этот параметр никак не влияет на выполнение setuplang.

Предупреждение

При этом отображение языков может стать непоследовательным. Определения языков Weblate со временем расширяются, и он не будет отображать код языка для определённых языков.

URL_PREFIX#

Этот параметр позволяет вам запускать Weblate по какому-либо пути (в противном случае он считает, что запущен из корня веб-сервера).

Примечание

Для использования этого параметра вам также нужно настроить ваш сервер на срезание этого префикса. Например, при использовании WSGI это можно сделать, установив псевдоним WSGIScriptAlias.

Подсказка

Префикс должен начинаться с символа /.

Пример:

URL_PREFIX = "/translations"

Примечание

Этот параметр не работает со встроенным сервером Django, чтобы он реагировал на этот префикс, вам придётся подправить urls.py.

VCS_API_DELAY#

Добавлено в версии 4.15.1.

Настройка минимальной задержки в секундах между сторонними вызовами API в Запрос на извлечение в GitHub, Запросы на слияние в GitLab, Запрос на извлечение в Gitea, Запросы на слияние в Pagure, и Запросы на извлечение Azure DevOps.

Эта скорость ограничивает вызовы API из Weblate к этим сервисам, чтобы не перегружать их.

Если вас ограничивает дополнительный ограничитель скорости на GitHub, его увеличение может помочь.

Значение по умолчанию — 10.

VCS_BACKENDS#

Настройка доступных систем контроля версий.

Примечание

Weblate пытается использовать все поддерживаемые системы, для которых у вас есть инструменты.

Подсказка

При помощи этого параметра вы можете ограничить их выбор или добавить пользовательские системы контроля версий.

VCS_BACKENDS = ("weblate.vcs.git.GitRepository",)

VCS_CLONE_DEPTH#

Настраивает, насколько глубоким должно быть клонирование репозиториев сервисом Weblate.

Примечание

В настоящее время это поддерживается только в Git. По умолчанию Weblate делает поверхностные клоны репозиториев, чтобы сделать клонирование быстрее и сэкономить место на диске. В зависимости от использования (например, при использовании пользовательских Надстройки), вы можете захотеть увеличить глубину клонирования или полностью отключить поверхностное клонирование, что можно сделать, установив этот параметр в значение 0.

Подсказка

В случае, если при отправке коммитов из Weblate вы получили ошибку fatal: protocol error: expected old/new/ref, got 'shallow <commit hash>', полностью отключите поверхностные клоны в параметре:

VCS_CLONE_DEPTH = 0

WEBLATE_ADDONS#

Список доступных для использования надстроек. Чтобы использовать надстройку, нужно также включить её для конкретного компонента перевода. По умолчанию в список включены все встроенные надстройки. Если вы будете расширять список, то, вероятно, вы захотите оставить эти дополнения включёнными, например:

WEBLATE_ADDONS = (
    # Built-in add-ons
    "weblate.addons.gettext.GenerateMoAddon",
    "weblate.addons.gettext.UpdateLinguasAddon",
    "weblate.addons.gettext.UpdateConfigureAddon",
    "weblate.addons.gettext.MsgmergeAddon",
    "weblate.addons.gettext.GettextCustomizeAddon",
    "weblate.addons.gettext.GettextAuthorComments",
    "weblate.addons.cleanup.CleanupAddon",
    "weblate.addons.consistency.LangaugeConsistencyAddon",
    "weblate.addons.discovery.DiscoveryAddon",
    "weblate.addons.flags.SourceEditAddon",
    "weblate.addons.flags.TargetEditAddon",
    "weblate.addons.flags.SameEditAddon",
    "weblate.addons.flags.BulkEditAddon",
    "weblate.addons.generate.GenerateFileAddon",
    "weblate.addons.json.JSONCustomizeAddon",
    "weblate.addons.xml.XMLCustomizeAddon",
    "weblate.addons.properties.PropertiesSortAddon",
    "weblate.addons.git.GitSquashAddon",
    "weblate.addons.removal.RemoveComments",
    "weblate.addons.removal.RemoveSuggestions",
    "weblate.addons.resx.ResxUpdateAddon",
    "weblate.addons.autotranslate.AutoTranslateAddon",
    "weblate.addons.yaml.YAMLCustomizeAddon",
    "weblate.addons.cdn.CDNJSAddon",
    # Add-on you want to include
    "weblate.addons.example.ExampleAddon",
)

Примечание

Удаление дополнения из этого списка не уберёт его из компонентов. В этом случае Weblate завершится крахом. Пожалуйста, уберите дополнение из всех компонентов прежде чем удалять его из данного списка.

WEBLATE_EXPORTERS#

Добавлено в версии 4.2.

Список доступных экспортеров, предлагающих скачивание переводов или словарей в различных форматах файлов.

WEBLATE_FORMATS#

Список доступных для использования форматов файлов.

Примечание

В списке по умолчанию уже есть распространённые форматы.

WEBLATE_MACHINERY#

Добавлено в версии 4.13.

Список доступных для использования машинных сервисов.

WEBLATE_GPG_IDENTITY#

Удостоверение, используемое Weblate для подписи коммитов Git, например:

WEBLATE_GPG_IDENTITY = "Weblate <weblate@example.com>"

В GPG’шной связке ключей Weblate ищет соответствующий ключ (файл home/.gnupg в каталоге DATA_DIR). Если ключ не найден, он генерируется, подробнее смотрите в разделе Подписание коммитов Git с помощью GnuPG.

WEBSITE_REQUIRED#

Определяет, нужно ли указывать Веб-сайт проекта при создании проекта. Включено по умолчанию, так как это подходит для установок общедоступного сервера.

Настройка учётных данных контроля версий#

Подсказка

В этом разделе описаны такие переменные учётных данных VCS, как GITHUB_CREDENTIALS, GITLAB_CREDENTIALS, GITEA_CREDENTIALS, PAGURE_CREDENTIALS, BITBUCKETSERVER_CREDENTIALS.

Словарь конфигурации состоит из учётных данных, определённых для каждого сервера API. Сервер API может отличаться от того, который используется в веб-браузере, например, доступ к API GitHub осуществляется по адресу api.github.com.

Для каждого сервера доступна следующая конфигурация:

username

Требуется пользователь API.

token

Требуется API-токен для пользователя API.

scheme

Добавлено в версии 4.18.

Переопределение схемы. Weblate пытается разобрать схему из URL репозитория и возвращается к https. Если вы используете API-сервер внутри компании, то вместо него можно использовать http, но при этом следует учитывать требования безопасности.

Подсказка

В контейнере Docker учетные данные могут быть настроены с помощью переменных окружения, см. Учётные данные сайтов хостинга кода.