設定

すべての設定は settings.py に保存されます（Django の通常の方法）。

注釈

これらの設定の変更後、Weblate（WSGI プロセスと Celery プロセスの両方）の再起動が必要です。

mod_wsgi として実行する場合は、Apache を再起動して設定のリロードが必要です。

参考

Django 自体の設定パラメーターについては、Django's documentation も確認してください。

ADMINS_CONTACT

お問い合わせフォームの送信先メールアドレスを設定します。設定されていない場合は、ADMINS のメール アドレスが使用されます。

設定する送信先メールアドレス一覧:

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

参考

CONTACT_FORM、ADMINS

AKISMET_API_KEY

Weblate は Akismet を使用して、匿名の提案がスパムであるかどうか検査できます。API キーを購入してサイトに関連付けるには、akismet.com にアクセスしてください。

ANONYMOUS_USER_NAME

サインインしていないユーザーのユーザー名。

参考

アクセス制御

AUDITLOG_EXPIRY

Weblate が、アカウント（作業履歴に関する情報を含む）の監査ログを保持する日数をどの程度にするかを設定します。

デフォルトは 180 日です。

AUTH_LOCK_ATTEMPTS

接続制限が適用されるまでに失敗した認証試行の最大回数。

現在、適用している場所：

  • サインイン。アカウント パスワードを削除し、ユーザーが新しいパスワードを要求しなければサインインできないようにしています。

  • パスワードのリセット。新しいメールが送信されないようにして、パスワードのリセット試行回数が多すぎるユーザーへのスパムを回避します。

デフォルトは 10 回です。

参考

接続制限

AUTO_UPDATE

すべてのリポジトリを毎日更新。

ヒント

Weblate リポジトリを自動的に更新するために 通知フック を使用していない場合に便利です。

注釈

後方互換性のために、文字列選択の他に on/off のオプションがあります。

オプションとは:

"none"

毎日の更新はなし。

"remote" および False

リモートのみを更新。

"full" および True

リモートを更新し、作業コピーをマージする。

注釈

これには、Celery を使用するバックグラウンド タスク が動作していることが必要で、再起動後に有効になります。

AVATAR_URL_PREFIX

アバター URL を作成するための接頭辞: ${AVATAR_URL_PREFIX}/avatar/${MAIL_HASH}?${PARAMS}。動作することが判明しているサービス:

Gravatar （デフォルト）、https://gravatar.com/ より

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

Libravatar、https://www.libravatar.org/ より

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

参考

アバターのキャッシュ、ENABLE_AVATARS、アバター

AUTH_TOKEN_VALID

パスワード リセット メールを送信してからの認証トークンと仮パスワードの有効期間。秒数で設定し、デフォルトは 172800（2 日）。

AUTH_PASSWORD_DAYS

Weblate において、ユーザーが以前に使用したパスワードの再利用を禁止する日数。

チェックは監査ログに基づいて実施されます。AUDITLOG_EXPIRY はこの日数以上に設定してください。

注釈

Weblate 2.15 以前に行われたパスワードの変更は、このポリシーには含まれません。

デフォルトは 180 日です。

AUTOFIX_LIST

文字列を保存するときに適用する自動修正の一覧。

注釈

autofixer インターフェースを実装した Python クラスへの完全修飾パスを提供します。

修正項目の設定方法:

weblate.trans.autofixes.whitespace.SameBookendingWhitespace

文字列の最初と最後の空白を原文と一致させる。

weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis

原文に省略記号（…）が付いている場合は、末尾のドット（...）を置き換える。

weblate.trans.autofixes.chars.RemoveZeroSpace

原文にゼロ幅のスペース文字が含まれていない場合、ゼロ幅のスペース文字を削除する。

weblate.trans.autofixes.chars.RemoveControlChars

原文に制御文字が含まれていない場合は、制御文字を削除する。

weblate.trans.autofixes.chars.RemoveZeroSpace

バングラ語の文のピリオドを、デーヴァナーガリー文字のダンダ ピリオドに置き換えます。

weblate.trans.autofixes.html.BleachHTML

safe-html のフラグが付いた文字列から安全でない HTML マークアップを削除する（参照: 安全でない HTML）。

使用する項目の選択方法:

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

参考

自動修正、自動修正のカスタマイズ

BACKGROUND_TASKS

Added in version 4.5.2.

コンポーネントに対して時間のかかるメンテナンス タスクを起動させる頻度を定義します。

現在管理できるもの:

可能な選択肢:

  • monthly （これがデフォルト）

  • weekly

  • daily

  • never

注釈

Weblate に数千個のコンポーネントが含まれている場合、頻度を増やすことは推奨しません。

BASIC_LANGUAGES

Added in version 4.4.

新しい翻訳を開始するためにユーザーに提供する言語の一覧。指定しない場合は、一般的に使用されているすべての言語を含む組み込みリストを使用しますが、国の指定がついた言語コードは含みません。

