Safe Mode Support and System Properties for Userscripts

On 30 Aug 2023 we released version 2.4.0 of Userscripts for Confluence!

This version provides a safe mode for deactivating the core services by setting a system property. It also provides a REST service to set system properties for this app.

New and Noteworthy

This release provides the following new and noteworthy features.

Safe Mode

The Safe Mode allows administrators to deactivate the main services of this app via a System Property. The system property can be set with the Java Virtual Machine when the machine is started.

In case any service of this app causes trouble on your Confluence instance, you can now deactivate a specific set of services for maintenance. This adds another option to Disabling and enabling apps, where apps are disabled via the Universal Plugin Manager.

System Property Service

The new REST service System Property Service allows Confluence administrators to configure system properties defined by Userscripts for Confluence.

This way the System property can be accessed and altered at runtime via a REST client.

Absolute URL Fix

The previous Version fails to handle remote URLs properly. This version fixes that issue.

Also local URLs to attachments are now tested to have the correct base URL of the Confluence server (see Upgrade instructions below).

Installation Instructions

Simply install the app via the Atlassian Marketplace or the downloaded OBR artifact.

Upgrade Instructions

Prior to upgrading to the new version, please check that scripts that are attached to pages of your Confluence have the correct base URL.

Check Script Base URLs for attached Scripts!

In case you have moved your Confluence server from one domain to another domain, previous versions of the app were able to find the locally stored scripts none the less.

For instance a script at https://old.example.com/confluence/{path.to.an.attachment}/whatever.js would be found even if the same Confluence server has the script now at https://new.example.com/confluence/{path.to.an.attachment}/whatever.js.

The reason for this is that the server simply looks if there is the attachment without checking the base URL. With this version those scripts will no longer be found.

Therefore, you need to check that all URLs pointing to an attachment do have the correct base URL. The correct base URL is the base URL of your Confluence Server.

This is a very special issue that very likely has no effect on your installation. It is highly recommended to check them! Otherwise some of your userscripts may not work after the upgrade!

List of Changes

Key	Summary	Status	Resolution	Description
USR4C-30	System Properties Services	Done	Fixed	Provide a service to set userscript's system properties.
USR4C-29	Safe Mode	Done	Fixed	Allow to prevent the execution of service of this app via a system property. This allows administrators to start Confluence in a safe mode that deactivates selected services.
USR4C-31	No Plugin Information on REST call per Default	Done	Fixed	Clients of REST services are provided with the plugin information per default. This information (plugin key and version) should not be shown of the user has not sufficient privileges to access the service.
USR4C-32	Absolute URL Fix	Done	Fixed	When processing absolute URLs a local URL is generated although the remote URL should be used as is.

4 issues

Userscripts for Confluence 2.4.0