Since Scroll Sites on On-prem and Cloud are technically different apps, migration requires a hands-on approach. This guide will walk you through the process.
If you would like personalized advice on how to move your viewports to cloud, you can either send us a viewport usage report (requires minimum Scroll Sites 2.25.2) or provide screenshots:
Option 1 – Get the usage report:
-
Navigate to
<your Confluence base URL>/rest/scroll-viewport/1.0/support, copy the results to a .txt file, and send it to us. -
Please also send us the most customized theme that is in use. Follow the instructions to download the theme.
Option 2 – Do it manually (if you do not want to update):
Take screenshots from:
-
General Configuration > Scroll Sites/Scroll Viewport > Viewports
-
General Configuration > Scroll Sites/Scroll Viewport > Themes
-
General Configuration > Macro Usage > Scroll Sites/Scroll Viewport or Scroll Runtime for Confluence
Please also send us the most customized theme that is in use. Follow the instructions to download the theme.
Things to Keep in Mind
URLs from your existing viewport are likely to break since the page ID of your Confluence pages will change. Learn how to keep Urls stable.
Migration Steps
These steps will explain how you can move your viewports to Confluence Cloud.
Step-1: Migrate content to Confluence Cloud
-
Migrate your Confluence spaces to your Confluence Cloud instance by using Confluence Cloud Migration Assistant.
Step-2: Create a new Scroll site
Pre-requirement: You have Scroll Sites installed on your Confluence Cloud.
-
In the Confluence sidebar navigation click on "Apps".
-
Choose "Scroll Sites" from the dropdown.
-
Click on "Create new site".
-
Go through the site creation wizard following the steps on Create a New Scroll Site .
-
In the “Set up your site” step, make sure to create an ‘unpublished site’.
-
In the “Add content” step, make sure you add your imported space as the content for your site.
-
Click “Create”.
Step-3: Apply theme settings
If you are currently using the WebHelp theme, you will need to choose a new theme for your Scroll Site in Cloud. Browse the available themes to find the best fit, or customize the Help Center theme to achieve a similar look and feel.
If you are using a custom theme, please reach out to K15t support (or email to help@k15t.com) for guidance on next steps.
If you are using Help Center theme, the theme settings in the theme editor on Confluence Cloud are in the same order and work the same as they are on Confluence On-prem.
On your Confluence On-prem Instance
-
Navigate to your Viewport settings (General Configuration > Scroll Sites > Viewports > Configure)
-
Open the theme editor of your applied Help Center theme.
-
Download all attached images you use within the theme.
-
Open the theme editor of your applied Help Center theme.
-
Open theme-settings.properties file.
On your Confluence Cloud Instance
-
Open Scroll Sites from Apps > Scroll Sites
-
From the My Sites screen, find the card for the site you want to customize.
-
Click Site Settings > Look and feel > Customize theme. The theme configurator will open.
-
Compare the settings of your theme-settings.properties file and the settings in the theme configurator.
-
Adjust the settings accordingly.
-
Once done, save the theme and close the configurator.
(Optional) Step-4: Set up your custom domain and redirects
On your Confluence On-prem Instance
-
In the viewport spaces, find all redirect macros and note down the redirects (General Configuration > Macro Usage)
-
Go to your Confluence's General configuration > Scroll Sites > URL Redirects. Note down all redirects here as well.
You should also take care to remove any existing CNAME records from your DNS configuration before you proceed.
On your Confluence Cloud Instance
-
Follow all the steps on Connect a custom domain
-
Follow the steps to set up your literal redirects or regex redirects
Step-6: Bring your site live
-
In Scroll Sites on Cloud, for the site you created click on "Go live" from the sidebar.
Depending on the size of the space, this might take a while but doesn't require your attention.
Once your Scroll site is live it is accessible publicly through the given URL defined in Step-2.