README

English

ページの更新、画像の再アップロード時に Cloudflare のキャッシュをパージします (主に画像のキャッシュを消すことを目的としています)

MediaWiki で CloudFlare を使う – harugon のブログ

導入前に上記のページを読むことをおすすめします。

Requirements

PHP 8.0
MediaWiki 1.43

Install

Releases · harugon/mediawiki-extensions-cloudflare

上記の URL よりCloudflare-{バーション}.tar.gzのファイルをダウンロードし extensions に展開

LocalSettings.php に Cloudflare の API 情報とともに追記します。

wfLoadExtension('Cloudflare');
$wgCloudflareAPIToken = '';
$wgCloudflareZoneID = '';

推奨される認証方法は $wgCloudflareAPIToken です。API トークン - Cloudflare で "キャッシュのパージ" 権限を持つトークンを作成してください。

非推奨の $wgCloudflareEmail と $wgCloudflareAPIKey も引き続き使用できますが、将来のリリースで削除されます。

// 非推奨:
$wgCloudflareEmail = '';
$wgCloudflareAPIKey = '';

Config

変数	初期値	説明
$wgCloudflareAPIToken	""	API Token（ API トークン - Cloudflare で作成したキャッシュパージ権限付きトークン）
$wgCloudflareEmail	""	非推奨. レガシー認証用のメールアドレス。代わりに $wgCloudflareAPIToken を使用してください。
$wgCloudflareAPIKey	""	非推奨. レガシー認証用のグローバルAPIキー。代わりに $wgCloudflareAPIToken を使用してください。
$wgCloudflareZoneID	""	サイト（URL）固有の ID （サイトごとのダッシュボードで見ることができます）
$wgCloudflarePurgePage	false	記事を更新時に purge する
$wgCloudflarePurgeFile	true	ファイル（画像）を更新時に purge する

記事ページをキャッシュする

$wgCloudflarePurgePageを有効化する場合ページルール (Page Rule) に　Bypass Cache on Cookie　を設定する必要があります。 (BusinessプランとEnterpriseプランのみ有効です。)

この機能は推奨しません。Cloudflare は通常、MediaWiki の記事 HTML を既定ではキャッシュしません。記事ページを Cloudflare でキャッシュするには Cache Rules などで明示的にキャッシュ対象にする必要がありますが、その場合、MediaWiki が管理する CDN purge 経路の外で URL や cache key が増える可能性があります。

MediaWiki では同じ記事が短縮 URL、index.php?title=... 形式、モバイル表示、リダイレクト、クエリ文字列付き URL など複数の形式で配信されることがあります。この拡張は、それらの記事 URL を完全に列挙して purge することを保証できません。そのため、Cloudflare 側に古い記事キャッシュが残る可能性があります。

安定性を重視する場合は $wgCloudflarePurgePage を無効のままにし、Cloudflare での purge 対象はファイル（画像・サムネイル）に限定する構成を推奨します。記事ページのキャッシュは、MediaWiki の CDN purge 経路と親和性の高い Varnish などで扱うことをおすすめします。

問題

API Rate limits
Varnish を挟んでいる場合　‥（Cloudflare->Varnish->origin 先に Cloudflare が消える可能性がある？）

Disclaimer

Cloudflare, the Cloudflare logo, and Cloudflare Workers are trademarks and/or registered trademarks of Cloudflare, Inc. in the United States and other jurisdictions.

harugon / cloudflare

Maintainers

Package info

Statistics

Security