Configuration

All settings are stored in settings.py (as usual for Django).

Note

After changing any of these settings, you need to restart Weblate. In case it is run as mod_wsgi, you need to restart Apache to reload the configuration.

See also

Please also check Django’s documentation for parameters which configure Django itself.

AKISMET_API_KEY

Weblate can use Akismet to check incoming anonymous suggestions for spam. Visit akismet.com to purchase an API key and associate it with a site.

ANONYMOUS_USER_NAME

User name of user for definining privileges of not logged in user.

See also

Access control

AUTH_LOCK_ATTEMPTS

New in version 2.14.

Maximum number of failed authentication attempts before rate limiting is applied.

This is currently applied in the following locations:

  • On login, the acccount password is reset. User will not be able to log in after that using password until he asks for password reset.
  • On password reset, the reset mails are no longer sent. This avoids spamming user with too many password reset attempts.

Defaults to 10.

See also

Rate limiting,

AUTH_MAX_ATTEMPTS

New in version 2.14.

Maximum number of authentication attempts before rate limiting applies.

Defaults to 5.

AUTH_CHECK_WINDOW

New in version 2.14.

Length of authentication window for rate limiting in seconds.

Defaults to 300 (5 minutes).

AUTH_LOCKOUT_TIME

New in version 2.14.

Length of authentication lockout window after rate limit is applied.

Defaults to 600 (10 minutes).

AUTH_TOKEN_VALID

New in version 2.14.

Validity of token in activation and password reset mails in seconds.

Defaults to 3600 (1 hour).

AUTH_PASSWORD_DAYS

New in version 2.15.

Define (in days) how long in past Weblate should reject reusing same password.

Note

Password changes done prior to Weblate 2.15 will not be accounted for this policy, it is valid only

Defaults to 180 days.

AUTO_LOCK

Deprecated since version 2.18.

Enables automatic locking of translation when somebody is working on it.

AUTO_LOCK_TIME

Deprecated since version 2.18.

Time in seconds for how long the automatic lock for translation will be active. Defaults to 60 seconds.

AUTOFIX_LIST

List of automatic fixups to apply when saving the message.

You need to provide a fully-qualified path to the Python class implementing the autofixer interface.

Available fixes:

weblate.trans.autofixes.whitespace.SameBookendingWhitespace
Fixes up whitespace in beginning and end of the string to match source.
weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis
Replaces trailing dots with ellipsis if source string has it.
weblate.trans.autofixes.chars.RemoveZeroSpace
Removes zero width space char if source does not contain it.
weblate.trans.autofixes.chars.RemoveControlCharS
Removes control characters if source does not contain it.

For example you can enable only few of them:

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

BACKGROUND_HOOKS

Whether to run hooks in background. This is generally recommended unless you are debugging.

BASE_DIR

Base directory where Weblate sources are located. This is used to derive several other paths by defalt:

Default value: Toplevel directory of Weblate sources.

CHECK_LIST

List of quality checks to perform on translation.

You need to provide afully-qualified path to the Python class implementing the check interface.

Some of the checks are not useful for all projects, so you are welcome to adjust the list list of checks to be performed on your installation.

For example you can enable only few of them:

