Konfiguration

Alle Einstellungen werden in settings.py gespeichert (wie bei Django üblich).

Bemerkung

Nachdem Sie eine dieser Einstellungen geändert haben, müssen Sie Weblate neu starten - sowohl den WSGI- als auch den Celery-Prozess.

Wenn es als mod_wsgi ausgeführt wird, müssen Sie Apache neu starten, um die Konfiguration neu zu laden.

Siehe auch

Bitte lesen Sie auch Djangos Dokumentation für Parameter zur Konfiguration von Django selbst.

AKISMET_API_KEY

Weblate kann Akismet verwenden, um eingehende anonyme Vorschläge auf Spam zu überprüfen. Besuchen Sie akismet.com, um einen API-Schlüssel zu erwerben und ihn mit einer Website zu verknüpfen.

ANONYMOUS_USER_NAME

Benutzername von Benutzern, die nicht angemeldet sind.

Siehe auch

Zugriffssteuerung

AUDITLOG_EXPIRY

Neu in Version 3.6.

Wie viele Tage Weblate Audit-Protokolle aufbewahren soll, die Informationen über Kontoaktivitäten enthalten.

Der Standardwert ist 180 Tage.

AUTH_LOCK_ATTEMPTS

Neu in Version 2.14.

Maximale Anzahl der fehlgeschlagenen Authentifizierungsversuche, bevor die Ratenbegrenzung angewendet wird.

Dies wird derzeit an den folgenden Standorten angewandt:

  • Anmelden. Löscht das Kennwort des Kontos und verhindert, dass sich der Benutzer anmelden kann, ohne ein neues Kennwort anzufordern.

  • Passwort zurücksetzen. Verhindert, dass neue E-Mails gesendet werden, damit die Benutzer nicht mit zu vielen Versuchen, ihr Passwort zurückzusetzen, belästigt werden.

Der Standardwert ist 10.

Siehe auch

Rate limiting

AUTO_UPDATE

Neu in Version 3.2.

Geändert in Version 3.11: Die ursprüngliche Option „Ein/Aus“ wurde geändert, um zu unterscheiden, welche Zeichenfolgen akzeptiert werden.

Aktualisiert täglich alle Repositories.

Hinweis

Nützlich, wenn Sie Benachrichtigungs-Hooks nicht verwenden, um Weblate-Repositories automatisch zu aktualisieren.

Bemerkung

Aus Gründen der Abwärtskompatibilität gibt es neben der Auswahl der Zeichenkette auch Ein/Aus-Optionen.

Die Optionen sind:

„none“

Keine täglichen Aktualisierungen.

„remote“` auch ` ` False

Aktualisieren Sie nur Remotes.

„full“` auch ` ` True

Aktualisieren Sie Remotes und führen Sie Arbeitskopien zusammen.

Bemerkung

Dies setzt voraus, dass Background tasks using Celery funktioniert, und wird nach einem Neustart wirksam.

AVATAR_URL_PREFIX

Präfix für den Aufbau von Avatar-URLs als: „${AVATAR_URL_PREFIX}/avatar/${MAIL_HASH}?${PARAMS}“. Die folgenden Dienste sind dafür bekannt, dass sie funktionieren:

Gravatar (Standard), wie unter https://gravatar.com/

AVATAR_URL_PREFIX = ‚https://www.gravatar.com/‘

Libravatar, as per https://www.libravatar.org/

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

AUTH_TOKEN_VALID

Neu in Version 2.14.

How long the authentication token and temporary password from password reset e-mails is valid for. Set in number of seconds, defaulting to 172800 (2 days).

AUTH_PASSWORD_DAYS

Neu in Version 2.15.

How many days using the same password should be allowed.

Bemerkung

Password changes made prior to Weblate 2.15 will not be accounted for in this policy.

Der Standardwert ist 180 Tage.

AUTOFIX_LIST

List of automatic fixes to apply when saving a string.

Bemerkung

Provide a fully-qualified path to the Python class that implementing the autofixer interface.

Available fixes:

weblate.trans.autofixes.whitespace.SameBookendingWhitespace

Matches whitespace at the start and end of the string to the source.

weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis

Replaces trailing dots (…) if the source string has a corresponding ellipsis (…).

weblate.trans.autofixes.chars.RemoveZeroSpace

Removes zero-width space characters if the source does not contain any.

weblate.trans.autofixes.chars.RemoveControlChars

