This is the documentation for an older version of Scroll Viewport. Here you can view the most up-to-date version of the Scroll Viewport documentation.

Advanced Plugin Settings

The advanced plugin settings allow admins to tweak the behavior of Scroll Viewport. This article describes which settings are available, and how to change them.

Confluence Administration Permission Required

You have to be logged in as a user with space administration permissions in the current space (or with Confluence administrator permissions).


View and change the advanced plugin settings

Some advanced plugin settings can be defined on the space level, some can be activated on the global level, and some can be activated on both. Refer to the Available settings table below to see the scope of the individual advanced settings.

To view and change the values of the advanced plugin settings on a global level, navigate to Confluence Administration > Scroll Runtime > Advanced Plugin Settings > Select Scroll Viewport in the top-right dropdown.

You can configure settings on a space level at Space tools > Scroll Add-ons, and then pressing the ALT key to make a menu entry for Advanced Plugin Settings appear.

Available settings:

You can change the settings by clicking Edit in the Operations column. The following table describes the various settings, and their possible values:

KeyScopeDescriptionAllowed ValuesDefault Value

enableApacheModProxyTweak

Global

Indicates that some tweaks are enabled that may help, if Confluence/Viewport is running behind an Apache front-end server with mod_proxy, that messes up the forwarded URL (Google for the code ProxyPass directive the nocanon flag).

From the Apache mod_proxy docs:

Normally, mod_proxy will canonicalize ProxyPassed URLs. But this may be incompatible with some backends, particularly those that make use of PATH_INFO. The optional 'nocanon' keyword suppresses this, and passes the URL path "raw" to the backend. Note that may affect the security of your backend, as it removes the normal limited protection against URL-based attacks provided by the proxy.

(Source: http://httpd.apache.org/docs/2.2/mod/mod_proxy.html#proxypass)

true/falsefalse
enableViewportInfoForSpaceAdminsGlobalIndicates that an info about Scroll Viewport should be displayed to space admins in spaces that have not yet a viewport configured.true/falsetrue

allowPerformanceLogging

GlobalIndicates that performance logging is allowed. Note that in the current implementation clients still need to set the corresponding HTTP request header to trigger logging for a specific request.true/falsefalse
slugsGlobal

The old approach for generating page slugs had a few deficiencies if the page titles contained characters like question marks. Our new solution ensures that the page titles will always consist of simple characters that don't need any percent encoding. This should improve the looks of your URLs.

Of course we are aware of the fact that you might want to keep the old approach now that your page has already been indexed by search engines. We've added a plugin setting that let's you revert to the classic behavior.

Possible values:

  • classic - the old page slugs as created by Scroll Viewport 1.x
  • simple - the new page slugs

classic, simple

 
maxSearchPageSizeGlobal

A global Runtime PluginSetting that allows administrators to control the amount of search results per page.

numbers

100

repository.propertyMappingSpace

You can set a certain version to be mapped as the 'latest' version – the version displayed to those viewing the viewport by default.

Possible values:

  • empty – the default version is the one created most recently
  • {"latest""2"} – the 'latest' version maps to a specific version (in this case version 2)

  • {"latest""<current>"} – 'latest' maps to the currently published version
  • {"latest""<off>"} – there is no 'latest' version.

empty, specific version name, <current> ,<off>empty