CHECK_LIST = (
    'weblate.checks.same.SameCheck',
    'weblate.checks.chars.BeginNewlineCheck',
    'weblate.checks.chars.EndNewlineCheck',
    'weblate.checks.chars.BeginSpaceCheck',
    'weblate.checks.chars.EndSpaceCheck',
    'weblate.checks.chars.EndStopCheck',
    'weblate.checks.chars.EndColonCheck',
    'weblate.checks.chars.EndQuestionCheck',
    'weblate.checks.chars.EndExclamationCheck',
    'weblate.checks.chars.EndEllipsisCheck',
    'weblate.checks.chars.EndSemicolonCheck',
    'weblate.checks.chars.MaxLengthCheck',
    'weblate.checks.format.PythonFormatCheck',
    'weblate.checks.format.PythonBraceFormatCheck',
    'weblate.checks.format.PHPFormatCheck',
    'weblate.checks.format.CFormatCheck',
    'weblate.checks.format.PerlFormatCheck',
    'weblate.checks.format.JavascriptFormatCheck',
    'weblate.checks.consistency.SamePluralsCheck',
    'weblate.checks.consistency.PluralsCheck',
    'weblate.checks.consistency.ConsistencyCheck',
    'weblate.checks.consistency.TranslatedCheck',
    'weblate.checks.chars.NewlineCountingCheck',
    'weblate.checks.markup.BBCodeCheck',
    'weblate.checks.chars.ZeroWidthSpaceCheck',
    'weblate.checks.markup.XMLTagsCheck',
    'weblate.checks.source.OptionalPluralCheck',
    'weblate.checks.source.EllipsisCheck',
    'weblate.checks.source.MultipleFailingCheck',
)

Note

Once you change this setting the existing checks will still be stored in the database, only newly changed translations will be affected by the change. To apply the change to the stored translations, you need to run updatechecks.

COMMIT_PENDING_HOURS

New in version 2.10.

Default interval for commiting pending changes using commit_pending.

DATA_DIR

New in version 2.1: In previous versions the directories were configured separately as GIT_ROOT and WHOOSH_INDEX.

Directory where Weblate stores all data. This consists of VCS repositories, fulltext index and various configuration files for external tools.

The following subdirectories usually exist:

home
Home directory used for invoking scripts.
ssh
SSH keys and configuration.
static
Default location for Django static files, specified by STATIC_ROOT.
media
Default location for Django media files, specified by MEDIA_ROOT.
memory
Translation memory data uwing Whoosh engine (see Translation Memory).
vcs
Version control repositories.
whoosh
Fulltext search index using Whoosh engine.

Note

This directory has to be writable by Weblate. If you are running Weblate as uwsgi this means that it should be writable by the www-data user.

The easiest way to achieve is to make the user own the directory:

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

Defaults to $BASE_DIR/data.

See also

BASE_DIR

DEFAULT_COMMITER_EMAIL

New in version 2.4.

Default committer email when creating translation component (see Component configuration), defaults to noreply@weblate.org.

DEFAULT_COMMITER_NAME

New in version 2.4.

Default committer name when creating translation component (see Component configuration), defaults to Weblate.

DEFAULT_CUSTOM_ACL

New in version 3.0.

Whether newly created projects should default to Custom ACL. Use if you are going to manage ACL manually and do not want to rely on Weblate internal management.

DEFAULT_TRANSLATION_PROPAGATION

New in version 2.5.

Default setting for translation propagation (see Component configuration), defaults to True.

ENABLE_AVATARS

Whether to enable Gravatar based avatars for users. By default this is enabled.

The avatars are fetched and cached on the server, so there is no risk in leaking private information or slowing down the user experiences with enabling this.

ENABLE_HOOKS

Whether to enable anonymous remote hooks.

ENABLE_HTTPS

Whether to send links to Weblate as https or http. This setting affects sent mails and generated absolute URLs.

ENABLE_SHARING

Whether to show links to share translation progress on social networks.

GIT_ROOT

Deprecated since version 2.1: This setting is no longer used, use DATA_DIR instead.

Path where Weblate will store the cloned VCS repositories. Defaults to repos subdirectory.

GITHUB_USERNAME

GitHub username that will be used to send pull requests for translation updates.

GOOGLE_ANALYTICS_ID

Google Analytics ID to enable monitoring of Weblate using Google Analytics.

HIDE_REPO_CREDENTIALS

Hide repository credentials in the web interface. In case you have repository URL with user and password, Weblate will hide it when showing it to the users.

For example instead of https://user:password@git.example.com/repo.git it will show just https://git.example.com/repo.git.

IP_BEHIND_REVERSE_PROXY

New in version 2.14.

