Configuration#
Tous les paramètres sont stockés dans settings.py (comme habituellement avec Django).
Note
After changing any of these settings, you need to restart Weblate — both WSGI and Celery processes.
S’il est exécuté en tant que mod_wsgi, vous devez redémarrer Apache pour recharger la configuration.
Voir aussi
Veuillez également consulter la documentation de Django pour les paramètres configurant spécialement Django.
AKISMET_API_KEY#
Weblate peut utiliser Akismet pour vérifier que les suggestions anonymes proposées ne soient pas des spams. Consultez akismet.com pour acheter une clé API et pour l’associer à un site.
ANONYMOUS_USER_NAME#
Le nom des utilisateurs qui ne sont pas connectés.
Voir aussi
AUDITLOG_EXPIRY#
How many days Weblate should keep audit logs (which contain info about account activity).
La valeur par défaut est de 180 jours.
AUTH_LOCK_ATTEMPTS#
Le nombre maximal de tentatives d’authentification échouées avant que la limitation de débit ne soit appliquée.
Ce paramètre est actuellement appliqué dans les emplacements suivants :
Lors de la connexion. Supprime le mot de passe du compte, empêchant l’utilisateur de se connecter sans demander un nouveau mot de passe.
Password reset. Prevents new e-mails from being sent, avoiding spamming users with too many password-reset attempts.
La valeur par défaut est 10.
Voir aussi
AUTO_UPDATE#
Met quotidiennement à jour tous les dépôts.
Indication
Utile si vous n’utilisez pas les Déclencheurs de notification pour mettre automatiquement à jour les dépôts de Weblate.
Note
L’option on/off existe en plus de l’utilisation d’une chaîne de caractères pour la rétrocompatibilité.
The options are:
"none"Pas de mises à jour quotidiennes.
"remote"etFalseMet à jour uniquement les dépôts distants.
"full"etTrueMet à jour les dépôts distants et fusionne la copie de travail.
Note
Ce paramètre exige que Background tasks using Celery fonctionne, et prendra effet après son redémarrage.
AVATAR_URL_PREFIX#
Prefix for constructing avatar URLs as:
${AVATAR_URL_PREFIX}/avatar/${MAIL_HASH}?${PARAMS}.
The following services are known to work:
- Gravatar (default), as per https://gravatar.com/
AVATAR_URL_PREFIX = 'https://www.gravatar.com/'- Libravatar, as per https://www.libravatar.org/
AVATAR_URL_PREFIX = 'https://www.libravatar.org/'
Voir aussi
AUTH_TOKEN_VALID#
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#
How many days Weblate rejects reusing a previously used password for a user.
The checking is based on the audit log, AUDITLOG_EXPIRY needs to be
at least same as this.
Note
Password changes made prior to Weblate 2.15 will not be accounted for in this policy.
La valeur par défaut est de 180 jours.
AUTOFIX_LIST#
Liste des correctifs automatiques à appliquer lors de l’enregistrement d’une chaîne.
Note
Provide a fully-qualified path to the Python class that implements the autofixer interface.
Corrections disponibles :
weblate.trans.autofixes.whitespace.SameBookendingWhitespaceMatches whitespace at the start and end of the string to the source.
weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsisRemplace les 3 points (…) par des points de suspension (…) si la chaîne source y recourt.
weblate.trans.autofixes.chars.RemoveZeroSpaceRemoves zero-width space characters if the source does not contain any.
weblate.trans.autofixes.chars.RemoveControlCharsRemoves control characters if the source does not contain any.
weblate.trans.autofixes.chars.DevanagariDandaReplaces sentence full stop in Bangla by the devanagari danda character.
weblate.trans.autofixes.html.BleachHTMLRemoves unsafe HTML markup from strings flagged as
safe-html(see HTML non sûr).
You can select which ones to use:
AUTOFIX_LIST = (
"weblate.trans.autofixes.whitespace.SameBookendingWhitespace",
"weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis",
)
BACKGROUND_TASKS#
Nouveau dans la version 4.5.2.
Defines how often lengthy maintenance tasks should be triggered for a component.
Right now this controls:
Traduction automatique add-on
Contrôles de qualité et corrections recalculation
Choix possibles :
monthly(this is the default)weeklydailynever
Note
Increasing the frequency is not recommended when Weblate contains thousands of components.
BASIC_LANGUAGES#
Nouveau dans la version 4.4.
List of languages to offer users for starting a new translation. When not specified, a built-in list is used (which includes all commonly used languages, but without country specific variants).
This only limits non privileged users to add unwanted languages. Project admins are still presented with the full selection of languages defined in Weblate.
Note
This does not define new languages for Weblate — it only filters existing ones in the database.
Exemple:
BASIC_LANGUAGES = {"cs", "it", "ja", "en"}
Voir aussi
BORG_EXTRA_ARGS#
Nouveau dans la version 4.9.
You can pass additional arguments to borg create when built-in backups are triggered.
Exemple:
BORG_EXTRA_ARGS = ["--exclude", "vcs/"]
Voir aussi
CACHE_DIR#
Nouveau dans la version 4.16.
Directory where Weblate stores cache files. Defaults to cache subfolder
in DATA_DIR.
Change this to local or temporary filesystem if DATA_DIR is on a
network filesystem.
The Docker container uses a separate volume for this, see Docker container volumes.
The following subdirectories usually exist:
fontsfont-config cache for Gestion des polices.
avatarCached user avatars, see Avatars.
staticDefault location for static Django files, specified by
STATIC_ROOT. See Serving static files.tesseractOCR trained data for Visual context for strings.
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.
Exemple:
# Enable Cloudflare Javascript optimizations
CSP_SCRIPT_SRC = ["ajax.cloudflare.com"]
Voir aussi
CHECK_LIST#
Liste des vérifications de qualité à effectuer sur une traduction.
Note
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 Quality checks are turned on by default, from where you can change these settings. By default they are commented out in Configuration d’exemple so that default values are used. New checks are 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",
)
Note
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.
Voir aussi
COMMIT_PENDING_HOURS#
Number of hours between committing pending changes by way of the background task.
CONTACT_FORM#
Nouveau dans la version 4.6.
Configures how e-mail from the contact form is being sent. Choose a configuration that matches the configuration of your mail server.
"reply-to"The sender is used in as Reply-To, this is the default behaviour.
"from"The sender is used in as From. Your mail server needs to allow sending such e-mails.
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:
homeHome directory used for invoking scripts.
sshSSH keys and configuration.
mediaDefault location for Django media files, specified by
MEDIA_ROOT. Contains uploaded screenshots, see Visual context for strings.vcsVersion-control repositories for translations.
backupsDaily backup data. Please check Données supprimées pour les sauvegardes for details.
fonts:User-uploaded fonts, see Gestion des polices.
cacheVarious caches. Can be placed elsewhere using
CACHE_DIR.The Docker container uses a separate volume for this, see Docker container volumes.
Note
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#
Whether the database backups should be stored as plain text, compressed or skipped. The authorized values are:
"plain""compressed""none"
Voir aussi
DEFAULT_ACCESS_CONTROL#
The default access-control setting for new projects:
0Public
1Protégé
100Privé
200Personnalisé
Use Custom if you are managing ACL manually, which means not relying on the internal Weblate management.
Voir aussi
DEFAULT_AUTO_WATCH#
Nouveau dans la version 4.5.
Configures whether Automatically watch projects on contribution
should be turned on for new users. Defaults to True.
Voir aussi
DEFAULT_RESTRICTED_COMPONENT#
Nouveau dans la version 4.1.
The default value for component restriction.
Voir aussi
DEFAULT_ADD_MESSAGE, DEFAULT_ADDON_MESSAGE, DEFAULT_COMMIT_MESSAGE, DEFAULT_DELETE_MESSAGE, DEFAULT_MERGE_MESSAGE#
Default commit messages for different operations, please check Configuration des composants for details.
DEFAULT_ADDONS#
Default add-ons to install for every created component.
Note
This setting affects only newly created components.
Exemple :
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",
},
}
Voir aussi
DEFAULT_COMMITER_EMAIL#
Committer e-mail address, defaulting to noreply@weblate.org.
Voir aussi
DEFAULT_COMMITER_NAME#
Committer name, defaulting to Weblate.
Voir aussi
DEFAULT_LANGUAGE#
Nouveau dans la version 4.3.2.
Langue source for any new components.
Defaults to en. The matching language object needs to exist in the database.
Voir aussi
DEFAULT_MERGE_STYLE#
Style de fusion for any new components.
rebase - default
merge
Voir aussi
DEFAULT_TRANSLATION_PROPAGATION#
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. On by default.
Avatars are fetched and cached on the server, lowering the risk of leaking private info, speeding up the user experience.
Voir aussi
ENABLE_HOOKS#
Whether to turn on anonymous remote hooks.
Voir aussi
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 a HTTPS URL.
The HTTPS redirection might be problematic in some cases and you might hit
an issue with infinite redirection in case you are using a reverse proxy doing
an 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.
EXTRA_HTML_HEAD#
Nouveau dans la version 4.15.
Insert additional markup into the HTML header. Can be used for verification of site ownership, for example:
EXTRA_HTML_HEAD = '<link href="https://fosstodon.org/@weblate" rel="me">'
Avertissement
No sanitization is performed on the string. It is inserted as-is into the HTML header.
GET_HELP_URL#
Nouveau dans la version 4.5.2.
URL where support for your Weblate instance can be found.
GITEA_CREDENTIALS#
Nouveau dans la version 4.12.
List for credentials for Gitea servers.
GITEA_CREDENTIALS = {
"try.gitea.io": {
"username": "weblate",
"token": "your-api-token",
},
}
The configuration dictionary consists of credentials defined for each API host.
The API host might be different from what you use in the web browser, for
example GitHub API is accessed as api.github.com.
The following configuration is available for each host:
usernameAPI user, required.
tokenAPI token for the API user, required.
schemeNouveau dans la version 4.18.
Scheme override. Weblate attempts to parse scheme from the repository URL and falls backs to
https. If you are running the API server internally, you might want to usehttpinstead, but consider security.
Indication
In the Docker container, the credentials can be configured in three variables and the credentials are built out of that. An example configuration for GitHub might look like:
WEBLATE_GITHUB_USERNAME=api-user
WEBLATE_GITHUB_TOKEN=api-token
WEBLATE_GITHUB_HOST=api.github.com
Will be used as:
GITHUB_CREDENTIALS = {
"api.github.com": {
"username": "api-user",
"token": "api-token",
}
}
Alternatively the Python dictonary can be provided as a string:
WEBLATE_GITHUB_CREDENTIALS='{ "api.github.com": { "username": "api-user", "token": "api-token", } }'
Or the path to a file containing the Python dictionary:
echo '{ "api.github.com": { "username": "api-user", "token": "api-token", } }' > /path/to/github-credentials
WEBLATE_GITHUB_CREDENTIALS_FILE='/path/to/github-credentials'
GITLAB_CREDENTIALS#
Nouveau dans la version 4.3.
List for credentials for GitLab servers.
GITLAB_CREDENTIALS = {
"gitlab.com": {
"username": "weblate",
"token": "your-api-token",
},
}
The configuration dictionary consists of credentials defined for each API host.
The API host might be different from what you use in the web browser, for
example GitHub API is accessed as api.github.com.
The following configuration is available for each host:
usernameAPI user, required.
tokenAPI token for the API user, required.
schemeNouveau dans la version 4.18.
Scheme override. Weblate attempts to parse scheme from the repository URL and falls backs to
https. If you are running the API server internally, you might want to usehttpinstead, but consider security.
Indication
In the Docker container, the credentials can be configured in three variables and the credentials are built out of that. An example configuration for GitHub might look like:
WEBLATE_GITHUB_USERNAME=api-user
WEBLATE_GITHUB_TOKEN=api-token
WEBLATE_GITHUB_HOST=api.github.com
Will be used as:
GITHUB_CREDENTIALS = {
"api.github.com": {
"username": "api-user",
"token": "api-token",
}
}
Alternatively the Python dictonary can be provided as a string:
WEBLATE_GITHUB_CREDENTIALS='{ "api.github.com": { "username": "api-user", "token": "api-token", } }'
Or the path to a file containing the Python dictionary:
echo '{ "api.github.com": { "username": "api-user", "token": "api-token", } }' > /path/to/github-credentials
WEBLATE_GITHUB_CREDENTIALS_FILE='/path/to/github-credentials'
GITHUB_CREDENTIALS#
Nouveau dans la version 4.3.
List for credentials for GitHub servers.
GITHUB_CREDENTIALS = {
"api.github.com": {
"username": "weblate",
"token": "your-api-token",
},
}
The configuration dictionary consists of credentials defined for each API host.
The API host might be different from what you use in the web browser, for
example GitHub API is accessed as api.github.com.
The following configuration is available for each host:
usernameAPI user, required.
tokenAPI token for the API user, required.
schemeNouveau dans la version 4.18.
Scheme override. Weblate attempts to parse scheme from the repository URL and falls backs to
https. If you are running the API server internally, you might want to usehttpinstead, but consider security.
Indication
In the Docker container, the credentials can be configured in three variables and the credentials are built out of that. An example configuration for GitHub might look like:
WEBLATE_GITHUB_USERNAME=api-user
WEBLATE_GITHUB_TOKEN=api-token
WEBLATE_GITHUB_HOST=api.github.com
Will be used as:
GITHUB_CREDENTIALS = {
"api.github.com": {
"username": "api-user",
"token": "api-token",
}
}
Alternatively the Python dictonary can be provided as a string:
WEBLATE_GITHUB_CREDENTIALS='{ "api.github.com": { "username": "api-user", "token": "api-token", } }'
Or the path to a file containing the Python dictionary:
echo '{ "api.github.com": { "username": "api-user", "token": "api-token", } }' > /path/to/github-credentials
WEBLATE_GITHUB_CREDENTIALS_FILE='/path/to/github-credentials'
BITBUCKETSERVER_CREDENTIALS#
Nouveau dans la version 4.16.
List for credentials for Bitbucket servers.
BITBUCKETSERVER_CREDENTIALS = {
"git.self-hosted.com": {
"username": "weblate",
"token": "http-access-token",
},
}
The configuration dictionary consists of credentials defined for each API host.
The API host might be different from what you use in the web browser, for
example GitHub API is accessed as api.github.com.
The following configuration is available for each host:
usernameAPI user, required.
tokenAPI token for the API user, required.
schemeNouveau dans la version 4.18.
Scheme override. Weblate attempts to parse scheme from the repository URL and falls backs to
https. If you are running the API server internally, you might want to usehttpinstead, but consider security.
Indication
In the Docker container, the credentials can be configured in three variables and the credentials are built out of that. An example configuration for GitHub might look like:
WEBLATE_GITHUB_USERNAME=api-user
WEBLATE_GITHUB_TOKEN=api-token
WEBLATE_GITHUB_HOST=api.github.com
Will be used as:
GITHUB_CREDENTIALS = {
"api.github.com": {
"username": "api-user",
"token": "api-token",
}
}
Alternatively the Python dictonary can be provided as a string:
WEBLATE_GITHUB_CREDENTIALS='{ "api.github.com": { "username": "api-user", "token": "api-token", } }'
Or the path to a file containing the Python dictionary:
echo '{ "api.github.com": { "username": "api-user", "token": "api-token", } }' > /path/to/github-credentials
WEBLATE_GITHUB_CREDENTIALS_FILE='/path/to/github-credentials'
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.
Note
On by default.
HIDE_VERSION#
Nouveau dans la version 4.3.1.
Hides version info from unauthenticated users. This also makes all documentation links point to the latest version instead of the documentation matching the currently installed version.
Hiding the version is a recommended security practice in some corporations, does not prevent an attacker from figuring out version by probing behavior.
Note
Cette fonction est désactivée par défaut.
INTERLEDGER_PAYMENT_POINTERS#
Nouveau dans la 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.
Indication
The default value lets users fund Weblate itself.
IP_BEHIND_REVERSE_PROXY#
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.
Avertissement
Ensure you are actually using a reverse proxy and that it sets this header, otherwise users will be able to fake the IP address.
Note
This is not on by default.
IP_PROXY_HEADER#
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#
Modifié dans la version 5.0.1: The default changed from 1 to -1.
Indicates which part of IP_PROXY_HEADER is used as client IP
address.
Depending on your setup, this header might consist of several IP addresses,
(for example X-Forwarded-For: client-ip, proxy-a, proxy-b) and you can configure
which address from the header is used as client IP address here.
Avertissement
Setting this affects the security of your installation. You should only configure it to use trusted proxies for determining the IP address. Please check <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#security_and_privacy_concerns> for more details.
Defaults to -1.
LEGAL_TOS_DATE#
Nouveau dans la version 4.15.
Note
You need Mentions légales installed to make this work.
Date of last update of terms of service documents. Whenever the date changes, users are required to agree with the updated terms of service.
from datetime import date
LEGAL_TOS_DATE = date(2022, 2, 2)
LEGAL_URL#
URL where your Weblate instance shows its legal documents.
Indication
Useful if you host your legal documents outside Weblate for embedding them inside Weblate. Please check Mentions légales for details.
Exemple :
LEGAL_URL = "https://weblate.org/terms/"
Voir aussi
LICENSE_EXTRA#
Additional licenses to include in the license choices.
Note
Each license definition should be tuple of its short name, a long name and an URL.
Par exemple :
LICENSE_EXTRA = [
(
"AGPL-3.0",
"GNU Affero General Public License v3.0",
"https://www.gnu.org/licenses/agpl-3.0-standalone.html",
),
]
LICENSE_FILTER#
Modifié dans la 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.
Note
This filter uses the short license names.
Par exemple :
LICENSE_FILTER = {"AGPL-3.0", "GPL-3.0-or-later"}
Following disables the license alert:
LICENSE_FILTER = set()
Voir aussi
LICENSE_REQUIRED#
Defines whether the license attribute in Configuration des composants is required.
Note
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.
Indication
Set this to False to allow longer translations (up to 10,000 characters) irrespective of source string length.
Note
Defaults to True.
LOCALIZE_CDN_URL et LOCALIZE_CDN_PATH#
These settings configure the JavaScript localisation 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.
Indication
On Hosted Weblate, this uses https://weblate-cdn.com/.
Voir aussi
LOGIN_REQUIRED_URLS#
A list of URLs you want to require signing in. (Besides the standard rules built into Weblate).
Indication
This allows you to password protect a whole installation using:
LOGIN_REQUIRED_URLS = (r"/(.*)$",)
REST_FRAMEWORK["DEFAULT_PERMISSION_CLASSES"] = [
"rest_framework.permissions.IsAuthenticated"
]
Indication
Il est également souhaitable de verrouiller l’accès à l’API, comme le montre l’exemple ci-dessus.
Voir aussi
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"/widget/(.*)$", # 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 the site in Matomo (formerly Piwik) you want to use for tracking Weblate.
Note
This integration does not support the Matomo Tag Manager.
Voir aussi
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.
Indication
This integration does not support the Matomo Tag Manager.
Par exemple :
MATOMO_SITE_ID = 1
MATOMO_URL = "https://example.matomo.cloud/"
Voir aussi
NEARBY_MESSAGES#
How many strings to show around the currently translated string. This is just a default value, users can adjust this in Profil utilisateur.
DEFAULT_PAGE_LIMIT#
Nouveau dans la version 4.7.
Default number of elements to display when pagination is active.
PAGURE_CREDENTIALS#
Nouveau dans la version 4.3.2.
List for credentials for Pagure servers.
PAGURE_CREDENTIALS = {
"pagure.io": {
"username": "weblate",
"token": "your-api-token",
},
}
The configuration dictionary consists of credentials defined for each API host.
The API host might be different from what you use in the web browser, for
example GitHub API is accessed as api.github.com.
The following configuration is available for each host:
usernameAPI user, required.
tokenAPI token for the API user, required.
schemeNouveau dans la version 4.18.
Scheme override. Weblate attempts to parse scheme from the repository URL and falls backs to
https. If you are running the API server internally, you might want to usehttpinstead, but consider security.
Indication
In the Docker container, the credentials can be configured in three variables and the credentials are built out of that. An example configuration for GitHub might look like:
WEBLATE_GITHUB_USERNAME=api-user
WEBLATE_GITHUB_TOKEN=api-token
WEBLATE_GITHUB_HOST=api.github.com
Will be used as:
GITHUB_CREDENTIALS = {
"api.github.com": {
"username": "api-user",
"token": "api-token",
}
}
Alternatively the Python dictonary can be provided as a string:
WEBLATE_GITHUB_CREDENTIALS='{ "api.github.com": { "username": "api-user", "token": "api-token", } }'
Or the path to a file containing the Python dictionary:
echo '{ "api.github.com": { "username": "api-user", "token": "api-token", } }' > /path/to/github-credentials
WEBLATE_GITHUB_CREDENTIALS_FILE='/path/to/github-credentials'
Voir aussi
PRIVACY_URL#
Nouveau dans la version 4.8.1.
URL where your Weblate instance shows its privacy policy.
Indication
Useful if you host your legal documents outside Weblate for embedding them inside Weblate, please check Mentions légales for details.
Exemple :
PRIVACY_URL = "https://weblate.org/terms/"
Voir aussi
PRIVATE_COMMIT_EMAIL_OPT_IN#
Nouveau dans la version 4.15.
Configures whether the private commit e-mail is opt-in or opt-out (by default it is opt-in).
Voir aussi
PRIVATE_COMMIT_EMAIL_TEMPLATE#
Nouveau dans la version 4.15.
Template to generate private commit e-mail for an user. Defaults to "{username}@users.noreply.{site_domain}".
Définir une chaîne vide pour la désactiver.
Note
Using different commit e-mail is opt-in for users unless configured by
PRIVATE_COMMIT_EMAIL_OPT_IN. Users can configure commit e-mail in
the Profil.
PROJECT_BACKUP_KEEP_COUNT#
Nouveau dans la version 4.14.
Defines how many backups per project are kept on the server. Defaults to 3.
Voir aussi
PROJECT_BACKUP_KEEP_DAYS#
Nouveau dans la version 4.14.
Defines how long the project backups will be kept on the server. Defaults to 30 days.
Voir aussi
PROJECT_NAME_RESTRICT_RE#
Nouveau dans la version 4.15.
Defines a regular expression to restrict project naming. Any matching names will be rejected.
Voir aussi
PROJECT_WEB_RESTRICT_HOST#
Nouveau dans la version 4.16.2.
Reject using certain hosts in project website. Any subdomain is matched, so
including example.com will block test.example.com as well. The list
should contain lower case strings only, the parsed domain is lower cased before
matching.
Configuration par défaut :
PROJECT_WEB_RESTRICT_HOST = {"localhost"}
PROJECT_WEB_RESTRICT_NUMERIC#
Nouveau dans la version 4.16.2.
Reject using numeric IP address in project website. On by default.
PROJECT_WEB_RESTRICT_RE#
Nouveau dans la version 4.15.
Defines a regular expression to restrict project websites. Any matching URLs will be rejected.
RATELIMIT_ATTEMPTS#
Maximum number of authentication attempts before rate limiting is applied.
Defaults to 5.
Voir aussi
RATELIMIT_WINDOW#
How long authentication is accepted after rate limiting applies.
An amount of seconds, defaulting to 300 (5 minutes).
Voir aussi
RATELIMIT_LOCKOUT#
How long authentication is locked after rate limiting applies.
An amount of seconds defaulting to 600 (10 minutes).
Voir aussi
REGISTRATION_ALLOW_BACKENDS#
Nouveau dans la 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 on while limiting
registration backends, otherwise users will be able to register, but Weblate
will not show links to register in the user interface.
Exemple :
REGISTRATION_ALLOW_BACKENDS = ["azuread-oauth2", "azuread-tenant-oauth2"]
Indication
The backend names match names used in the URL for authentication.
Voir aussi
REGISTRATION_CAPTCHA#
Whether registration of new accounts is protected by a CAPTCHA. Defaults to enabled.
If turned on, a CAPTCHA is added to all pages where a users enters their e-mail address:
New account registration.
Récupération du mot de passe.
Adding e-mail to an account.
Contact form for users that are not signed in.
REGISTRATION_EMAIL_MATCH#
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. Defaults to enabled.
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).
Note
If using third-party authentication methods such as S’authentifier avec LDAP, it just hides the registration form, but new users might still be able to sign in and create accounts.
REGISTRATION_REBIND#
Nouveau dans la version 4.16.
Allow rebinding authentication backends for existing users. Turn this on when migrating between authentication providers.
Note
Off by default to not allow adding other authentication backends to an existing account. Rebinding can lead to account compromise when using more third-party authentication backends.
REPOSITORY_ALERT_THRESHOLD#
Nouveau dans la version 4.0.2.
Threshold for triggering an alert for outdated repositories, or ones that contain too many changes. Defaults to 25.
Voir aussi
REQUIRE_LOGIN#
Nouveau dans la version 4.1.
This enables LOGIN_REQUIRED_URLS and configures REST framework to
require authentication for all API endpoints.
Note
This is implemented in the Configuration d’exemple. For Docker, use
WEBLATE_REQUIRE_LOGIN.
SENTRY_DSN#
Sentry DSN to use for Collecting error reports.
Voir aussi
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. Necessary to produce correct absolute links in many scopes (for example activation e-mails, notifications or RSS feeds).
If Weblate is running on a non-standard port, include it here as well.
Exemples :
# Production site with domain name
SITE_DOMAIN = "weblate.example.com"
# Local development with IP address and port
SITE_DOMAIN = "127.0.0.1:8000"
Note
This setting should only contain the domain name. For configuring protocol,
(turning on and enforcing HTTPS) use ENABLE_HTTPS and for changing
the URL, use URL_PREFIX.
Indication
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, Clavier visuel.
La valeur par défaut est :
SPECIAL_CHARS = ("\t", "\n", "\u00a0", "…")
SINGLE_PROJECT#
Redirects users directly to a project or component instead of showing
the dashboard. You can either set it to True so it only works
if there is actually only single project in Weblate. Alternatively, set
the project slug, and it will redirect unconditionally to this project.
Exemple :
SINGLE_PROJECT = "test"
SSH_EXTRA_ARGS#
Nouveau dans la version 4.9.
Allows adding custom parameters when Weblate is invoking SSH. 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 turn that on using:
SSH_EXTRA_ARGS = "-oKexAlgorithms=+diffie-hellman-group1-sha1"
Indication
The string is evaluated by the shell, so ensure any whitespace and special characters is quoted.
Voir aussi
STATUS_URL#
The URL where your Weblate instance reports its status.
SUGGESTION_CLEANUP_DAYS#
Automatically deletes suggestions after a given number of days.
Defaults to None, meaning no deletions.
UNUSED_ALERT_DAYS#
Nouveau dans la version 4.17.
Configures when the Component seems unused alert is triggered.
Defaults to 365 days, set to 0 to turn it off.
UPDATE_LANGUAGES#
Nouveau dans la version 4.3.2.
Controls whether languages database should be updated when running database
migration and is on by default. This setting has no effect on invocation
of setuplang.
Avertissement
The languages display might become inconsistent with this. Weblate language definitions expand over time and it will not display language code for the defined languages.
Voir aussi
URL_PREFIX#
This setting allows you to run Weblate under some path (otherwise it relies on being run from the webserver root).
Note
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.
Indication
The prefix should start with a /.
Exemple :
URL_PREFIX = "/translations"
Note
This setting does not work with Django’s built-in server, you would have to
adjust urls.py to contain this prefix.
VCS_API_DELAY#
Nouveau dans la version 4.15.1.
Configures minimal delay in seconds between third-party API calls in Requêtes de fusion GitHub, Requêtes de fusion GitLab, Gitea pull requests, and Requêtes de fusion Pagure.
This rate-limits API calls from Weblate to these services to avoid overloading them.
If you are being limited by secondary rate-limiter at GitHub, increasing this might help.
La valeur par défaut est 10.
VCS_BACKENDS#
Configuration of available VCS backends.
Note
Weblate tries to use all supported back-ends you have the tools for.
Indication
You can limit choices or add custom VCS back-ends by using this.
VCS_BACKENDS = ("weblate.vcs.git.GitRepository",)
VCS_CLONE_DEPTH#
Configures how deep cloning of repositories Weblate should do.
Note
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 Extensions), you might want to increase the depth or turn off shallow clones completely by setting this to 0.
Indication
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.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",
)
Note
Removing the add-on from the list does not uninstall it from the components. Weblate will crash in that case. Please uninstall the add-on from all components prior to removing it from this list.
Voir aussi
WEBLATE_EXPORTERS#
Nouveau dans la version 4.2.
List of a available exporters offering downloading translations or glossaries in various file formats.
Voir aussi
WEBLATE_FORMATS#
List of file formats available for use.
Note
The default list already has the common formats.
Voir aussi
WEBLATE_MACHINERY#
Nouveau dans la version 4.13.
List of machinery services available for use.
Voir aussi
WEBLATE_GPG_IDENTITY#
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.
Voir aussi
WEBSITE_REQUIRED#
Defines whether Site Web du projet has to be specified when creating a project. On by default, as that suits public server setups.
COMMENT_CLEANUP_DAYS#
Delete comments after a given number of days. Defaults to
None, meaning no deletion at all.