Page History

h1. Installing Builder

*{excerpt}Installing and upgrading the Builder theme...{excerpt}*

h2. Requirements

* Check the [Builder System Requirements]
* The {builder} theme requires Confluence 2.1.2 or above.
* You must have system administration privileges to install the theme
* You must have sufficient privileges to restart {confluence}
* You must have correctly set the *Base URL* in Confluence's [General Configuration] settings.

(on) Should you encounter any problems, please see our [Troubleshooting Guide|Builder Troubleshooting] which lists all common problems and how to fix them.

h2. Installing the Builder Plugin

{note}If you are upgrading from an earlier version of Builder, please see the important notes on [upgrading Builder|#Upgrading Builder] later in this tutorial.{note}

Take(!) aWhen fullmanually backupdownloading ofplugins Confluenceusing thenInternet followExplorer, the instructions applicable tomake sure the [versionfile ofextension theisn't Builderchanged theme|Builder Release Notes] you are using as shown below:

For best results, we recommend using Builder 2.0 or above and use of the [Confluence Repository Client] to install the plugins - installing versions which are incompatible with your Confluence install is our #1 installation support request!

h3. Builder 2.0 and above

{warning}*Confluence v2.3 and Above*
You can install the latest versions of the Builder plugin and it's dependencies.

*Confluence v2.2.10 and Below*
You must install the following versions:

* Builder [v2.0.3-conf22|http://files.adaptavist.com/dist/builder/adaptavist-plugin-themeBuilder-2.0.3-conf22.jar]
* Content Formatting Macros [v1.6.3to ".zip" - if it is, change it back to ".jar" before installing the plugin.

h3. Plugin Requirements Overview

||Confluence Version||Plugin Repository||Theme Builder||Content Formatting Macros||Page Information Tools||
||1.4.x|n/a|1.4|n/a|n/a|
||2.0.x -- 2.1.x|[1.2|http://svn.atlassian.com/svn/public/contrib/plugin-repository/client/trunk/dist/plugin-repository-client-plugin-1.2.jar]|2.0.3|[1.6.3|http://svn.atlassian.com/svn/public/contrib/confluence/contentFormattingMacros-plugin/trunk/dist/adaptavist-plugin-contentFormattingMacros-1.6.3.jar]|[1.2.2|http://svn.atlassian.com/svn/public/contrib/confluence/pageInfo-plugin/trunk/dist/adaptavist-plugin-pageInfo-1.2.2.jar]|
||2.2.x|1.2|2.0.3-conf22|[1.6.3|http://svn.atlassian.com/svn/public/contrib/confluence/contentFormattingMacros-plugin/trunk/dist/adaptavist-plugin-contentFormattingMacros-1.6.3.jar]|[1.2.2|http://svn.atlassian.com/svn/public/contrib/confluence/pageInfo-plugin/trunk/dist/adaptavist-plugin-pageInfo-1.2.2.jar]|
||2.3.x - 2.4.x|Pre-installed|2.0.4|Latest|[1.2.5|http://svn.atlassian.com/svn/public/contrib/confluence/pageInfo-plugin/trunk/dist/adaptavist-plugin-pageInfo-1.2.5.jar]|
||2.5.x|Pre-installed|2.0.9 or above|Latest|[1.2.5|http://svn.atlassian.com/svn/public/contrib/confluence/contentFormattingMacrospageInfo-plugin/trunk/dist/adaptavist-plugin-contentFormattingMacrospageInfo-1.62.35.jar]
* Page Info Plugin [v1.2.2|
||2.6.x|Pre-installed|2.0.9 or above, 3.x for best results|Latest|[1.2.8|http://svn.atlassian.com/svn/public/contrib/confluence/pageInfo-plugin/trunk/dist/adaptavist-plugin-pageInfo-1.2.28.jar]

If you use the [Confluence Repository Client], these versions would automatically be selected for you.
{warning}

Before installing Builder 2.0, please install the latest versions of the following plugins:
 or [above|http://svn.atlassian.com/svn/public/contrib/confluence/pageInfo-plugin/trunk/dist/]|

(i) Confluence 1.4.x is no longer supported - you can try Builder 1.4 or 1.5 if desired. The Content Formatting and Page Information Tools plugins were not required for Builder 1.x.

h3. Installing Dependant Plugins

Theme Builder requires two open source plugins, both developed by Adaptavist, to be installed:
* [Page Information Tools Plugin] ([CONFEXT|http://confluence.atlassian.com/display/CONFEXT/Page+Information+Plugin])
* [Content Formatting Macros] ([CONFEXT|http://confluence.atlassian.com/display/CONFEXT/Content+Formatting+Macros])

NB: To get the very latest versions ofThe easiest way to install these plugins is via the Plugin Repository. Alternatively you can download these plugins manually and you might need to configure the repository client to show "All Versions" of plugins.

You can then install the [Builder Theme] using the plugin repository client.

h3. Builder 1.5.x and 1.6.x

Upload the .jar file using the [Plugin Manager] in the [Administration Console] and restart {confluence}.

Once installed, you will need to apply the theme to a space (see [Enabling the Theme]).install via the Plugin Manager or "Uploads" tab on the Plugin Repository.

Note: These plugins are only required for the navigation and title panels default settings - if you don't want to use tables or display page information in your customised theme design, you will not require these plugins.

h3. Installing Theme Builder

Take a full backup of Confluence then follow the instructions applicable to the [version of the Builder theme|Builder Release Notes] you are using as shown below:

{expand:Theme Builder 1.x}{quote}
# Manually download the plugin from the URL in your license email.
# Install the plugin using the Confluence Plugin Manager (in Administration Console)
# Restart Confluence to complete the installation
{quote}{expand}

{expand:Theme Builder 2.x}{quote}
# Manually download the plugin from the URL in your license email.
# Install the plugin using the Confluence Plugin Manager (in Administration Console)
{quote}{expand}

{expand:Theme Builder 3.x}{quote}
# Install the plugin using the Plugin Repository
# Click the "config" link that appears next to the plugin and enter your license key
{quote}{expand}

h2. Upgrading Builder

Before upgrading Builder, please take a full backup and ensure that you have uninstalled any previous versions:

* If you manually installed the plugin to the WEB-INF/lib folder, you must manually delete that file
* If you uploaded via the [Plugin Manager], select the "Site Builder" plugin from within the [Plugin Manager] and click the "Uninstall Plugin" link to remove it{footnote}On some occasions, you may get an error message stating that the plugin could not be uninstalled. Should this happen, restart Confluence and try again.{footnote}

After uninstalling any previous versions, you can install the new version as described earlier in this tutorial.

{display-footnotes}

h2. Bug Reports and Feature Requests

Before reporting a bug, please check our [Builder Release Notes] - it's possible a recent version of the theme already resolves the issue you have.

Our tutorial on [Reporting Bugs] explains the process for informing us of bugs or ideas for new features for the {builder} theme. It also lists all currently reported items and has a link to our development roadmap.