Removes control characters if the source does not contain any.

weblate.trans.autofixes.html.BleachHTML

Removes unsafe HTML markup from strings flagged as safe-html (see Unsicheres HTML).

You can select which ones to use:

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

BACKGROUND_TASKS

Neu in Version 4.5.2.

Defines how often lengthy maintenance tasks should be triggered for a component.

Right now this controls:

Mögliche Auswahlmöglichkeiten:

  • monthly (this is the default)

  • weekly

  • daily

  • never

Bemerkung

Increasing the frequency is not recommended when Weblate contains thousands of components.

BASIC_LANGUAGES

Neu in Version 4.4.

Liste der Sprachen, die dem Benutzer zum Starten einer neuen Übersetzung angeboten wird. Wenn nicht angegeben, wird die integrierte Liste mit allen häufig verwendeten Sprachen verwendet, jedoch ohne länderspezifische Varianten.

This only limits non privileged users to add unwanted languages. The project admins are still presented with full selection of languages defined in Weblate.

Bemerkung

This does not define new languages for Weblate, it only filters existing ones in the database.

Beispiel:

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

BORG_EXTRA_ARGS

Neu in Version 4.9.

You can pass additional arguments to borg create when built-in backups are triggered.

Beispiel:

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

CSP_SCRIPT_SRC, CSP_IMG_SRC, CSP_CONNECT_SRC, CSP_STYLE_SRC, CSP_FONT_SRC

Customize Content-Security-Policy header for Weblate. The header is automatically generated based on enabled integrations with third-party services (Matomo, Google Analytics, Sentry, …).

All these default to empty list.

Beispiel:

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

CHECK_LIST

List of quality checks to perform on a translation.

Bemerkung

Provide a fully-qualified path to the Python class implementing the check interface.

Adjust the list of checks to include ones relevant to you.

All built-in Qualitätsprüfungen are turned on by default, from where you can change these settings. By default they are commented out in Sample configuration so that default values are used. New checks then carried out for each new Weblate version.

You can turn off all checks:

CHECK_LIST = ()

You can turn on only a few:

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

Bemerkung

Changing this setting only affects newly changed translations, existing checks will still be stored in the database. To also apply changes to the stored translations, run updatechecks.

COMMENT_CLEANUP_DAYS

Neu in Version 3.6.

Delete comments after a given number of days. Defaults to None, meaning no deletion at all.

COMMIT_PENDING_HOURS

Neu in Version 2.10.

Number of hours between committing pending changes by way of the background task.

CONTACT_FORM

Neu in Version 4.6.

Legt fest, wie E-Mails aus dem Kontaktformular gesendet werden. Wählen Sie eine Konfiguration, die Ihrer Mail-Server-Konfiguration entspricht.

"reply-to"

Der Absender wird in Reply-To verwendet, dies ist das Standardverhalten.

"from"

Der Absender wird in From verwendet. Ihr Mail-Server muss den Versand solcher E-Mails erlauben.

DATA_DIR

The folder Weblate stores all data in. It contains links to VCS repositories, a 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 static Django files, specified by STATIC_ROOT. See Serving static files.

Der Docker-Container verwendet dafür ein eigenes Volume, siehe Docker-Container-Volumes.

media

Standardspeicherort für Django-Mediendateien, angegeben durch MEDIA_ROOT. Enthält hochgeladene Bildschirmfotos, siehe Bildschirmfotos.

vcs

Versionsverwaltung-Repositorys für Übersetzungen.

backups

Daily backup data, please check Gedumpte Daten für Backups for details.

celery

Celery scheduler data, see Background tasks using Celery.

fonts:

User-uploaded fonts, see Schriftarten verwalten.

Bemerkung

This directory has to be writable by Weblate. Running it as uWSGI means the www-data user should have write access to it.

The easiest way to achieve this is to make the user the owner of the directory:

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

Defaults to /home/weblate/data, but it is expected to be configured.

DATABASE_BACKUP

Neu in Version 3.1.

Whether the database backups should be stored as plain text, compressed or skipped. The authorized values are:

  • "plain"

  • "compressed"

  • „none“

DEFAULT_ACCESS_CONTROL

Neu in Version 3.3.

The default access control setting for new projects:

0

Public

1

Protected

100

Private

200

Custom

Use Custom if you are managing ACL manually, which means not relying on the internal Weblate management.

DEFAULT_AUTO_WATCH