Indicates whether Weblate is running behind a reverse proxy.

If set to True, Weblate gets IP address from header defined by IP_BEHIND_REVERSE_PROXY. Ensure that you are actually using reverse proxy and that it sets this header, otherwise users will be able to fake the IP address.

Defaults to False.

IP_PROXY_HEADER

New in version 2.14.

Indicates from which header Weblate should obtain the IP address when IP_BEHIND_REVERSE_PROXY is enabled.

Defaults to HTTP_X_FORWARDED_FOR.

IP_PROXY_OFFSET

New in version 2.14.

Indicates which part of IP_BEHIND_REVERSE_PROXY is used as client IP address.

Depending on your setup, this header might consist of several IP addresses, (for example X-Forwarded-For: a, b, client-ip) and you can configure here which address from the header is client IP address.

Defaults to 0.

LAZY_COMMITS

Deprecated since version 2.20: This setting can no longer be configured and is enabled permanently.

Delay creating VCS commits until necessary. This heavily reduces number of commits generated by Weblate at expense of temporarily not being able to merge some changes as they are not yet committed.

See also

Lazy commits

LOCK_TIME

Deprecated since version 2.18.

Time in seconds for how long the translation will be locked for single translator when locked manually.

LOGIN_REQUIRED_URLS

List of URLs which require login (besides standard rules built into Weblate). This allows you to password protect whole installation using:

LOGIN_REQUIRED_URLS = (
    r'/(.*)$',
)

LOGIN_REQUIRED_URLS_EXCEPTIONS

List of exceptions for LOGIN_REQUIRED_URLS. If you don’t specify this list, the default value will be used, which allows users to access the login page.

Some of exceptions you might want to include:

LOGIN_REQUIRED_URLS_EXCEPTIONS = (
    r'/accounts/(.*)$', # Required for login
    r'/static/(.*)$',   # Required for development mode
    r'/widgets/(.*)$',  # Allowing public access to widgets
    r'/data/(.*)$',     # Allowing public access to data exports
    r'/hooks/(.*)$',    # Allowing public access to notification hooks
    r'/api/(.*)$',      # Allowing access to API
    r'/js/i18n/$',      # Javascript localization
)

MT_SERVICES

Changed in version 3.0: The setting was renamed from MACHINE_TRANSLATION_SERVICES to MT_SERVICES to be consistent with other machine translation settings.

List of enabled machine translation services to use.

Note

Many of services need additional configuration like API keys, please check their documentation for more details.

MT_SERVICES = (
    'weblate.machinery.apertium.ApertiumAPYTranslation',
    'weblate.machinery.deepl.DeepLTranslation',
    'weblate.machinery.glosbe.GlosbeTranslation',
    'weblate.machinery.google.GoogleTranslation',
    'weblate.machinery.microsoft.MicrosoftCognitiveTranslation',
    'weblate.machinery.mymemory.MyMemoryTranslation',
    'weblate.machinery.tmserver.AmagamaTranslation',
    'weblate.machinery.tmserver.TMServerTranslation',
    'weblate.machinery.yandex.YandexTranslation',
    'weblate.machinery.weblatetm.WeblateTranslation',
    'weblate.machinery.saptranslationhub.SAPTranslationHub',
    'weblate.memory.machine.WeblateMemory',
)

MT_APERTIUM_APY

URL of the Apertium APy server, see http://wiki.apertium.org/wiki/Apertium-apy

MT_AWS_ACCESS_KEY_ID

Access key ID for Amazon Translate.

MT_AWS_SECRET_ACCESS_KEY

API secret key for Amazon Translate.

MT_AWS_REGION

Region name to use for Amazon Translate.

MT_DEEPL_KEY

API key for DeepL API, you can register at https://www.deepl.com/pro.html.

MT_GOOGLE_KEY

API key for Google Translate API, you can register at https://cloud.google.com/translate/docs

MT_MICROSOFT_ID

