h1. Installing Scroll
h2. Preparation
Download Scroll from [http://www.k15t.com/scroll/download] and save it to disk.
{note:title=Attention IE Users!}When downloading Scroll using Internet Explorer, make sure the file extension isn't changed to ".zip". If so, you need to change it to ".jar" before installing Scroll.{note}
Make sure that you download the correct version. Scroll is available for the following Confluence versions:
|| Scroll Version || 2.6 || 2.7 || 2.8 || 2.9 || 2.10 || 3.0 || 3.1 || 3.2 ||
| 1.0 | (/) | (/) | (/) | (/) | (/) | (x) | (x) | (x) |
| 1.0.1 | (/) | (/) | (/) | (/) | (/) | (/) | (?) | (?) |
| 1.1 | (i) | (i) | (i) | (i) | (/) | (/) | (?) | (?) |
| 1.2 | (x) | (x) | (x) | (x) | (/) | (/) | (/) | (/) |
{info:title=Limitations on pre-2.10}Please note the following limitation(s) for Scroll 1.1 on Confluence-Versions before 2.10:
* Theme images can only be configured on space-level ([More Information|Configuring Scroll Themes])
Please contact us at [mailto:sales@k15t.com], if you are on a older version and need these features. We can extend Scroll as part of a consulting contract.{info}
{note:title=A Note on JDK Versions}Starting with 1.1, Scroll requires Java 1.5, regardless of what your version of Confluence required (E.g. if you are running Confluence 2.6 which only requires JDK 1.4, you still have to run Confluence on JDK 1.5, otherwise the Scroll plugin will not work.){note}
h2. Installing the Plugin via the Plugin Repository (recommended)
To install the Scroll plugin via the plugin repository:
# In the 'Administration' section of Confluence, click the 'Plugin Repository' link.
# Scroll down to _Scroll Wiki Exporter Plugin_ and click on the 'Install' link. Confluence will download the plugin from the plugin repository (hosted by Atlassian) and install Scroll automatically.
{note}If your confluence system cannot access the internet, this installation procedure will not work. Please refer to [#Installing the Plugin Manually] to install Scroll.{note}
Next you have to [install a license|#Installing/Upgrading the License].
h2. Installing the Plugin Manually
To install the Scroll plugin manually:
# In the 'Administration' section of Confluence, click the 'Plugins' link.
# Use the 'Browse' button to find the Scroll plugin jar (scroll-X.Y.jar) from your hard drive or network location, and select it.
# Click 'Upload'.
# The plugin will be uploaded to Confluence and will be automatically installed.
Next you have to [install a license|#Installing/Upgrading the License].
h2. Installing/Upgrading the License
{info:title=How to obtain a Scroll license}If you have no license yet, you can request a free evaluation license. Just contact [sales@k15t.com|mailto:sales@k15t.com].{info}
To install the license:
# Click on 'Configure plugin'.
# Copy the license key from the email you have got and paste it into the 'New License Key' field.
# Click 'Install'.
# The license file will be validated and installed.
# Check the data in the license details.
h2. Trouble Shooting
In case you encounter problems while installing Scroll please refer to the [Troubleshooting Guide]. If you can't find a solution there, write an email to [support@k15t.com|mailto:support@k15t.com].
When writing the email please write a good description of what went wrong - our response will be better and faster, if we have all necessary information available. At least, the email should contain
* a description of what you were trying to do and what you expected to happen,
* the URL you were accessing when the bug occurred,
* a description of what actually happened,
* the Confluence and Scroll versions you are using,
* and your license key.
h2. Preparation
Download Scroll from [http://www.k15t.com/scroll/download] and save it to disk.
{note:title=Attention IE Users!}When downloading Scroll using Internet Explorer, make sure the file extension isn't changed to ".zip". If so, you need to change it to ".jar" before installing Scroll.{note}
Make sure that you download the correct version. Scroll is available for the following Confluence versions:
|| Scroll Version || 2.6 || 2.7 || 2.8 || 2.9 || 2.10 || 3.0 || 3.1 || 3.2 ||
| 1.0 | (/) | (/) | (/) | (/) | (/) | (x) | (x) | (x) |
| 1.0.1 | (/) | (/) | (/) | (/) | (/) | (/) | (?) | (?) |
| 1.1 | (i) | (i) | (i) | (i) | (/) | (/) | (?) | (?) |
| 1.2 | (x) | (x) | (x) | (x) | (/) | (/) | (/) | (/) |
{info:title=Limitations on pre-2.10}Please note the following limitation(s) for Scroll 1.1 on Confluence-Versions before 2.10:
* Theme images can only be configured on space-level ([More Information|Configuring Scroll Themes])
Please contact us at [mailto:sales@k15t.com], if you are on a older version and need these features. We can extend Scroll as part of a consulting contract.{info}
{note:title=A Note on JDK Versions}Starting with 1.1, Scroll requires Java 1.5, regardless of what your version of Confluence required (E.g. if you are running Confluence 2.6 which only requires JDK 1.4, you still have to run Confluence on JDK 1.5, otherwise the Scroll plugin will not work.){note}
h2. Installing the Plugin via the Plugin Repository (recommended)
To install the Scroll plugin via the plugin repository:
# In the 'Administration' section of Confluence, click the 'Plugin Repository' link.
# Scroll down to _Scroll Wiki Exporter Plugin_ and click on the 'Install' link. Confluence will download the plugin from the plugin repository (hosted by Atlassian) and install Scroll automatically.
{note}If your confluence system cannot access the internet, this installation procedure will not work. Please refer to [#Installing the Plugin Manually] to install Scroll.{note}
Next you have to [install a license|#Installing/Upgrading the License].
h2. Installing the Plugin Manually
To install the Scroll plugin manually:
# In the 'Administration' section of Confluence, click the 'Plugins' link.
# Use the 'Browse' button to find the Scroll plugin jar (scroll-X.Y.jar) from your hard drive or network location, and select it.
# Click 'Upload'.
# The plugin will be uploaded to Confluence and will be automatically installed.
Next you have to [install a license|#Installing/Upgrading the License].
h2. Installing/Upgrading the License
{info:title=How to obtain a Scroll license}If you have no license yet, you can request a free evaluation license. Just contact [sales@k15t.com|mailto:sales@k15t.com].{info}
To install the license:
# Click on 'Configure plugin'.
# Copy the license key from the email you have got and paste it into the 'New License Key' field.
# Click 'Install'.
# The license file will be validated and installed.
# Check the data in the license details.
h2. Trouble Shooting
In case you encounter problems while installing Scroll please refer to the [Troubleshooting Guide]. If you can't find a solution there, write an email to [support@k15t.com|mailto:support@k15t.com].
When writing the email please write a good description of what went wrong - our response will be better and faster, if we have all necessary information available. At least, the email should contain
* a description of what you were trying to do and what you expected to happen,
* the URL you were accessing when the bug occurred,
* a description of what actually happened,
* the Confluence and Scroll versions you are using,
* and your license key.