BookStack v24.05

Links

• Release video overview
• Update instructions
• Update details on blog

Upgrade Notices

• PHP Version Requirement Change - The minimum supported PHP version has changed from PHP 8.0.2 to PHP 8.1 in this release. Please see our "Updating PHP & Composer" documentation page for guidance on updating PHP.
• Composer Version Requirement Change - The minimum supported composer version has changed from v2.0 to v2.2 in this release. Please see our "Updating PHP & Composer" documentation page for guidance on updating Composer.
• Page Content - Text links in page content will now be underlined by default for accessibility. Refer to the release blogpost for an simple customization to override & revert this if desired.
• PDF Exports - The WKHTMLTOPDF option is now considered deprecated, with the alternative being the newly added EXPORT_PDF_COMMAND which is detailed in our documentation here. The WKHTMLTOPDF option will though remain supported for a number of feature releases though to avoid unexpected breaking changes.
• OIDC Authentication - The OIDC "userinfo" endpoint may now be called in very rare scenarios where not all expected claims were being properly provided in the user ID Token, which could alter the details used for new users on access, and the groups obtained for user group/role sync, but only in edge case scenarios where functionality was not matching configuration before the update.
• LDAP Authentication - The LDAP_USER_FILTER BookStack option now uses {user} as a placeholder instead of ${user} by default. The older ${user} placeholder format is still supported but you may want to use the new format instead. This should not cause any issues on existing instances, unless {user} was used as a literal part of your user filter which would be very unlikely.

Full List of Changes