これは、特権のないユーザーが不要な言語を追加することを制限するだけです。プロジェクト管理者には、選択肢にすべての Weblate に設定済みの言語が引き続き表示されます。

注釈

これは Weblate に新しい言語を定義するものではなく、データベース内の既存の言語にフィルターをかけるだけです。

例:

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

参考

言語の定義

BORG_EXTRA_ARGS

Added in version 4.9.

内蔵のバックアップが起動されたときに、borg create に追加の引数を渡せます。

例:

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

参考

Weblate のバックアップと移動、borg create

CACHE_DIR

Added in version 4.16.

Weblate がキャッシュ ファイルを保存するディレクトリ。デフォルトは DATA_DIR のサブフォルダ cache です。

DATA_DIR がネットワーク ファイルシステム上にある場合は、これをローカルまたは一時ファイルシステムに変更します。

Docker コンテナでは、静的ファイルは別のボリュームを使用します。参照: Docker コンテナのボリューム。

通常存在する、サブディレクトリ一覧:

fonts

フォントの管理 用の font-config キャッシュ。

avatar

キャッシュされたユーザーのアバター。参照: アバター。

static

STATIC_ROOT で指定する、静的 Django ファイルのデフォルトの場所。参照: 静的ファイルの提供。

tesseract

文字列の視覚情報 の OCR 学習済みデーター。

CSP_SCRIPT_SRC、CSP_IMG_SRC、CSP_CONNECT_SRC、CSP_STYLE_SRC、CSP_FONT_SRC

Weblate の Content-Security-Policy ヘッダーをカスタマイズします。ヘッダーは、サード パーティのサービス（Matomo、Google アナリティクス、Sentry、…）との連携が有効として自動的に生成されます。

これらのデフォルトはすべて空のリストになります。

例:

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

参考

コンテンツ セキュリティ ポリシー、コンテンツ セキュリティ ポリシー（CSP）

CHECK_LIST

翻訳に対して実行する品質検査のリストです。

注釈

check インタフェースを実装する Python クラスへの完全修飾パスを指定します。

検査項目を選択して、関連する検査を含めます。

デフォルトでは、搭載しているすべての 品質検査 が有効なっているので、ここで設定を変更できます。デフォルトでは、設定例 でコメント化されているため、デフォルト値が使用されます。その後は、Weblate の新しいバージョンのリリースのたびに新しい検査が行われます。

すべての検査項目を無効にする方法:

CHECK_LIST = ()

指定する項目のみを有効にする方法:

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

注釈

この設定を変更すると、新しく変更した翻訳のみ検査されて、過去の検査結果は引き続きデータベースに保存されたままです。保存されている翻訳にも、新しい検査を適用するには、updatechecks を実行します。

参考

品質検査、フラグを使用した動作の設定

COMMENT_CLEANUP_DAYS

指定した日数の後にコメントを削除します。デフォルトは None で、削除は一切行いません。

COMMIT_PENDING_HOURS

バックグラウンド タスクを使用して保留中の変更をコミットするまでの時間。

参考

コンポーネント構成、コミットするまでの経過時間、メンテナンス タスクの実行、commit_pending

CONTACT_FORM

Added in version 4.6.

問い合わせフォームから、メールを送信する方法を設定します。メール サーバーの設定に合わせて選択します。

"reply-to"

送信者は Reply-To に使用します。デフォルトの動作。

"from"

送信者は From に使用します。メール サーバーは、このメール アドレスの送信の許可が必要です。

参考

ADMINS_CONTACT

DATA_DIR

Weblate フォルダには、すべてのデータが格納されます。このフォルダには、VCS リポジトリへのリンク、フル テキスト インデックス、外部ツール用の各種設定ファイルが含まれています。

通常存在する、サブディレクトリ一覧:

home

スクリプトを起動するためのホーム ディレクトリ。

ssh

SSH 鍵と設定。

media

MEDIA_ROOT で指定する、Django メディア ファイルのデフォルトの場所。アップロードされたスクリーンショットが含まれています。参照: 文字列の視覚情報。

vcs

翻訳用のバージョン管理リポジトリ。

backups

毎日のバックアップ データ、詳細は バックアップ用にダンプしたデータ を確認してください。

fonts:

ユーザーがアップロードしたフォント。参照: フォントの管理。

cache

CACHE_DIR を使用して、さまざまなキャッシュを別の場所に設定します。

Docker コンテナでは、静的ファイルは別のボリュームを使用します。参照: Docker コンテナのボリューム。

注釈

このディレクトリは、Weblate の書き込み権限が必要です。uWSGI として実行するには、www-data ユーザーに書き込み権限が必要です。

これを実現する最も簡単な方法は、このユーザーをディレクトリの所有者にすることです。

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

デフォルトは /home/weblate/data ですが、設定してください。

参考

ファイル システムのアクセス権、Weblate のバックアップと移動、CACHE_DIR

DATABASE_BACKUP

データベースのバックアップをプレーン テキストとして保存するか、圧縮するか、何も実行しないかを指定します。設定できる値:

  • "plain"

  • "compressed"

  • "none"