Neu in Version 4.5.

Configures whether Automatically watch projects on contribution should be turned on for new users. Defaults to True.

Siehe auch

Benachrichtigungen

DEFAULT_RESTRICTED_COMPONENT

Neu in Version 4.1.

The default value for component restriction.

DEFAULT_ADD_MESSAGE, DEFAULT_ADDON_MESSAGE, DEFAULT_COMMIT_MESSAGE, DEFAULT_DELETE_MESSAGE, DEFAULT_MERGE_MESSAGE

Default commit messages for different operations, please check Component configuration for details.

DEFAULT_ADDONS

Default add-ons to install on every created component.

Bemerkung

This setting affects only newly created components.

Example:

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",
    },
}

DEFAULT_COMMITER_EMAIL

Neu in Version 2.4.

Committer e-mail address defaulting to noreply@weblate.org.

DEFAULT_COMMITER_NAME

Neu in Version 2.4.

Committer name defaulting to Weblate.

DEFAULT_LANGUAGE

Neu in Version 4.3.2.

Default source language to use for example in Ausgangssprache.

Defaults to en. The matching language object needs to exist in the database.

DEFAULT_MERGE_STYLE

Neu in Version 3.4.

Merge style for any new components.

  • rebase - default

  • merge

DEFAULT_SHARED_TM

Neu in Version 3.2.

Configures default value of Gemeinsamen Übersetzungsspeicher verwenden and Zu einem gemeinsamen Übersetzungsspeicher beitragen.

DEFAULT_TRANSLATION_PROPAGATION

Neu in Version 2.5.

Default setting for translation propagation, defaults to True.

DEFAULT_PULL_MESSAGE

Configures the default title and message for pull requests.

ENABLE_AVATARS

Whether to turn on Gravatar-based avatars for users. By default this is on.

Avatars are fetched and cached on the server, lowering the risk of leaking private info, speeding up the user experience.

ENABLE_HOOKS

Whether to enable anonymous remote hooks.

ENABLE_HTTPS

Whether to send links to Weblate as HTTPS or HTTP. This setting affects sent e-mails and generated absolute URLs.

In the default configuration this is also used for several Django settings related to HTTPS - it enables secure cookies, toggles HSTS or enables redirection to HTTPS URL.

The HTTPS redirection might be problematic in some cases and you might hit issue with infinite redirection in case you are using a reverse proxy doing SSL termination which does not correctly pass protocol headers to Django. Please tweak your reverse proxy configuration to emit X-Forwarded-Proto or Forwarded headers or configure SECURE_PROXY_SSL_HEADER to let Django correctly detect the SSL status.

ENABLE_SHARING

Turn on/off the Share menu so users can share translation progress on social networks.

GET_HELP_URL

Neu in Version 4.5.2.

URL where support for your Weblate instance can be found.

GITEA_CREDENTIALS

Neu in Version 4.12.

List for credentials for Gitea servers.

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

GITEA_USERNAME

Veraltet ab Version 4.14.2: This configuration is insecure, it is recommended to switch to GITEA_CREDENTIALS.

Neu in Version 4.12.

Gitea username used to send pull requests for translation updates.

GITEA_TOKEN

Veraltet ab Version 4.14.2: This configuration is insecure, it is recommended to switch to GITEA_CREDENTIALS.

Neu in Version 4.12.

Gitea personal access token used to make API calls to send pull requests for translation updates.

GITLAB_CREDENTIALS

Neu in Version 4.3.

List for credentials for GitLab servers.

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

GITLAB_USERNAME

Veraltet ab Version 4.14.2: This configuration is insecure, it is recommended to switch to GITLAB_CREDENTIALS.

GitLab username used to send merge requests for translation updates.

GITLAB_TOKEN

Veraltet ab Version 4.14.2: This configuration is insecure, it is recommended to switch to GITLAB_CREDENTIALS.

Neu in Version 4.3.

GitLab personal access token used to make API calls to send merge requests for translation updates.

GITHUB_CREDENTIALS

Neu in Version 4.3.

List for credentials for GitHub servers.

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

GITHUB_USERNAME

Veraltet ab Version 4.14.2: This configuration is insecure, it is recommended to switch to GITHUB_CREDENTIALS.

GitHub username used to send pull requests for translation updates.

GITHUB_TOKEN

Veraltet ab Version 4.14.2: This configuration is insecure, it is recommended to switch to GITHUB_CREDENTIALS.

