Page History

{scrollbar:no-css=true}
h1. Installing Builder

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

h2. Requirements

* The {builder} theme requires Confluence 2.1.1 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. The theme and many other plugins require that the Base URL is properly set in order to function correctly.

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 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:

For best results, we recomment using Builder 1.6 or above.

*Builder 1.5.x and 1.6.x:*

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

*Builder 1.4.x:* (this version is deprecated)

Copy the .jar file in to your WEB-INF/lib folder and restart {confluence}.

h2. Applying the Theme to a Space

We strongly advise you to create a test space in order to ensure that the theme is working correctly. You will also be able to test out various configuration options and style sheets within the test space which can then be copied over to "live" spaces as and when required.

To Once installed, you will need to apply the theme to a space, please (see our tutorial on setting the [Space[Enabling the Theme]).

h2. CustomisingUpgrading the ThemeBuilder

WhenBefore the theme is first installed, it will look ??ugly?? - you'll need to apply the relevant customisation to make it meet your requirements. For more details, please see [Theme Configuration].

h2. Upgrading Builder

{warning}Always upgrading Builder, please take a full backup of Confluence or we'll come round and get you!  In addition, manually copy the settings from the theme configuration screen as *some versions of Confluence will not include theme settings in the backup*.{warning}

Before upgrading Builder, please 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. Why all the restarts?

Theme plugins are agenerally tadfar more complex than your average plugin. AdaptavistThere are activelysome workingissues onin enhancementsConfluence that will eventually allow the theme to be uploaded and upgraded just like a normal plugin, however some changes to the core {confluence} codebase will be required along the way so it's going to take a little while longer.

In partcular, {confluence} caches the ??velocity?? templates that themes use and doesn't actively clear down those caches when a newrequire a restart in order to make certain changes to take effect.

Adaptavist are working closely with Atlassian and with each new release of Confluence, more of these issues are resolved. However, until all of them are resolved, you'll still have to restart Confluence when installing or upgrading the Builder theme.

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 is uploaded.

h2. Bug Reports and Feature Requestsalready resolves the issue you have.

Our tutorial on [Bug Reports and Feature Requests] 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.