参考

Weblate のバックアップと移動

DEFAULT_ACCESS_CONTROL

新しいプロジェクトのデフォルトのアクセス制御設定方法:

0

公開

1

保護

100

プライベート

200

カスタム

ACL を手動で管理する場合は、カスタム を使用します。これは、Weblate の内部管理に依存しないという意味です。

参考

プロジェクトのアクセス制御、アクセス制御

DEFAULT_AUTO_WATCH

Added in version 4.5.

新規ユーザーに対して、貢献したプロジェクトを自動的に監視する を有効にするかどうかを設定します。デフォルトは True です。

参考

通知

DEFAULT_RESTRICTED_COMPONENT

Added in version 4.1.

コンポーネント制限のデフォルト値。

参考

アクセス制限、チームの範囲

DEFAULT_ADD_MESSAGE、DEFAULT_ADDON_MESSAGE、DEFAULT_COMMIT_MESSAGE、DEFAULT_DELETE_MESSAGE、DEFAULT_MERGE_MESSAGE

違う操作のデフォルトのコミット メッセージです。詳細は コンポーネント構成 を確認してください。

参考

テンプレート用のマークアップ、コンポーネント構成、コミット、追加、削除、マージ、アドオン、およびマージ リクエストのメッセージ

DEFAULT_ADDONS

作成したすべてのコンポーネントにインストールされるデフォルトのアドオン。

注釈

この設定は、新しく作成したコンポーネントにのみ適用されます。

例:

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

参考

install_addon、アドオン、WEBLATE_ADDONS

DEFAULT_COMMITER_EMAIL

コミッターのメールアドレスのデフォルトは noreply@weblate.org です。

参考

DEFAULT_COMMITER_NAME

DEFAULT_COMMITER_NAME

コミッター名のデフォルトは Weblate です。

参考

DEFAULT_COMMITER_EMAIL

DEFAULT_LANGUAGE

Added in version 4.3.2.

新しいコンポーネントには 原文の言語 を使用する。

デフォルトは en です。一致する言語オブジェクトがデータベースに存在していることが必要です。

参考

言語の定義、原文の言語

DEFAULT_MERGE_STYLE

新しいコンポーネントには マージ スタイル を使用する。

  • rebase - デフォルト

  • merge

参考

コンポーネント構成、マージ スタイル

DEFAULT_SHARED_TM

共有翻訳メモリの使用 および 共有翻訳メモリに貢献する のデフォルト値を設定します。

DEFAULT_TRANSLATION_PROPAGATION

翻訳の反映のデフォルト設定は True です。

参考

コンポーネント構成、翻訳の自動反映の有効化

DEFAULT_PULL_MESSAGE

プル リクエストのデフォルトのタイトルとメッセージの設定。

ENABLE_AVATARS

ユーザーに対して Gravatar - ベースのアバターを有効化するかどうか。デフォルトでは有効。

アバターはサーバー上で取得およびキャッシュされ、個人情報が漏洩するリスクが低くなり、ユーザー体験が高速化します。

参考

アバターのキャッシュ、AVATAR_URL_PREFIX、アバター

ENABLE_HOOKS

匿名リモート フックを有効にするかどうか。

参考

通知フック

ENABLE_HTTPS

Weblate へのリンクを HTTPS または HTTP として送信するかどうか。この設定は、送信したメールおよび生成した絶対 URL に影響します。

デフォルトの設定では、これは HTTPS に関連する複数の Django 設定にも使用されます - セキュアな Cookie を有効にしたり、HSTS を切り替えたり、HTTPS URL へのリダイレクションを有効にしたりします。

HTTPS リダイレクトには問題が発生することがあります。また、Django にプロトコル ヘッダーを正しく渡さない SSL 終了を行うリバース プロキシを使用している場合は、無限リダイレクトの問題が発生することがあります。X-Forwarded-Proto または Forwarded ヘッダーを出力するようにリバース プロキシを設定するか、Django が SSL ステータスを正しく検出できるように SECURE_PROXY_SSL_HEADER を設定してください。

参考

SESSION_COOKIE_SECURE、CSRF_COOKIE_SECURE、SECURE_SSL_REDIRECT、SECURE_PROXY_SSL_HEADER サイトの正確なドメイン設定

ENABLE_SHARING

ユーザーが翻訳の進捗状況をソーシャル ネットワーク上で共有できるように、共有 メニューの on/off を切り替えます。

EXTRA_HTML_HEAD

Added in version 4.15.

HTML ヘッダーに追加のマークアップを挿入します。サイトの所有権の確認に使用できます。例:

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

警告

文字列に対してサニタイズを実行せずに、そのまま HTML ヘッダーに挿入されます。

GET_HELP_URL

Added in version 4.5.2.

Weblate インスタンスのサポートを見つけられる URL。

GITEA_CREDENTIALS

Added in version 4.12.

Gitea サーバーの資格情報の一覧。

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