Neu in Version 4.3.

GitHub personal access token used to make API calls to send pull requests for translation updates.

GOOGLE_ANALYTICS_ID

Google Analytics ID to turn on monitoring of Weblate using Google Analytics.

HIDE_REPO_CREDENTIALS

Hide repository credentials from the web interface. In case you have repository URL with user and password, Weblate will hide it when related info is shown to users.

For example instead of https://user:password@git.example.com/repo.git it will show just https://git.example.com/repo.git. It tries to clean up VCS error messages too in a similar manner.

Bemerkung

This is turned on by default.

HIDE_VERSION

Neu in Version 4.3.1.

Hides version information from unauthenticated users. This also makes all documentation links point to latest version instead of the documentation matching currently installed version.

Hiding version is recommended security practice in some corporations, but it doesn’t prevent attacker to figure out version by probing the behavior.

Bemerkung

Diese Funktion ist standardmäßig ausgeschaltet.

INTERLEDGER_PAYMENT_POINTERS

Neu in Version 4.12.1.

List of Interledger Payment Pointers (ILPs) for Web Monetization.

If multiple are specified, probabilistic revenue sharing is achieved by selecting one randomly.

Please check <https://webmonetization.org/> for more details.

Hinweis

The default value lets users fund Weblate itself.

IP_BEHIND_REVERSE_PROXY

Neu in Version 2.14.

Indicates whether Weblate is running behind a reverse proxy.

If set to True, Weblate gets IP address from a header defined by IP_PROXY_HEADER.

Warnung

Ensure you are actually using a reverse proxy and that it sets this header, otherwise users will be able to fake the IP address.

Bemerkung

This is not on by default.

IP_PROXY_HEADER

Neu in Version 2.14.

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

Defaults to HTTP_X_FORWARDED_FOR.

IP_PROXY_OFFSET

Neu in Version 2.14.

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

Abhängig von Ihrer Einrichtung kann dieser Header aus mehreren IP-Adressen bestehen (z.B. X-Forwarded-For: a, b, client-ip) und Sie können hier konfigurieren, welche Adresse aus dem Header als Client-IP-Adresse verwendet wird.

Warnung

Setting this affects the security of your installation, you should only configure it to use trusted proxies for determining IP address.

Defaults to 0.

LICENSE_EXTRA

Additional licenses to include in the license choices.

Bemerkung

Each license definition should be tuple of its short name, a long name and an URL.

For example:

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

LICENSE_FILTER

Geändert in Version 4.3: Setting this to blank value now disables license alert.

Filter list of licenses to show. This also disables the license alert when set to empty.

Bemerkung

This filter uses the short license names.

For example:

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

Following disables the license alert:

LICENSE_FILTER = set()

LICENSE_REQUIRED

Defines whether the license attribute in Component configuration is required.

Bemerkung

This is off by default.

LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH

Whether the length of a given translation should be limited. The restriction is the length of the source string × 10 characters.

Hinweis

Set this to False to allow longer translations (up to 10,000 characters) irrespective of source string length.

Bemerkung

Defaults to True.

LOCALIZE_CDN_URL and LOCALIZE_CDN_PATH

These settings configure the JavaScript-Lokalisierung CDN add-on. LOCALIZE_CDN_URL defines root URL where the localization CDN is available and LOCALIZE_CDN_PATH defines path where Weblate should store generated files which will be served at the LOCALIZE_CDN_URL.

Hinweis

On Hosted Weblate, this uses https://weblate-cdn.com/.

LOGIN_REQUIRED_URLS

A list of URLs you want to require signing in. (Besides the standard rules built into Weblate).

Hinweis

This allows you to password protect a whole installation using:

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

Hinweis

It is desirable to lock down API access as well, as shown in the above example.

Siehe auch

REQUIRE_LOGIN

LOGIN_REQUIRED_URLS_EXCEPTIONS

List of exceptions for LOGIN_REQUIRED_URLS. If not specified, users are allowed to access the sign in page.

Some of exceptions you might want to include:

LOGIN_REQUIRED_URLS_EXCEPTIONS = (
    r"/accounts/(.*)$",  # Required for sign in
    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
)

MATOMO_SITE_ID

ID of a site in Matomo (formerly Piwik) you want to track.

Bemerkung

This integration does not support the Matomo Tag Manager.

Siehe auch

