Wikiの設定

GitLabインスタンスのWiki設定を調整します。

Wiki ページのコンテンツサイズ制限

GitLab 13.2 で導入されました。

Wiki ページのコンテンツサイズの上限を設定することができます。この制限により、機能の悪用を防ぐことができます。デフォルト値は52428800バイト(50MB)です。

どのように動作しますか？

WikiページがGitLab UIまたはAPIを通して作成または更新されたとき、コンテンツサイズの制限が適用されます。Git経由でプッシュされたローカルの変更は検証されません。

既存の Wiki ページを破壊するために、Wiki ページが再び編集され、コンテンツが変更されるまで制限は適用されません。

Wikiページのコンテンツサイズ制限設定

この設定は管理エリアの設定では利用できません。この設定を行うには、RailsコンソールまたはApplication settings APIを使用してください。

note
制限値の単位はバイトでなければなりません。最小値は1024バイトです。

Rails コンソールから

Railsコンソールからこの設定を行うには、以下の手順に従います：

  1. Railsコンソールを起動します：

    # For Omnibus installations
sudo gitlab-rails console
   
# For installations from source
sudo -u git -H bundle exec rails console -e production

  2. Wikiページの最大コンテンツサイズを更新します：

    ApplicationSetting.first.update!(wiki_page_max_content_bytes: 50.megabytes)

現在の値を取得するには、Railsコンソールを起動して実行します：

Gitlab::CurrentSettings.wiki_page_max_content_bytes

APIを通じて

Application Settings APIを通してWikiページのサイズ制限を設定するには、他の設定を更新するのと同じようにコマンドを使用します：

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/settings?wiki_page_max_content_bytes=52428800"

APIを使用して現在の値を取得することもできます：

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/settings"

Wiki リポジトリのサイズを減らす

Wikiはネームスペースのストレージサイズの一部としてカウントされるので、Wikiリポジトリを可能な限りコンパクトに保つべきです。

リポジトリをコンパクトにするツールの詳細については、リポジトリサイズの縮小に関するドキュメントを読んでください。

AsciiDoc の URI インクルードを許可

GitLab 16.1 で導入されました。

Include ディレクティブは別ページや外部 URL からコンテンツをインポートし、現在のドキュメントのコンテンツの一部として表示します。AsciiDocのインクルードを有効にするには、RailsコンソールまたはAPIからこの機能を有効にします。

Rails コンソールから

Railsコンソールからこの設定を行うには、以下の手順に従います：

  1. Railsコンソールを起動します：

    # For Omnibus installations
sudo gitlab-rails console
   
# For installations from source
sudo -u git -H bundle exec rails console -e production

  2. AsciiDocのURIインクルードを許可するようにWikiを更新します：

    ApplicationSetting.first.update!(wiki_asciidoc_allow_uri_includes: true)

includeが有効になっているかどうかを確認するには、Railsコンソールを起動して実行します：

Gitlab::CurrentSettings.wiki_asciidoc_allow_uri_includes

APIを通じて

アプリケーション設定APIを通してAsciiDocのURIインクルードを許可するようにWikiを設定するには、curl ：

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  "https://gitlab.example.com/api/v4/application/settings?wiki_asciidoc_allow_uri_includes=true"