設定辞書には、各 API ホストに対して定義された認証情報が含まれています。 レイアウトはほぼすべてのバージョン管理統合で同じす。バージョン コントロール リポジトリの管理 に解説があります。

参考

Gitea プルリクエスト、Creating a Gitea personal access token

GITLAB_CREDENTIALS

Added in version 4.3.

GitLab サーバーの資格情報の一覧。

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

設定辞書には、各 API ホストに対して定義された認証情報が含まれています。 レイアウトはほぼすべてのバージョン管理統合で同じす。バージョン コントロール リポジトリの管理 に解説があります。

参考

GitLab マージリクエスト、GitLab: Personal access token

GITHUB_CREDENTIALS

Added in version 4.3.

GitHub サーバーの資格情報の一覧。

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

ヒント

Https://github.com/ の API ホストとして api.github.com を使用します。

設定辞書には、各 API ホストに対して定義された認証情報が含まれています。 レイアウトはほぼすべてのバージョン管理統合で同じす。バージョン コントロール リポジトリの管理 に解説があります。

参考

GitHub プルリクエスト、個人アクセス トークンを使用する

BITBUCKETSERVER_CREDENTIALS

Added in version 4.16.

Bitbucket サーバーの資格情報の一覧。

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

設定辞書には、各 API ホストに対して定義された認証情報が含まれています。 レイアウトはほぼすべてのバージョン管理統合で同じす。バージョン コントロール リポジトリの管理 に解説があります。

参考

Bitbucket Server プルリクエスト、Bitbucket: HTTP アクセス トークン

AZURE_DEVOPS_CREDENTIALS

Added in version 5.2.

Azure DevOps サーバーの資格情報の一覧です。

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

設定辞書には、各 API ホストに対して定義された認証情報が含まれています。 API ホストは Web ブラウザで使用するものとは異なる場合があります。たとえば、GitHub API は api.github.com としてアクセスされます。

各ホストで使用可能な設定:

username

Azure DevOps プロジェクトの名前。これはリポジトリ名ではありません。

organization

プロジェクトの組織名。

workItemIds

組織からの作業項目 ID のオプションの一覧。新しいプル リクエストが提供されると、これが添付されます。

token

API ユーザーの API トークン（必須）。

ここに書かれていない追加設定は、バージョン コントロール リポジトリの管理 にあります。

参考

Azure DevOps プル リクエスト、Azure DevOps: 個人アクセス トークン

GOOGLE_ANALYTICS_ID

Google アナリティクス ID を使用して Weblate の監視を有効にします。

HIDE_REPO_CREDENTIALS

Web インターフェイスのリポジトリの認証情報を非表示にします。リポジトリの URL にユーザーとパスワードが設定されている場合、関連情報をユーザーに表示するときには、Weblate がその URL を非表示にします。

例えば https://user:password@git.example.com/repo.git の代わりに https://git.example.com/repo.git` を表示します。VCS のエラーメッセージも同様の方法で消去を試します。

注釈

デフォルトで有効。

HIDE_VERSION

Added in version 4.3.1.

未認証のユーザーにはバージョン情報は表示されません。また、これにより、すべてのドキュメント リンクは、現在インストールされているバージョンに一致するドキュメントではなく、最新バージョンを参照します。

一部の企業ではバージョンの非表示が推奨されていますが、攻撃者が動作を調査してバージョンを特定することを阻止できません。

注釈

デフォルトで無効です。

INTERLEDGER_PAYMENT_POINTERS

Added in version 4.12.1.

Web 収益化のための元帳支払ポインタ（ILP）のリスト。

複数を指定した場合、1 つをランダムに選択して確率的な収益分配を実現します。

詳細は、<https://webmonetization.org/> を確認してください。

ヒント

デフォルトでは、ユーザーは Weblate 自体に資金を提供します。

IP_BEHIND_REVERSE_PROXY

Weblate がリバース プロキシの背後で動作しているかどうかを示します。

True に設定されている場合、Weblate は IP_PROXY_HEADER で定義したヘッダーから IP アドレスを取得します。

警告

リバース プロキシを実際に使用していること、およびリバース プロキシがこのヘッダーを設定していることを確認します。リバース プロキシを使用していない場合、ユーザーは IP アドレスを偽装できます。

注釈

これはデフォルトで無効です。

参考

リバース プロキシの背後で実行、接続制限、IP_PROXY_HEADER、IP_PROXY_OFFSET

IP_PROXY_HEADER

IP_BEHIND_REVERSE_PROXY が有効の場合、Weblate がどのヘッダーから IP アドレスを取得するかを示します。

デフォルトは HTTP_X_FORWARDED_FOR です。

参考

リバース プロキシの背後で実行、接続制限、SECURE_PROXY_SSL_HEADER、IP_BEHIND_REVERSE_PROXY、IP_PROXY_OFFSET

IP_PROXY_OFFSET

バージョン 5.0.1 で変更: デフォルトは 1 から -1 に変更されました。

