Opcjonalne moduły Weblate#

Several optional modules are available for your setup.

Eksporter Git#

Provides you read-only access to the underlying Git repository using HTTP(S).

Instalacja#

Add weblate.gitexport to installed apps in settings.py:

INSTALLED_APPS += ("weblate.gitexport",)

Export existing repositories by migrating your database after installation:

weblate migrate

Zastosowanie#

The module automatically hooks into Weblate and sets the exported repository URL in the Konfiguracja komponentu. The repositories are accessible under the /git/ part of the Weblate URL, for example https://example.org/git/weblate/main/.

Repositories for publicly available projects can be cloned without authentication:

git clone 'https://example.org/git/weblate/main/'

Access to browse the repositories with restricted access (with Private access control or when REQUIRE_LOGIN is enabled) requires an API token which can be obtained in your user profile:

git clone 'https://user:KEY@example.org/git/weblate/main/'

Podpowiedź

By default members or Users group and anonymous user have access to the repositories for public projects via Access repository and Power user roles.

Rozliczenia#

This is used on Hosted Weblate to define billing plans, track invoices and usage limits.

Instalacja#

1. Add weblate.billing to installed apps in settings.py:

INSTALLED_APPS += ("weblate.billing",)

Run the database migration to optionally install additional database structures for the module:

weblate migrate

Zastosowanie#

After installation you can control billing in the admin interface. Users with billing enabled will get new Billing tab in their Profil użytkownika.

The billing module additionally allows project admins to create new projects and components without being superusers (see Dodawanie projektów i komponentów tłumaczeniowych). This is possible when following conditions are met:

The billing is in its configured limits (any overusage results in blocking of project/component creation) and paid (if its price is non zero)
The user is admin of existing project with billing or user is owner of billing (the latter is necessary when creating new billing for users to be able to import new projects).

Upon project creation user is able to choose which billing should be charged for the project in case he has access to more of them.

Informacje prawne#

This is used on Hosted Weblate to provide required legal documents. It comes provided with blank documents, and you are expected to fill out the following templates in the documents:

legal/documents/tos.html: Dokument Warunków świadczenia usług
legal/documents/privacy.html: Dokument dotyczący polityki prywatności
legal/documents/summary.html: Krótkie podsumowanie warunków świadczenia usług i polityki prywatności

On changing the terms of service documents, please adjust LEGAL_TOS_DATE so that users are forced to agree with the updated documents.

Informacja

Legal documents for the Hosted Weblate service are available in this Git repository <https://github.com/WeblateOrg/wllegal/tree/main/wllegal/templates/legal/documents>.

Most likely these will not be directly usable to you, but might come in handy as a starting point if adjusted to meet your needs.

Instalacja#

1. Add weblate.legal to installed apps in settings.py:

INSTALLED_APPS += ("weblate.legal",)

# Optional:

# Social auth pipeline to confirm TOS upon registration/subsequent sign in
SOCIAL_AUTH_PIPELINE += ("weblate.legal.pipeline.tos_confirm",)

# Middleware to enforce TOS confirmation of signed in users
MIDDLEWARE += [
    "weblate.legal.middleware.RequireTOSMiddleware",
]

Run the database migration to optionally install additional database structures for the module:

weblate migrate

Edit the legal documents in the weblate/legal/templates/legal/ folder to match your service.

Zastosowanie#

After installation and editing, the legal documents are shown in the Weblate UI.

Awatary#

Avatars are downloaded and cached server-side to reduce information leaks to the sites serving them by default. The built-in support for fetching avatars from e-mails addresses configured for it can be turned off using ENABLE_AVATARS.

Weblate obecnie obsługuje:

Zobacz także

Pamięć podręczna awatarów, AVATAR_URL_PREFIX, ENABLE_AVATARS

Ochrona przed spamem#

You can protect against spamming by users by using the Akismet service.

Install the akismet Python module (this is already included in the official Docker image).
Uzyskaj klucz API Akismet.
Store it as AKISMET_API_KEY or WEBLATE_AKISMET_API_KEY in Docker.

Following content is sent to Akismet for checking:

Sugestie od nieuwierzytelnionych użytkowników
Opisy projektów i komponentów oraz linki

Informacja

This (among other things) relies on IP address of the client, please see Działanie za odwrotnym proxy for properly configuring that.

Zobacz także

Działanie za odwrotnym proxy, AKISMET_API_KEY, WEBLATE_AKISMET_API_KEY

Signing Git commits with GnuPG#

All commits can be signed by the GnuPG key of the Weblate instance.

1. Turn on WEBLATE_GPG_IDENTITY. (Weblate will generate a GnuPG key when needed and will use it to sign all translation commits.)

This feature needs GnuPG 2.1 or newer installed.

You can find the key in the DATA_DIR and the public key is shown on the „About” page:

2. Alternatively you can also import existing keys into Weblate, just set HOME=$DATA_DIR/home when invoking gpg.

Podpowiedź

The key material is cached by Weblate for a long period. In case you let Weblate generate a key with WEBLATE_GPG_IDENTITY and then import key with the same identity to use an existing key, purging redis cache is recommended to see the effect of such change.

Informacja

When sharing DATA_DIR between multiple hosts, please follow instructions at https://wiki.gnupg.org/NFS to make GnuPG signing work reliably.

Zobacz także

WEBLATE_GPG_IDENTITY

Ograniczenie szybkości#

Zmienione w wersji 4.6: The rate limiting no longer applies to superusers.

Several operations in Weblate are rate limited. At most RATELIMIT_ATTEMPTS attempts are allowed within RATELIMIT_WINDOW seconds. The user is then blocked for RATELIMIT_LOCKOUT. There are also settings specific to scopes, for example RATELIMIT_CONTACT_ATTEMPTS or RATELIMIT_TRANSLATE_ATTEMPTS. The table below is a full list of available scopes.

The following operations are subject to rate limiting:

Nazwa	Zakres	Dozwolone próby	Okno ograniczeń szybkości	Okres blokady
Rejestracja	`REGISTRATION`	5	300	600
Wysyłanie wiadomości do administratorów	`MESSAGE`	2	300	600
Password authentication on sign in	`LOGIN`	5	300	600
Wyszukiwanie po całej stronie	`SEARCH`	6	60	60
Tłumaczenie	`TRANSLATE`	30	60	600
Dodawanie do słownika	`GLOSSARY`	30	60	600
Rozpoczynanie tłumaczenia na nowy język	`LANGUAGE`	2	300	600
Tworzenie nowego projektu	`PROJECT`	5	600	600

If a user fails to sign in AUTH_LOCK_ATTEMPTS times, password authentication will be turned off on the account until having gone through the process of having its password reset.

The settings can be also applied in the Docker container by adding WEBLATE_ prefix to the setting name, for example RATELIMIT_ATTEMPTS becomes WEBLATE_RATELIMIT_ATTEMPTS.

The API has separate rate limiting settings, see Ograniczanie szybkości interfejsu API.

Zobacz także

Ograniczenie szybkości, Działanie za odwrotnym proxy, Ograniczanie szybkości interfejsu API

Integracja z Fedora Messaging#

Fedora Messaging is AMQP-based publisher for all changes happening in Weblate. You can hook additional services on changes happening in Weblate using this.

The Fedora Messaging integration is available as a separate Python module weblate-fedora-messaging. Please see <https://github.com/WeblateOrg/fedora_messaging/> for setup instructions.