89 lines
2.9 KiB
Markdown
89 lines
2.9 KiB
Markdown
---
|
|
type: reference, howto
|
|
stage: Create
|
|
group: Editor
|
|
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
|
---
|
|
|
|
# Wiki settings **(FREE SELF)**
|
|
|
|
Adjust the wiki settings of your GitLab instance.
|
|
|
|
## Wiki page content size limit
|
|
|
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31176) in GitLab 13.2.
|
|
|
|
You can set a maximum content size limit for wiki pages. This limit can prevent
|
|
abuse of the feature. The default value is **52428800 Bytes** (50 MB).
|
|
|
|
### How does it work?
|
|
|
|
The content size limit is applied when a wiki page is created or updated
|
|
through the GitLab UI or API. Local changes pushed via Git are not validated.
|
|
|
|
To break any existing wiki pages, the limit doesn't take effect until a wiki page
|
|
is edited again and the content changes.
|
|
|
|
### Wiki page content size limit configuration
|
|
|
|
This setting is not available through the [Admin Area settings](../../user/admin_area/settings/index.md).
|
|
To configure this setting, use either the Rails console
|
|
or the [Application settings API](../../api/settings.md).
|
|
|
|
NOTE:
|
|
The value of the limit must be in bytes. The minimum value is 1024 bytes.
|
|
|
|
#### Through the Rails console
|
|
|
|
To configure this setting through the Rails console:
|
|
|
|
1. Start the Rails console:
|
|
|
|
```shell
|
|
# For Omnibus installations
|
|
sudo gitlab-rails console
|
|
|
|
# For installations from source
|
|
sudo -u git -H bundle exec rails console -e production
|
|
```
|
|
|
|
1. Update the wiki page maximum content size:
|
|
|
|
```ruby
|
|
ApplicationSetting.first.update!(wiki_page_max_content_bytes: 50.megabytes)
|
|
```
|
|
|
|
To retrieve the current value, start the Rails console and run:
|
|
|
|
```ruby
|
|
Gitlab::CurrentSettings.wiki_page_max_content_bytes
|
|
```
|
|
|
|
#### Through the API
|
|
|
|
To set the wiki page size limit through the Application Settings API, use a command,
|
|
as you would to [update any other setting](../../api/settings.md#change-application-settings):
|
|
|
|
```shell
|
|
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/settings?wiki_page_max_content_bytes=52428800"
|
|
```
|
|
|
|
You can also use the API to [retrieve the current value](../../api/settings.md#get-current-application-settings):
|
|
|
|
```shell
|
|
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/settings"
|
|
```
|
|
|
|
### Reduce wiki repository size
|
|
|
|
The wiki counts as part of the [namespace storage size](../../user/admin_area/settings/account_and_limit_settings.md),
|
|
so you should keep your wiki repositories as compact as possible.
|
|
|
|
For more information about tools to compact repositories,
|
|
read the documentation on [reducing repository size](../../user/project/repository/reducing_the_repo_size_using_git.md).
|
|
|
|
## Related topics
|
|
|
|
- [User documentation for wikis](../../user/project/wiki/index.md)
|
|
- [Project wikis API](../../api/wikis.md)
|
|
- [Group wikis API](../../api/group_wikis.md)
|