クライアントの IP アドレスとして IP_PROXY_HEADER のどの部分が使用されているかを示します。

設定により、このヘッダーが複数の IP アドレス（例: X-Forwarded-For: client-ip, proxy-a, proxy-b）で構成されることがあります。ここで、ヘッダーのどのアドレスをクライアント IP アドレスとして使用するかどうかを設定できます。

警告

これを設定すると、インストールのセキュリティに影響します。IP アドレスの決定に信頼できるプロキシを使用するように設定するだけです。詳細については、<https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#security_and_privacy_concerns> を確認してください。

デフォルトは -1 です。

参考

リバース プロキシの背後で実行、接続制限、SECURE_PROXY_SSL_HEADER, IP_BEHIND_REVERSE_PROXY、IP_PROXY_HEADER

LICENSE_EXTRA

ライセンスの選択肢に含める追加ライセンス。

注釈

各ライセンス定義は、短い名前、長い名前、および URL のタプルであることが必要です。

例:

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

LICENSE_FILTER

バージョン 4.3 で変更: これを空の値に設定すると、ライセンス警告が無効になります。

ライセンス表示用のフィルターの一覧。空に設定した場合でもライセンス警告は無効になります。

注釈

このフィルターは、短いライセンス名を使用します。

例:

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

ライセンス警告を無効にする方法:

LICENSE_FILTER = set()

参考

翻訳コンポーネントの警告

LICENSE_REQUIRED

コンポーネント構成 のライセンス属性が必要かどうかを定義します。

注釈

デフォルトで無効です。

LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH

与えられた翻訳の長さを制限するかどうか。制限は、原文の文字列の長さ × 10 文字です。

ヒント

これを False に設定すると、原文の長さに関係なく、より長い翻訳（10,000 文字まで）が可能になります。

注釈

デフォルトは True です。

LOCALIZE_CDN_URL および LOCALIZE_CDN_PATH

これらの設定では JavaScript 現地語化 CDN アドオンを設定します。 LOCALIZE_CDN_URL は現地語化 CDN が利用可能なルート URL を定義し、LOCALIZE_CDN_PATH は LOCALIZE_CDN_URL で提供される生成ファイルを Weblate が保存するパスを定義します。

ヒント

Hosted Weblate では、https://weblate-cdn.com/ を使用します。

参考

JavaScript 現地語化 CDN

LOGIN_REQUIRED_URLS

サインインが必要な URL の一覧。（Weblate に標準設定済み以外の規則）。

ヒント

これにより、以下方法でインストール全体をパスワードで保護：

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

ヒント

上記の例に示すように、API 接続も隔離することが望ましいです。

参考

REQUIRE_LOGIN

LOGIN_REQUIRED_URLS_EXCEPTIONS

LOGIN_REQUIRED_URLS の例外リスト。指定しない場合、ユーザーはサイン イン ページにアクセスできます。

See the 設定例 for recommended configuration of this setting.

MATOMO_SITE_ID

Weblat サイトを解析する Matomo（旧 Piwik）内のサイト ID。

注釈

この連携は、Matomo タグ マネージャーに対応していません。

参考

MATOMO_URL

MATOMO_URL

Weblate の使用を追跡するために使用する Matomo（以前の Piwik）インストールの完全な URL（末尾のスラッシュを含む）。詳細は <https://matomo.org/> を確認してください。

ヒント

この連携は、Matomo タグ マネージャーに対応していません。

例:

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

参考

MATOMO_SITE_ID

NEARBY_MESSAGES

翻訳中に表示する「前後の文字列」の数。単なるデフォルト値であり、ユーザーは ユーザー情報 で数を変更できます。

DEFAULT_PAGE_LIMIT

Added in version 4.7.

ページネーション（ページ分割）が有効化されている場合の、デフォルトの表示数。

PAGURE_CREDENTIALS

Added in version 4.3.2.

Pagure サーバーの資格情報の一覧です。

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

設定辞書には、各 API ホストに対して定義された認証情報が含まれています。 レイアウトはほぼすべてのバージョン管理統合で同じす。バージョン コントロール リポジトリの管理 に解説があります。

参考

Pagure マージリクエスト、Pagure API

PRIVACY_URL

Added in version 4.8.1.

Weblate インスタンスのプライバシー ポリシーを表示する URL。

ヒント

Weblate の外部で法的な文書をホスティングしている場合、Weblate の内部に埋め込むのに便利です。詳細は 法的文書 を確認してください。

例:

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

参考

LEGAL_URL

PRIVATE_COMMIT_EMAIL_OPT_IN

Added in version 4.15.

ユーザーごとのコミット用の匿名メールアドレスを使用するかどうかの初期値を設定します。デフォルトはオプトイン（選択したユーザーのみ使用する）です。

ヒント

この設定は、コミット用メールアドレスが未設定のユーザーにのみ適用されます。

参考

ユーザー情報、PRIVATE_COMMIT_EMAIL_TEMPLATE

PRIVATE_COMMIT_EMAIL_TEMPLATE