• Added new command-based PDF export option. (#4969, #4732)
• Added Audit Log API list endpoint. (#4987, #4316)
• Added LDAP option to provide a custom CA cert. Thanks to @mmoore2012. (#4985, #4913)
• Added OIDC userinfo endpoint support. Thanks to @LukeShu. (#4955, #4726, #3873)
• Added simple registration form honeypot. Thanks to @nesges. (#4970)
• Added Scala to list of supported languages in code blocks. (#4953)
• Added licenses page supported by licenses list building process. (#4907)
• Updated app framework from Laravel 9 to 10. (#4903)
• Updated content links to be underlined by default for accessibility. (#4939)
• Updated dev Dockerfile with improvements. Thanks to @C0rn3j. (#4895)
• Updated included images with extra compression to save data. Thanks to @C0rn3j. (#4904)
• Updated JS build system to split markdown-focused packages to own file. (#4930, #4858)
• Updated LDAP user filter option to support new placeholder format. (#4967)
• Updated minimum required PHP version from 8.0 to 8.1. (#4894, #4893)
• Updated translations with latest Crowdin changes. (#4890)
• Fixed code direction in WYSWIYG editor lacking direction support in code editor. (#4943)
• Fixed difference of line-heights for paragraphs in tables between editor and page view. (#4960)
• Fixed extra space at the beginning of a translation. Thanks to @johnroyer. (#4972)
• Fixed failing drag and drop of attachments into editor on Chrome. (#4975)
• Fixed incorrect tag counts when tagged items are in the recycle bin. (#4892)
• Fixed WYSIWYG object embeds in the editor showing image toolbar button. (#4974)
• Fixed WYSIWYG table cell format handling which could clear styles unexpectedly. (#4964)

BookStack v24.02.3

Links

• Update instructions

Full List of Changes

This release contains the following fixes and changes:

• Fixed non-working "Open Link In..." option for description editors. (#4925)
• Fixed failed reference loading when references are from recycle bin items. (#4918)
• Fixed failed code block rendering when a code language was not set. (#4917)
• Updated page editor max content widths to align with page display. (#4916)

BookStack v24.02.2

Links

• Update instructions

Full List of Changes

This release contains the following fixes and changes:

• New version to address missed version and asset changes in v24.02.1. (#4889)

BookStack v24.02.1

Links

• Update instructions

Full List of Changes

This release contains the following fixes and changes:

• Updated translations with latest Crowdin changes. (#4877)
• Updated breadcrumb book & shelf lists to be name-ordered. (#4876)
• Updated MFA inputs to avoid auto-complete. Thanks to @ImMattic. (#4849)
• Fixed non-breaking spaces causing combined words in page navigation. (#4836)
• Fixed page navigation click not jumping to headers in nested collapsible blocks. (#4878)

BookStack v24.02

Links

• Release video overview
• Update instructions
• Update details on blog

Upgrade Notices

• Security - The v23.12 branch of BookStack recently had a security release, which you can find details of in our v23.12.3 blogpost.
• Comments - The ability to use markdown content in comments has been removed in this release, replaced by a WYSIWYG editor. Markdown in comments was a fairly hidden feature though so was not commonly utilised. Existing markdown comments will remain although formatting may be lost if old markdown comments are edited.
• Commands - The "Regenerate Comment Content" command has been removed in this release since this action is now redundant.
• OIDC Authentication - Proof Key for Code Exchange (PKCE) support has been added to BookStack OIDC authentication. This should not affect existing OIDC use but you may want to enforce PKCE to be required for BookStack on your authentication system, if supported, for extra security.

Full List of Changes

• Added simple WYSIWYG comment editor inputs. (#4815, #3018)
• Added default page templates for chapters. Thanks to @Man-in-Black. (#4750, #4764)
• Added PKCE support for OIDC. (#4804, #4734)
• Added "Clear table formatting" & "Resize to contents" WYSIWYG table options. (#4845)
• Added "Toggle header row" button to table toolbar in WYSWIYG editor. (#985)
• Added attachment serving range request support. (#4758, #3274)
• Added new AUTH_PRE_REGISTER logical theme event. (#4833)
• Updated app entity loading to be more efficient and avoid global addSelects. (#4827, #4823)
• Updated book/shelf cover image wording to make sizing in usage clearer. (#4748)
• Updated PWA manifest to allow landscape use. Thanks to @shashinma. (#4828)
• Updated redirect handling to reduce chance of redirecting to images. (#4863)
• Updated some EN text for consistency/readability. (#4794)
• Updated WYSIWYG editor with improved cell selection formatting clearing. (#4850)
• Updated WYSIWYG text direction & alignment controls to work more reliably on complex structures. (#4843)
• Fixed breadcrumb dropdowns being partially out of view on mobile screen sizes. (#4824)
• Fixed description WYSIWYG not respecting RTL text. (#4810)
• Fixed header bar collapse on smaller screen sizes when no name or logo is used. (#4841)
• Fixed incorrect pagination display in RTL layout. (#4808)
• Fixed JavaScript error logged on WYSIWYG editor load due to how custom styles were imported. (#4814)
• Fixed scrollbars showing on WYSIWYG table cell range selection in some browsers. (#4844)
• Fixed WYSIWYG code block text direction controls not being respected. (#4809)

BookStack v23.12.3

Security Release

• Update Instructions
• Update details on blog

BookStack v23.12.3 has been released.
This is a security release that addresses a vulnerability in PDF generation that could be exploited to perform blind server-side-request forgery.

Upgrade is advised where untrusted users have permission to create/edit/update page content in your instance.

Full List of Changes

• Updated PHP dependencies, primarily to update php-svg-lib package.

BookStack v23.12.2

Links

• Update instructions

Full List of Changes

This release contains the following fixes and changes:

• Fixed attachment list ctrl-click not opening attachments inline. (#4782)
• Updated translations with latest Crowdin changes. (#4779)
• Fixed entity selector popup pre-fill not searching term as expected. (#4778)

BookStack v23.12.1

Links

• Update instructions

Full List of Changes

This release contains the following fixes and changes:

• Fixed chapter API missing expected "book_slug" field. (#4765)
• Updated translations with latest Crowdin changes. (#4747)

BookStack v23.12

Links

• Release video overview
• Update instructions
• Update details on blog

Upgrade Notices

• Page Includes - The way page include content is fetched & merged has changed significantly in this release, which in some cases may alter how included content appears on the page.

Full List of Changes

• Added simple WYSIWYG for description fields. (#4729, #2354, #2203)
• Added default template option for books. Thanks to @lennertdaniels. (#4721, #3918, #1803)
• Added OIDC RP-initiated logout. Thanks to @joancyho. (#4714, #4467, #3715)
• Added new Logical Theme System event to register web routes. (#4663)
• Updated email notifications to include the page parent chapter/book. Thanks to @Man-in-Black. (#4629)
• Updated and standardised DOM handling in the codebase. (#4673)
• Updated back redirection handling to not rely on referrer headers. (#4656)
• Updated book/chapter/shelf description character limit. (#4085)
• Updated design of buttons to be a bit friendlier. (#4728)
• Updated HTML exporting with better RTL handling. (#4645)
• Updated include tag handling to be structure/DOM aware. (#4688)
• Updated SAML2 dump debug option to include group parsing details. (#4706)
• Updated translations with latest Crowdin changes. (#4658)
• Updated WYSIWYG editor to allow video/embed alignment controls. (#4727, #3378)
• Updated WYSIWYG library TinyMCE from 6.5.1 to 6.7.2. (#4661)
• Fixed extra paragraphs & invalid syntax when using page includes. (#3385)
• Fixed lack of user invite via the API in certain cases. (#4720)
• Fixed page includes leading to duplicate IDs. (#3982)
• Fixed permission generation failure with large amounts of content. (#4695)
• Fixed PHP mbstring deprecation warnings. (#4638)
• Fixed SAML2 Single Logout (SLO) not invalidating session at point defined by the spec. (#4713)

BookStack v23.10.4

This was simply a follow-up of v23.10.3 to fix the app version number.
Please refer to the v23.10.3 security release for details if updating from an earlier version.