bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Started blogpost and changes for v21.11 release

Browse source
This commit is contained in:
Dan Brown 2021-11-15 15:11:39 +00:00
commit 5ead9d4f82
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
4 changed files with 120 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

14
content/docs/admin/updates.md
View file

@ -38,6 +38,20 @@ Details of updates can be found on [our blog](https://www.bookstackapp.com/blog/
the [GitHub releases page](https://github.com/BookStackApp/BookStack/releases).
#### Updating to v21.11 or higher
**API Changes** - As of v21.11 any dates in API responses will be formatted as per ISO-8601, with `2019-12-02T20:01:00.283041Z` reflecting an example of this format. You may need to review any of your scripts that utilise dates from API responses.
**Upload Limit** - System file upload limits are now configured using a `FILE_UPLOAD_SIZE_LIMIT` option in your
`.env` file. This value is specified as an integer and represents the max upload size in MegaBytes. This defaults to 50MB. This replaces the old `window.uploadLimit` header option that could be set.
**Search Index Changes** - Changes to search indexing and scoring changes were made in this release.
It's recommended to run `php artisan bookstack:regenerate-search` to ensure a consistent search experience and take
advantage of these changes.
**Logout Endpoints** - Logout endpoints have now changed to be CSRF protected POST endpoints instead of GET endpoints. If you were using these for any external purposes you may now need to implement an alternative workflow.
#### Updating to v21.10.3 or higher
**Security** - v21.10.3 looks to address a couple of vulnerabilities within the attachment and image

28
content/docs/admin/upload-config.md
View file

@ -10,7 +10,6 @@ BookStack allows users to upload both images for content and files as attachment
* [Storage Options](#storage-options)
* [Changing Upload Limits](#changing-upload-limits)
* [File Upload Timeout](#file-upload-timeout)
* [File Upload Limit](#file-upload-limit)
**For information relating to security for file uploads please refer to the [Security Page](/docs/admin/security).**
@ -117,7 +116,18 @@ STORAGE_ATTACHMENT_TYPE=local_secure
### Changing Upload Limits
By default, a lot of server software has strict limits on upload sizes which causes errors when users upload new content. This is not configured as part of BookStack but as part of PHP and your web sever software. If you run into problems with upload size limits follow the below details for PHP and whichever web server you use:
By default, a lot of server software has strict limits on upload sizes which causes errors when users upload new content. BookStack enforces its own limit but there may also be limits configured as part of PHP and your web sever software. If you run into problems with upload size limits follow the below details for BookStack, PHP and whichever web server you use.
#### BookStack
The upload limit in BookStack is configured through an option in your `.env` file.
Find or add the follow option then configure to your requirements.
```bash
# File Upload Limit
# Maximum file size, in megabytes, that can be uploaded to the system.
FILE_UPLOAD_SIZE_LIMIT=50
```
#### PHP
@ -182,17 +192,3 @@ To modify this timeout, in BookStack settings, Find the 'Custom HTML head conten
window.uploadTimeout = 120 * 1000;
</script>
```
---
### File Upload Limit
File uploads in BookStack use a JavaScript library which has a default upload size limit of 256MB. To modify this timeout, in BookStack settings, Find the 'Custom HTML head content' setting and add the below code. Note that this does not change any server-side upload limits, Your websever may still impose an upload limit.
```html
<script>
// Set the file upload limit to 1.5GB.
// The value is defined in MB.
window.uploadLimit = 1500;
</script>
```