Added in version 4.15.

ユーザーごとのコミット用の匿名メールアドレスを生成するためのテンプレート。デフォルトは、"{username}@users.noreply.{site_domain}"。

無効にするには、空の文字列に設定します。

注釈

PRIVATE_COMMIT_EMAIL_OPT_IN で設定していない限り、コミット用の匿名メールアドレスは各ユーザーが選択しないと使用されません。ユーザーは ユーザー情報 画面で、コミット用の匿名メールアドレスを使用するかどうかを設定できます。

PROJECT_BACKUP_KEEP_COUNT

Added in version 4.14.

プロジェクトごとにサーバーに保存するバックアップの数を定義します。デフォルトは 3 つです。

参考

プロジェクト レベルのバックアップ

PROJECT_BACKUP_KEEP_DAYS

Added in version 4.14.

プロジェクトのバックアップがサーバーに保存される期間を定義します。デフォルトは 30 日です。

参考

プロジェクト レベルのバックアップ

PROJECT_NAME_RESTRICT_RE

Added in version 4.15.

プロジェクトの命名を制限する正規表現を設定します。一致する名前はすべて拒否されます。

参考

プロジェクト名

PROJECT_WEB_RESTRICT_HOST

Added in version 4.16.2.

プロジェクトの Web サイトを、指定したホストで使用禁止にします。すべてのサブドメインを照合するので、example.com が含まれていれば test.example.com も使用禁止となります。ドメインは、照合する前に小文字に変換されて照合されるので、リストは小文字の文字列でのみ記述してください。

デフォルト設定:

PROJECT_WEB_RESTRICT_HOST = {"localhost"}

参考

プロジェクトの Web サイト PROJECT_WEB_RESTRICT_NUMERIC、PROJECT_WEB_RESTRICT_RE、

PROJECT_WEB_RESTRICT_NUMERIC

Added in version 4.16.2.

プロジェクトの Web サイトで、数値の IP アドレスの使用を使用禁止にします。デフォルトでは有効。

参考

プロジェクトの Web サイト PROJECT_WEB_RESTRICT_HOST、PROJECT_WEB_RESTRICT_RE、

PROJECT_WEB_RESTRICT_RE

Added in version 4.15.

プロジェクトの Web サイトを制限する正規表現を設定します。一致する URL はすべて拒否されます。

参考

プロジェクトの Web サイト PROJECT_WEB_RESTRICT_HOST、PROJECT_WEB_RESTRICT_NUMERIC

RATELIMIT_ATTEMPTS

接続制限が適用されるまでの認証試行の最大回数。

デフォルトは 5 回です。

参考

接続制限、RATELIMIT_WINDOW、RATELIMIT_LOCKOUT

RATELIMIT_WINDOW

接続制限が適用された後に認証を受け入れる秒数。

秒数、デフォルトは 300 秒（5 分）です。

参考

接続制限、RATELIMIT_ATTEMPTS、RATELIMIT_LOCKOUT

RATELIMIT_LOCKOUT

接続制限が適用された後に認証が遮断される秒数。

デフォルトは 600 秒（10 分）です。

参考

接続制限、RATELIMIT_ATTEMPTS、RATELIMIT_WINDOW

REGISTRATION_ALLOW_BACKENDS

Added in version 4.1.

登録を許可する認証バックエンドの一覧。これは新しい登録のみを制限し、ユーザーは設定済みのすべての認証バックエンドを使用して認証を行い、認証を追加できます。

登録バックエンドを制限しながら REGISTRATION_OPEN を有効にしておくことを推奨しますが、それ以外の場合、ユーザーは登録できるが、Weblate ではユーザー インターフェイスに登録するためのリンクは表示されません。

例:

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

ヒント

バックエンド名は、認証用の URL で使用する名前と一致させます。

参考

REGISTRATION_OPEN、認証

REGISTRATION_CAPTCHA

新しいアカウントの登録が CAPTCHA によって保護されるかどうか。デフォルトでは有効。

有効にすると、ユーザーがメール アドレスを入力して CAPTCHA が追加されるすべてのページ：

  • 新規アカウント登録。

  • パスワードの回復。

  • アカウントへのメールアドレスの追加。

  • サイン インしていないユーザーへの問い合わせフォーム。

REGISTRATION_EMAIL_MATCH

登録できるメール アドレスをフィルター処理できます。

デフォルトは .*、どのようなメールアドレスでも登録できます。

登録を単一のメール アドレスドメインに制限する方法：

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

REGISTRATION_OPEN

現在、新規アカウントの登録を許可しているかどうか。デフォルトでは有効。

この設定はメールアドレスによる組み込みの認証や Python Social Auth による認証に影響します（REGISTRATION_ALLOW_BACKENDS で特定のバックエンドをホワイトリストに登録できます）。

注釈

LDAP 認証 などのサード パーティ認証方法を使用している場合、登録フォームは非表示になりますが、新しいユーザーがサイン インしてアカウントを作成できることがあります。

参考

