BookStack Release v22.04

Today brings the release of BookStack v22.04! This includes the much-awaited feature of easier page editor switching, in addition to a bunch of other additions and improvements.

Upgrade Notices

  • Database Changes - This release makes some significant changes to data within the database which may cause the update to take a little longer than usual to run. Please give the update extra time to complete.
  • REST API Page Create/Update Changes - Create & update page requests now have the potential to change the current editor type for that page, depending on the content type sent in the request, if the API user has permission to change the page editor.
  • URL Handling - The way we handle URLs has changed this release to hopefully address some issues in specific scenarios. These changes have been tested and should not affect existing working environments but there’s an increased risk this release for setups with more complex URL handling. Please raise an issue or jump into our Discord server if you have any issues with URLs after upgrading.

Switch Between WYSIWYG & Markdown While Editing

It’s now possible to switch between the WYSIWYG editor and Markdown editor while editing a page! This has been a much requested feature ever since we originally added the Markdown editor.

When editing a page you can use the central dropdown menu at the top which will provide editor switching options (If you have the required permission to do so). There are two options when changing from WYSIWYG to Markdown:

Preview of the editor top dropdown menu showing two ‘Switch to markdown editor’ options

These two options exist to offer different conversion handling of your page content:

  • Clean Content - This is a system-cleaned markdown output, which is much nicer but has potential for formatting loss and potential functionality breaks (Things depending on HTML attributes/IDs for example).
  • Stable Content - This retains existing HTML content in Markdown to avoid any potential functionality breakages or loss of formatting. This is similar to switching the global option now then re-opening a page for edit.

When you chose to change editor, a modal warning will show to emphasise the potential side-affects of changing the content. The current page being edited will be saved as a draft at this stage. Choosing to continue will then reload the page with the new chosen editor. The editor used is essentially saved against the page itself, to prevent un-intentional conversion of page content.

View of modal window explaining warnings to consider when changing editor

We realise that this functionality may not be desirable in all environments, so a new “Change page editor” role permission now exists to control who has the ability to change the editor for a page. This will be provided only to the default “Admin” role upon upgrade.

The old “Page Editor” customization setting is now used to define the default system page editor option, primarily used for new pages.

A view of the system editor option, now re-labelled as default editor

Keep in mind that users, without the “Change page editor” permission, may still see an editor that’s not configured as the system default if it has been changed by a user with permission.

Recycle Bin API Endpoints

The rollout of additional API endpoints continues, with this release adding API endpoints for the recycle bin:

Screenshot of recycle bin API endpoints in BookStack API docs page

These allow external integration for listing, restoring and destroying recycle bin contents. The listing endpoint contains a little added detail regarding the deleted item and its parent/child content to help cover most use-cases you might have.

A big thanks to @Julesdevops for their work to implement this functionality.

New Editor Event to Configure Diagrams.net

For those that like to hack and customize, we’ve extended our custom editor events to also emit a ‘configure’ editor event when loading diagrams.net (formerly draw.io) in BookStack. This follows the pattern of our other existing editor events and can be used like so:

<script>
    window.addEventListener('editor-drawio::configure', event => {
        const config = event.detail.config;
        config.sidebarWidth = 900;
    });
</script>

If you’ve set a custom DRAWIO .env option, you’ll need to ensure that contains a configure=1 query parameter for this to work. This event provides loads of abilities of customization. Consult this diagram.net FAQ page for a list of the options you can define.

File Handling Efficiency Improvements

In this release we’ve reviewed all the main actions of uploading and downloading files to make things much more efficient. Now, where possible, such file handling will be dealt with by streaming data instead of reading and writing the entire contents. This uses much less system memory and therefore it’s far less likely that you’ll hit PHP memory limits. In fact, this now allows uploading and downloading of attachments that are far larger than your PHP memory limit.

Translations

The wonderful wizards of language within our community have continued their efforts to keep the BookStack translations up-to-date. A big thanks to the following translators for their efforts since the last feature release:

  • Xabi (xabikip) - Basque
  • sgenc - Turkish
  • Shukrullo (vodiylik) - Uzbek
  • na3shkw - Japanese
  • William W. (Nevnt) - Chinese Traditional
  • 10935336 - Chinese Simplified
  • m0uch0 - Spanish
  • Indrek Haav (IndrekHaav) - Estonian
  • Irfan Hukama Arsyad (IrfanArsyad) - Indonesian
  • Helga Guchshenskaya (guchshenskaya) - Russian
  • pedromcsousa - Portuguese
  • eamaro - Portuguese
  • SmokingCrop - Dutch
  • Maciej Lebiest (Szwendacz) - Polish
  • syn7ax69 - German
  • Jasell - Swedish
  • @evandroamaro - Portuguese

Full List of Changes

Released in v22.04

  • Added ability to switch editor types on a per-page basis. (#3387, #458, #369)
  • Added new recycle bin API endpoints. Thanks to @Julesdevops. (#3377, #3372)
  • Added ability to pass diagrams.net configuration options. (#3391)
  • Added Uzbek language option to allow translation, not yet active in the interface. (#3383)
  • Updated translations with latest Crowdin updates. (#3384, #3358)
  • Updated database polymorphic relations to simpler morphmap. (#3395)
  • Updated file handling in many cases to stream data for better efficiency, reduce memory usage and avoid hitting limits. (#3365, #2886)
  • Updated URL handling to be more stable in sub-path scenarios. (#3364, #2765, #2058)
  • Updated content update handling to increment updated_at field, even if only tags are changed. (#3319)
  • Fixed editor Portuguese translation duplication. Thanks to @evandroamaro. (#3373)
  • Fixed API issue where tags would not be applied on API shelf update. (#3370)
  • Fixed development build command lacking Windows/non-bash compatibility. (#3323)

Released in v22.03.1

  • Fixed issue where /settings redirect would lead to wrong location in some scenarios. (#3356)
  • Fixed non-active prevention of custom HTML head content on settings views. (#3355)
  • Updated translations with latest Crowdin changes. (#3354)
  • Updated project PHP dependencies.

Next Steps

Over the next month I’ll probably take a break from big features and instead target v22.05 as a refinement release, improving upon existing functionality and features to address some pain points and unfinished corners. During this time I’ll also look to open up a proposal for some larger-scale changes, specifically in relation to content URLs, to support some future features.

I intend to produce a few more videos for our YouTube channel since these have proved very useful so far. In particular, I want to create an install guide for Ubuntu 22.04, showing the use of our new script, and produce a more general “Intro to BookStack” video for those new to the project.


Header Image Credits: Photo by Dorothea OLDANI on Unsplash