MATOMO_URL

MATOMO_URL

Full URL (including trailing slash) of a Matomo (formerly Piwik) installation you want to use to track Weblate use. Please check <https://matomo.org/> for more details.

Hinweis

This integration does not support the Matomo Tag Manager.

For example:

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

Siehe auch

MATOMO_SITE_ID

NEARBY_MESSAGES

How many strings to show around the currently translated string. This is just a default value, users can adjust this in Benutzerprofil.

DEFAULT_PAGE_LIMIT

Neu in Version 4.7.

Standardanzahl der Elemente, die bei aktivem Seitenumbruch angezeigt werden.

PAGURE_CREDENTIALS

Neu in Version 4.3.2.

List for credentials for Pagure servers.

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

PAGURE_USERNAME

Veraltet ab Version 4.14.2: This configuration is insecure, it is recommended to switch to PAGURE_CREDENTIALS.

Neu in Version 4.3.2.

Pagure-Benutzername, der verwendet wird, um Merge Requests für Übersetzungsaktualisierungen zu senden.

PAGURE_TOKEN

Veraltet ab Version 4.14.2: This configuration is insecure, it is recommended to switch to PAGURE_CREDENTIALS.

Neu in Version 4.3.2.

Pagure personal access token used to make API calls to send merge requests for translation updates.

PRIVACY_URL

Neu in Version 4.8.1.

URL, unter der Ihre Weblate-Instanz ihre Datenschutzrichtlinie anzeigt.

Hinweis

Useful if you host your legal documents outside Weblate for embedding them inside Weblate, please check Rechtliche Grundlagen for details.

Example:

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

Siehe auch

LEGAL_URL

PROJECT_BACKUP_KEEP_COUNT

Neu in Version 4.14.

Defines how many backups per project are kept on the server. It defaults to 3.

PROJECT_BACKUP_KEEP_DAYS

Neu in Version 4.14.

Defines how long the project backups will be kept on the server. Defaults to 30 days.

RATELIMIT_ATTEMPTS

Neu in Version 3.2.

Maximum number of authentication attempts before rate limiting is applied.

Defaults to 5.

RATELIMIT_WINDOW

Neu in Version 3.2.

How long authentication is accepted after rate limiting applies.

An amount of seconds defaulting to 300 (5 minutes).

RATELIMIT_LOCKOUT

Neu in Version 3.2.

How long authentication is locked after rate limiting applies.

An amount of seconds defaulting to 600 (10 minutes).

REGISTRATION_ALLOW_BACKENDS

Neu in Version 4.1.

List of authentication backends to allow registration from. This only limits new registrations, users can still authenticate and add authentication using all configured authentication backends.

It is recommended to keep REGISTRATION_OPEN enabled while limiting registration backends, otherwise users will be able to register, but Weblate will not show links to register in the user interface.

Example:

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

Hinweis

The backend names match names used in URL for authentication.

REGISTRATION_CAPTCHA

A value of 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 turned on, a CAPTCHA is added to all pages where a users enters their e-mail address:

  • New account registration.

  • Password recovery.

  • Adding e-mail to an account.

  • Contact form for users that are not signed in.

REGISTRATION_EMAIL_MATCH

Neu in Version 2.17.

Allows you to filter which e-mail addresses can register.

Defaults to .*, which allows any e-mail address to be registered.

You can use it to restrict registration to a single e-mail domain:

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

REGISTRATION_OPEN

Whether registration of new accounts is currently permitted. This optional setting can remain the default True, or changed to False.

This setting affects built-in authentication by e-mail address or through the Python Social Auth (you can whitelist certain back-ends using REGISTRATION_ALLOW_BACKENDS).

Bemerkung

If using third-party authentication methods such as LDAP-Authentifizierung, it just hides the registration form, but new users might still be able to sign in and create accounts.

REPOSITORY_ALERT_THRESHOLD

Neu in Version 4.0.2.

Threshold for triggering an alert for outdated repositories, or ones that contain too many changes. Defaults to 25.

REQUIRE_LOGIN

Neu in Version 4.1.

This enables LOGIN_REQUIRED_URLS and configures REST framework to require authentication for all API endpoints.

Bemerkung

This is implemented in the Sample configuration. For Docker, use WEBLATE_REQUIRE_LOGIN.

SENTRY_DSN

Neu in Version 3.9.

Sentry DSN to use for Collecting error reports.