REGISTRATION_ALLOW_BACKENDS、REGISTRATION_EMAIL_MATCH、認証

REGISTRATION_REBIND

Added in version 4.16.

既存のユーザの認証バックエンドの再バインドを許可します。認証プロバイダー間の移行時は有効にしてください。

注釈

デフォルトでは無効であるため、既存のアカウントに他の認証バックエンドは追加できません。再バインドは、複数のサードパーティ認証バックエンドを使用すると、アカウントの侵害につながる恐れがあります。

REPOSITORY_ALERT_THRESHOLD

Added in version 4.0.2.

古くなったリポジトリや、変更が多すぎるリポジトリに対して警告を出すためのしきい値。デフォルトは 25 です。

参考

翻訳コンポーネントの警告

REQUIRE_LOGIN

Added in version 4.1.

これにより LOGIN_REQUIRED_URLS が有効になり、REST フレームワークがすべての API エンドポイントに対して認証を要求するように設定されます。

注釈

これは 設定例 に実装されています。Docker の場合は WEBLATE_REQUIRE_LOGIN を使用します。

SENTRY_DSN

エラーレポートの収集とパフォーマンスの監視 に使用する Sentry DSN。

参考

Sentry の Django 連携

SENTRY_ENVIRONMENT

Sentry の環境を設定します。デフォルトは devel。

SENTRY_PROFILES_SAMPLE_RATE

パフォーマンス監視用のサンプリング レートを設定します。すべてのイベントをトレースするには 1 に設定し、トレースを無効にするには 0（デフォルト）に設定します。

参考

Sentry パフォーマンス監視

SENTRY_SEND_PII

Sentry が特定の個人情報を収集することを許可します。デフォルトは有効。

SENTRY_TRACES_SAMPLE_RATE

プロファイリング監視用のサンプリング レートを設定します。すべてのイベントをトレースするには 1 に設定し、トレースを無効にするには 0（デフォルト）に設定します。

参考

Sentry プロファイリング

SIMPLIFY_LANGUAGES

デフォルトの「言語_国名」の組み合わせには単純な言語コードを使用します。例えば fr_FR の翻訳には fr の言語コードを使用します。通常は、デフォルトの組み合わせの言語の一覧を簡素化するための理想的な方法です。

国や地域ごとに異なる翻訳を行う場合は、この機能を無効にします。

SITE_DOMAIN

サイト ドメインを設定します。これは、多くの範囲（例: アクティベーション メールアドレス、通知、RSS フィード）で正しい絶対リンクを生成するために必要です。

Weblate を非標準ポートで実行している場合は、ここにも含めてください。

例:

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

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

注釈

この設定には、ドメイン名だけを含めてください。プロトコルの設定（HTTPS の有効化と強制）には ENABLE_HTTPS を使用し、URL の変更には URL_PREFIX を使用します。

ヒント

Docker コンテナ上では、サイト ドメインは WEBLATE_ALLOWED_HOSTS で設定します。

参考

サイトの正確なドメイン設定、許可するホストの登録、HTTPS の正しい設定 WEBLATE_SITE_DOMAIN、ENABLE_HTTPS

SITE_TITLE

Web サイトおよびメール送信に使用するサイト名。

SPECIAL_CHARS

ビジュアル キーボードに含める追加の文字、ビジュアル キーボード。

デフォルト値：

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

SINGLE_PROJECT

ダッシュボードを表示する代わりに、プロジェクトまたはコンポーネントにユーザーを直接リダイレクトします。True に設定できるが、この場合は、実際に Weblate にプロジェクトが 1 つしか存在していない場合にのみ機能します。または、プロジェクトのスラッグを設定すると、このプロジェクトに無条件にリダイレクトされます。

例:

SINGLE_PROJECT = "test"

SSH_EXTRA_ARGS

Added in version 4.9.

Weblate が SSH 接続するときに、カスタム パラメータを追加できるようにします。これは、従来の暗号化またはその他の非標準機能を使用してサーバーに接続する場合に便利です。

例えば、Weblate が SSH 接続を試みて、Unable to negotiate with legacyhost: no matching key exchange method found. Their offer: diffie-hellman-group1-sha1 と警告が出て失敗した場合の対処方法:

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

ヒント

文字列はシェルによって評価されるので、空白や特殊文字は必ず引用符で囲んでください。

参考

OpenSSH 古い非推奨オプション

STATUS_URL

Weblate インスタンスが状況を報告する URL。

SUGGESTION_CLEANUP_DAYS

指定された日数が経過すると、提案が自動的に削除されます。デフォルトは None で、削除しないことを意味します。

SUPPORT_STATUS_CHECK

Added in version 5.5.

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

ヒント

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

UNUSED_ALERT_DAYS

Added in version 4.17.

コンポーネントが使用されていない 警告を起動するタイミングを設定します。

デフォルトは 365 日で、無効にするには 0 に設定します。

UPDATE_LANGUAGES

Added in version 4.3.2.

