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.

Managing Viewports

This page explains how to create a viewport. A viewport provides a special view on pages or blog posts in a space and can be accessed through a URL, that can be configured when the space is created.

Considerations:

  • Scroll Viewport checks permissions (system-level and space-level) and restrictions (page-level) before outputting the pages. This means if a page or blog post is not visible to the user accessing a viewport, Scroll Viewport will render a 403 error page.
  • If you specify a (sub-)domain name different from the Confluence domain name, you have to make sure that the Confluence system is accessible under that name.
  • If you specify a (sub-)domain name different from the Confluence domain name, users have to login to Confluence under that domain, too. Reason for this is, that the browser will not send the session cookie to the viewport, because it is a different server name.

Space Admin Permission Required

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

Accessing the Viewport Configuration

Viewports can be managed on system-level and on space-level.

To access the viewport configuration on system-level:

  1. Choose the cog icon  at top right of the screen, then choose Add-ons.
  2. Choose Viewports in the left hand panel.
  3. As result the list of all viewports in the Confluence system will be displayed.

To access the viewport configuration on space-level:

  1. Choose Space Tools > Scroll Viewport.
  2. As result the list of viewports in the current space will be displayed. 

Creating and Updating a Viewport

When creating a viewport you make pages or blog posts available from the configured spaces.

To create or update a viewport click Configure to open the configuration of the viewport:

Theme

On the Theme tab choose a theme for the viewport:

Content of the Viewport

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

Fields on the Content Tab:

FieldDescription
Space KeyEnter the space key of the space to be displayed in the viewport (info) This field is disabled when configuring on space-level)
Content TypesSelect whether you want to show pages or blog posts or both.

Viewport URL

On the URL tab you can configure the URL where the viewport is available, and how the URLs of the individual pages are constructed.

Fields on the URL Tab:

FieldDescription
Domain NameHere you can optionally enter the domain name under which the viewport is available.
Path Prefix

The path, where the viewport is available.

(info) To avoid collisions with URLs from Confluence, the following 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 PathThe way how the page URLs are constructed.

Permissions

On the Permissions tab, you can manage which users are allowed to access the Confluence UI:

Accessing a Viewport

To access a viewport, click Open on the viewport list.

On this Page

Troubleshooting

The viewport always returns a 403 permission error, when I try to access a page?

  • Make sure you are logged in to that domain.
  • Check the permissions for the page you are trying to access.

When accessing the viewport, the browser does not find the server.

  • Make sure that the (sub-)domain name of the viewport is pointing to the Confluence system:
    $ ping <viewport-domain-name>
    and
    $ ping <confluence-domain-name>
    should both work and go to the same addresses.