SIMPLIFY_LANGUAGES

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

Turn this off if you want to different translations for each variant.

SITE_DOMAIN

Configures site domain. This is necessary to produce correct absolute links in many scopes (for example activation e-mails, notifications or RSS feeds).

In case Weblate is running on non-standard port, include it here as well.

Beispiele:

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

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

Bemerkung

This setting should only contain the domain name. For configuring protocol, (enabling and enforcing HTTPS) use ENABLE_HTTPS and for changing URL, use URL_PREFIX.

Hinweis

On a Docker container, the site domain is configured through WEBLATE_ALLOWED_HOSTS.

SITE_TITLE

Site title to be used for the website and sent e-mails.

SPECIAL_CHARS

Additional characters to include in the visual keyboard, Visual keyboard.

The default value is:

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

SINGLE_PROJECT

Neu in Version 3.8.

Redirects users directly to a project or component instead of showing the dashboard. You can either set it to True and in this case it only works in case there is actually only single project in Weblate. Alternatively set the project slug, and it will redirect unconditionally to this project.

Geändert in Version 3.11: The setting now also accepts a project slug, to force displaying that single project.

Example:

SINGLE_PROJECT = "test"

SSH_EXTRA_ARGS

Neu in Version 4.9.

Allows to add custom parameters when Weblate is invoking SSH. This is useful when connecting to servers using legacy encryption or other non-standard features.

For example when SSH connection in Weblate fails with Unable to negotiate with legacyhost: no matching key exchange method found. Their offer: diffie-hellman-group1-sha1, you can enable that using:

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

Hinweis

The string is evaluated by shell, so make sure to quote any whitespace and special characters.

STATUS_URL

The URL where your Weblate instance reports its status.

SUGGESTION_CLEANUP_DAYS

Neu in Version 3.2.1.

Automatically deletes suggestions after a given number of days. Defaults to None, meaning no deletions.

UPDATE_LANGUAGES

Neu in Version 4.3.2.

Controls whether languages database should be updated when running database migration and is enabled by default. This setting has no effect on invocation of setuplang.

Warnung

The languages display might become inconsistent with this. Weblate language definitions extend over time and it will not display language code for the defined languages.

URL_PREFIX

This setting allows you to run Weblate under some path (otherwise it relies on being run from the webserver root).

Bemerkung

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.

Hinweis

The prefix should start with a /.

Example:

URL_PREFIX = "/translations"

Bemerkung

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

VCS_BACKENDS

Configuration of available VCS backends.

Bemerkung

Weblate tries to use all supported back-ends you have the tools for.

Hinweis

You can limit choices or add custom VCS back-ends by using this.

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

VCS_CLONE_DEPTH

Neu in Version 3.10.2.

Configures how deep cloning of repositories Weblate should do.

Bemerkung

Currently this is only supported in Git. By default Weblate does shallow clones of the repositories to make cloning faster and save disk space. Depending on your usage (for example when using custom Erweiterungen), you might want to increase the depth or turn off shallow clones completely by setting this to 0.

Hinweis

In case you get fatal: protocol error: expected old/new/ref, got 'shallow <commit hash>' error when pushing from Weblate, turn off shallow clones completely by setting:

VCS_CLONE_DEPTH = 0

WEBLATE_ADDONS

List of add-ons available for use. To use them, they have to be enabled for a given translation component. By default this includes all built-in add-ons, when extending the list you will probably want to keep existing ones enabled, for example:

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.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",
)

Bemerkung

Removing the add-on from the list does not uninstall it from the components. Weblate will crash in that case. Please uninstall add-on from all components prior to removing it from this list.

WEBLATE_EXPORTERS

Neu in Version 4.2.

List of a available exporters offering downloading translations or glossaries in various file formats.

WEBLATE_FORMATS

Neu in Version 3.0.

List of file formats available for use.

Bemerkung

The default list already has the common formats.

WEBLATE_MACHINERY

Neu in Version 4.13.

List of machinery services available for use.

WEBLATE_GPG_IDENTITY

Neu in Version 3.1.

Identity used by Weblate to sign Git commits, for example:

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

The Weblate GPG keyring is searched for a matching key (home/.gnupg under DATA_DIR). If not found, a key is generated, please check Signing Git commits with GnuPG for more details.

WEBSITE_REQUIRED

Defines whether Projektseite has to be specified when creating a project. Turned on by default as that suits public server setups.