データベースを移行する場合、言語データベースを更新するかどうかを判断します。デフォルトは有効。この設定は setuplang の呼び出しには影響しません。

警告

これにより、言語の表示が一貫性を欠くことがあります。Weblate 言語の定義は時間の経過とともに拡張され、定義された言語の言語コードは表示されなくなります。

参考

組み込み言語の定義

URL_PREFIX

この設定では、Weblate を指定したパスで実行できます（そうでない場合は、Weblate サーバーのルートからの実行に依存します）。

注釈

この設定を使用するには、この接頭辞を取り除くようにサーバーを設定することが必要です。例えば WSGI では、WSGIScriptAlias を設定すれば可能です。

ヒント

接頭辞は / で開始してください。

例:

URL_PREFIX = "/translations"

注釈

この設定は Django の内蔵サーバーでは動作しません。urls.py を設定して接頭辞を含めることが必要です。

VCS_API_DELAY

Added in version 4.15.1.

GitHub プルリクエスト、GitLab マージリクエスト、Gitea プルリクエスト、Pagure マージリクエスト、Azure DevOps プル リクエスト で、サードパーティ API 呼び出し間の最小遅延を秒単位で設定します。

これにより、Weblate からサービスへの API コールが過負荷にならないようにレート制限します。

GitHub でセカンダリの接続制限により制限を受けている場合は、これを増やすとよいでしょう。

デフォルト値は 10 です。

VCS_BACKENDS

使用可能な VCS バックエンドの設定。

注釈

Weblate は、対応しているすべてのバックエンドの使用を試します。

ヒント

これを使用して、選択を制限したり、カスタム VCS バックエンドを追加できます。

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

参考

バージョン管理との連携

VCS_CLONE_DEPTH

Weblate がリポジトリをディープ クローンする深さを設定します。

注釈

現在のところ、これは Git でのみ対応しています。デフォルトでは、Weblate はリポジトリの浅いクローンを作成します。使い方によっては（例: カスタムの アドオン を使用している場合など）、この値を 0 に設定して浅いクローンを完全に無効にしたり、深さを増やすこともできます。

ヒント

Weblate からプッシュするときに fatal: protocol error: expected old/new/ref, got 'shallow <commit hash>' エラーが発生した場合は、以下を設定して浅いクローンを完全に無効にします。

VCS_CLONE_DEPTH = 0

WEBLATE_ADDONS

使用可能なアドオンの一覧。これらを使用するには、対象の翻訳コンポーネントで有効にする必要があります。デフォルトでは付属のアドオンをすべて含んでいますが、既存のものを保ったままアドオンを追加するには次のようにします。

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

注釈

一覧からアドオンを削除しても、コンポーネントからはアンインストールされません。その場合、Weblate はクラッシュします。この一覧から削除する前に、すべてのコンポーネントからアドオンをアンインストールしてください。

参考

アドオン、DEFAULT_ADDONS

WEBLATE_EXPORTERS

Added in version 4.2.

翻訳や用語集をさまざまなファイル形式でダウンロードできるエクスポートの一覧です。

参考

対応するファイル形式

WEBLATE_FORMATS

使用可能なファイル形式の一覧。

注釈

デフォルトの一覧には、すでに一般的な形式があります。

参考

対応するファイル形式

WEBLATE_MACHINERY

Added in version 4.13.

使用可能な機械翻訳サービスの一覧。

参考

自動提案

WEBLATE_GPG_IDENTITY

Weblate が Git コミットに署名するために使用する ID。設定例:

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

Weblate GPG キーリングは、一致するキーを探します（DATA_DIR の下で home/.gnupg）。見つからない場合は鍵が生成されます、詳細は GnuPG を使用した Git コミットの署名 を確認してください。

参考

GnuPG を使用した Git コミットの署名

WEBSITE_REQUIRED

プロジェクトの作成時に、プロジェクトの Web サイト の指定を必須とするかしないかを設定します。公開サーバには適しているので初期設定では、デフォルトで有効です。

バージョン コントロール リポジトリの管理

ヒント

このセクションでは、 GITHUB_CREDENTIALS、GITLAB_CREDENTIALS、GITEA_CREDENTIALS、PAGURE_CREDENTIALS、BITBUCKETSERVER_CREDENTIALS の VCS 資格情報変数について解説します。

設定辞書には、各 API ホストに対して定義された認証情報が含まれています。 API ホストは Web ブラウザで使用するものとは異なる場合があります。たとえば、GitHub API は api.github.com としてアクセスされます。

各ホストで使用可能な設定:

username

API ユーザー、必須。

token

API ユーザーの API トークン（必須）。

scheme

Added in version 4.18.

スキームの上書き。Weblate はリポジトリの URL からスキームを解析しようとしますが、デフォルトでは https にフォールバックします。もし API サーバーを内部で実行している場合、代わりに http を使用できますが、セキュリティに考慮してください。

ヒント

Docker コンテナでは、資格情報を環境変数を使用して設定します。参照: サイトの資格情報をホストするコード。