Client ID for Microsoft Translator service.

MT_MICROSOFT_SECRET

Client secret for Microsoft Translator service.

MT_MICROSOFT_COGNITIVE_KEY

Client key for Microsoft Cognitive Services Translator API.

MT_MYMEMORY_EMAIL

MyMemory identification email, you can get 1000 requests per day with this.

MT_MYMEMORY_KEY

MyMemory access key for private translation memory, use together with MT_MYMEMORY_USER.

MT_MYMEMORY_USER

MyMemory user id for private translation memory, use together with MT_MYMEMORY_KEY.

MT_TMSERVER

URL where tmserver is running.

MT_YANDEX_KEY

API key for Yandex Translate API, you can register at https://tech.yandex.com/translate/

MT_SAP_BASE_URL

API URL to the SAP Translation Hub service.

MT_SAP_SANDBOX_APIKEY

API key for sandbox API usage

MT_SAP_USERNAME

Your SAP username

MT_SAP_PASSWORD

Your SAP password

MT_SAP_USE_MT

Should the machine translation service also be used? (in addition to the term database). Possible values: True / False

NEARBY_MESSAGES

How many messages around current one to show during translating.

OFFLOAD_INDEXING

Offload updating of fulltext index to separate process. This heavily improves responsiveness of online operation on expense of slightly outdated index, which might still point to older content.

While enabling this, don’t forget scheduling runs of update_index in cron or similar tool.

This is the recommended setup for production use.

See also

Fulltext search

PIWIK_SITE_ID

ID of a site in Matomo you want to track.

See also

PIWIK_URL

PIWIK_URL

URL of a Matomo installation you want to use to track Weblate users. For more information about Matomo see <https://matomo.org/>.

See also

PIWIK_SITE_ID

REGISTRATION_CAPTCHA

A boolean (either True or False) indicating whether registration of new accounts is protected by captcha. This setting is optional, and a default of True will be assumed if it is not supplied.

If enabled the captcha is added to all pages where users enter email address:

  • New account registration.
  • Password recovery.
  • Adding email to an account.
  • Contact form for users who are not logged in.

REGISTRATION_EMAIL_MATCH

New in version 2.17.

Allows you to filter email addresses which can register.

Defaults to .* which allows any address to register.

You can use it to restrict registration to a single email domain:

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

REGISTRATION_OPEN

A boolean (either True or False) indicating whether registration of new accounts is currently permitted. This setting is optional, and a default of True will be assumed if it is not supplied.

SIMPLIFY_LANGUAGES

Use simple language codes for default language/country combinations. For example fr_FR translation will use fr language code. This is usually desired behavior as it simplifies listing of the languages for these default combinations.

Disable this if you are having different translations for both variants.

SITE_TITLE

Site title to be used in website and emails as well.

SPECIAL_CHARS

Additional chars to show in the visual keyboard, see Visual keyboard.

The default value is:

SPECIAL_CHARS = ('\t', '\n', '…')

STATUS_URL

URL where your Weblate instance reports it’s status.

TTF_PATH

Path to Droid fonts used for widgets and charts.

Defaults to $BASE_DIR/weblate/ttf.

See also

BASE_DIR

URL_PREFIX

This settings allows you to run Weblate under some path (otherwise it relies on being executed from webserver root). To use this setting, you also need to configure your server to strip this prefix. For example with WSGI, this can be achieved by setting WSGIScriptAlias.

Note

This setting does not work with Django’s builtin server, you would have to adjust urls.py to contain this prefix.

WEBLATE_ADDONS

List of addons available for use. To use them, they have to be enabled for given translation component.

See also

Addons

WEBLATE_FORMATS

New in version 3.0.

List of file formats available for use, you can usually keep this on default value.

WHOOSH_INDEX

Deprecated since version 2.1: This setting is no longer used, use DATA_DIR instead.

Directory where Whoosh fulltext indices will be stored. Defaults to whoosh-index subdirectory.