silverstripe/multiuser-editing-alert

A module that indicates when people are editing the same page in the CMS

2.1.0 2024-01-14 10:23 UTC

Requires

• silverstripe/cms: ^4.0|^5.0
• silverstripe/vendor-plugin: ^1.0|^2.0

BSD-3-Clause

• Julian Seidenberg

• user
• content
• silverstripe
• alert
• concurrent
• editing
• author
• multi-user

README

Alerts users in the SilverStripe CMS when multiple people are editing the same page.

Maintainer Contact

Julian Seidenberg <julian (at) silverstripe (dot) com>

Requirements

SilverStripe 4.0 or newer

Installation

Run: composer require silverstripe/multiuser-editing-alert

The module is automatically enabled after flush=all.

Usage

Install the module and blue dots appear next to pages in the site tree to indicate where CMS authors are editing. If multiple authors edit the same page a red dot and large warning messages appears on the page.

The list of people editing the page is stored in the SS_Cache file (DynamoDB in SilverStripe Platform or Tmp), and running a flush clears the list of editors.

The module polls the server every 3 seconds when there are multiple users editing, but saves server cycles by polling about every 24 seconds when there is just a single content author editing. If a user logs out or closes their tab, they automatically get timed out and removed from the list of current editors.

You can just the timing of the pollings using the multiuser.yml config file. For example, if there are a huge amount of content authors editing at any one time, you might want to set update less frequently, as that might overload the server.

Extra bonus: the red and blue dots are SVG files, and therefore tiny to download.

See a video demo here

Attribution

• Icons bluedot.svg and reddot.svg by Benji Park. All rights reserved. Licensed under a Creative Commons Zero 1.0 License.
• Icon warning.svg from IcoMoon App. All rights reserved. Licensed under a GPL / CC BY 4.0.