Wiki 设置

调整极狐GitLab 实例的 wiki 设置。

Wiki 页面内容大小限制#

你可以为 wiki 页面设置最大内容大小限制。这个限制可以防止滥用该功能。默认值为 52428800 字节（50 MB）。

它如何工作？#

当通过极狐GitLab UI 或 API 创建或更新 wiki 页面时，将应用内容大小限制。通过 Git 推送的本地更改不会被验证。

为了不破坏任何现有的 wiki 页面，限制在 wiki 页面再次编辑并内容更改时才会生效。

Wiki 页面内容大小限制配置#

此设置不能通过 管理员 区域设置 来使用。要配置此设置，请使用 Rails 控制台或 应用程序设置 API。

通过 Rails 控制台#

要通过 Rails 控制台配置此设置：

1. 启动 Rails 控制台：

   shell
   # 对于 Omnibus 安装
   sudo gitlab-rails console
   
   # 对于从源代码安装
   sudo -u git -H bundle exec rails console -e production

2. 更新 wiki 页面最大内容大小：

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

要检索当前值，请启动 Rails 控制台并运行：

ruby
Gitlab::CurrentSettings.wiki_page_max_content_bytes

通过 API#

要通过应用程序设置 API 设置 wiki 页面大小限制，可以使用命令，像 更新任何其他设置 一样：

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

你还可以使用 API 来 检索当前值：

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

减少 wiki 存储库大小#

wiki 计入 命名空间存储大小 的一部分，因此你应该尽可能地保持 wiki 存储库紧凑。

有关压缩存储库工具的更多信息，请阅读有关 减少存储库大小 的文档。

允许 AsciiDoc 的 URI 包含#

包含指令从单独的页面或外部 URL 导入内容，并将其显示为当前文档内容的一部分。要启用 AsciiDoc 包含，请通过 Rails 控制台或 API 启用该功能。

通过 Rails 控制台#

要通过 Rails 控制台配置此设置：

1. 启动 Rails 控制台：

   shell
   # 对于 Omnibus 安装
   sudo gitlab-rails console
   
   # 对于从源代码安装
   sudo -u git -H bundle exec rails console -e production

2. 更新 wiki 以允许 AsciiDoc 的 URI 包含：

   ruby
   ApplicationSetting.first.update!(wiki_asciidoc_allow_uri_includes: true)

要检查是否启用了包含功能，请启动 Rails 控制台并运行：

ruby
Gitlab::CurrentSettings.wiki_asciidoc_allow_uri_includes

通过 API#

要通过 应用程序设置 API 设置 wiki 允许 AsciiDoc 的 URI 包含，可以使用 curl 命令：

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

相关主题#

1. 用户 wiki 文档
2. 项目 wiki API
3. 群组 wiki API