×

You're using an outdated browser

For a better experience, keep your browser up to date. Check here for the latest version.

Manual

Viewport configuration guide

Nils Bier

Nils Bier Last update: Dec 14, 2018

Scroll Viewport offers multiple options for configuring viewports. You can configure viewports for a space at Space tools > Add-ons > Configure:

Define the scope of the viewport 

Themes can be either global or on a space level.

  • Global themes can be used in viewports in all spaces. Only Confluence application administrators can edit or delete them.
  • Space-level themes can only be used for viewports in the space they are stored in. Space administrators of that space can edit or delete them.
  • Confluence application administrators can convert a spaced theme to a global theme using the Make Global action in the theme menu.
  • Space administrators can copy a global theme into a space, then edit the copy.

Pick a theme 

On the Theme tab you can select which theme the viewport should have – this defines how content is rendered.

Scroll Viewport comes bundled with two themes out of the box:

Theme

Description

Scroll Help ThemeBasic design, very similar to the standard Confluence view
Scroll WebHelp ThemeNewer, more styling, further away from the standard Confluence view

Define what content is displayed 

On the Content tab you can define what content will be displayed in the Viewport:

FieldDescription
Space Key

Enter the space key of the space to be displayed in the viewport (this

Content TypesSelect whether you want to show pages, blog posts, or both

Configure viewport URL 

You can configure the viewport's URL on the the URL tab.

FieldDescription
Domain NameHere you can optionally enter the domain name under which the viewport is available. If your Viewport domain is different from your Confluence-Base-URL please read this article.
Path Prefix

Add a path prefix to define the path where the viewport is available.

 To avoid collisions with URLs from Confluence, certain path prefixes are not allowed

  • /admin
  • /ajax
  • /display
  • /download
  • /images
  • /includes
  • /json
  • /plugins
  • /pages
  • /label
  • /jcaptcha
  • /s
  • /x
  • /rest
  • /spaces
  • /styles
  • /rpc
  • /rest
  • /favicon.ico

  • /noop.jsp

  • /login.action

Page Path

The way how the page URLs are constructed. Choose between hierarchical and flat.

Hierarchical path naming example:

Flat path naming example:


Define who sees the viewport, and who sees the Confluence UI 

On the Permissions tab, you can define which user groups have access to the Confluence UI, and which can only see the pages through the viewport. You can also allow users to view the viewport, but restrict them from accessing the Confluence UI. This is useful, for example, if you have a public website that should be available to anonymous users, but if you don't want these users to see the Confluence UI of the website space.

FieldDescription
Restrict access to Confluence UIIf enabled, only users specified below can access the space through the Confluence UI.
Groups with access to the Confluence UIIf the Restrict access to Confluence UI field is ticked, you can grant user groups access to the Confluence UI by adding them to this field.
Automatically redirect users to viewportEnable to redirect users to the viewport rather than the Confluence view.
2x2.12
We use cookies to create a secure and effective browsing experience for our website visitors and to understand how you use our site (i.e. Google Analytics). For more information: click here.
Ok