Preface

This Installation Guide is a resource written for administrators who want to install ConfluenceFx. This guide defines the concepts and procedures for installing and implementing a successful installation of ConfluenceFx.

Installation Procedure

The installation guide contains the following chapters.

• Server Side Installation
• Plugins Installation
• Confluence Desktop installation.

Server Side Installation

To install ConfluenceFx server side:

1. Unzip the CFxInstaller.zip file.
2. Follow the instructions below depending on your operating system.

If you are installing ConfluenceFx on Confluence 3.2 and upwards, make sure to add the backport-util.jar file available right here into the "lib" folder of your Tomcat installation directory before restarting your Tomcat

Useful Requirements The application server should be down before proceeding the installation If you have several java versions installed, you have to edit the install script (start-console or start) at the following line : java -jar "$PWD/Resources/CFxInstaller-standard.jar" -console Set the correct directory to your java installation

Wizard Installation on a Mac OS X or Linux operating system:

• Open a "Terminal" window
• Go to the CFxInstaller directory (ex: cd Documents/CFxInstaller)
• Set the appropriate execution permissions for the "start.sh" file using the chmod command: ( "chmod +x start.sh" or "chmod 740 start.sh")
• Excecute the "start.sh" like this sh ./start.sh
• The installation Wizard is launched.

Wizard Installation on a Windows operating system:

• Excecute the "start.bat" file (double-click)
• The installation Wizard is launched.

Wizard Installation Note Once, the installation wizard is launched, click Next to proceed to the Licence Agreement page Please read the license agreement carefully, it covers the terms and agreements between your organization and KapIT, which govern your usage of ConfluenceFx If you accept the agreement, select the I accept the terms of the End User Licence Agreement option Click Next to continue your installation Copy and paste the path to your Confluence WEB-INF directory.

Console Installation on a Windows Server:

• Execute the "start-console.bat" using this command from the console
• Follow the on screen instructions.
• When asked for the "Target Path" please provide the path to the WEB-INF directory of Confluence

Console Installation on a Mac OS X or Linux server:

• Set the appropriate execution permissions for the "start-console.sh" file using the chmod command: ("chmod +x start-console.sh" or "chmod 740 start-console.sh")
• From the console, execute the start-console.sh using this command: sh ./start-console.sh
• Follow the on screen instructions.
• When asked for the "Target Path" please provide the path to the WEB-INF directory of Confluence

Once the installation is finished, please start your application server.

• Back to Top

Entering the license key

To complete ConfluenceFx installation, you need to set a valid license key. To do that follow the instructions below:

1. Go to the Confluence Administration page
2. In the left panel, click on "License Details" in the "ConfluenceFx" section
3. Paste your license key in the "Upload new License" text area
4. Tick the "I have read and I accept the terms and conditions of the End User License Agreement." checkbox
5. Click "Install".

If you don't have a license key, please request an evaluation key here.

• Back to Top

ConfluenceFx Plugins Installation & Configuration

Installing ConfluenceFx Plugins

The following install procedure can be repeated for all ConfluenceFx plugins. To install a plugin please follow the instructions below:

1. Go to the Administration Console of Confluence
2. In the left column, click on « Plugins »
3. In the "Manage Plugins" section, click browse and select the plugin jar file
4. Click on "Upload".

If you want to customize Confluence Desktop configuration according to your needs (IE : security, permissions, available modules on the Desktop app ...), you can do so by accessing the "Configuration console".

Plugins Activation

By default all the plugins are activated in Confluence Desktop.
You can personalize the application, and disable any plugins you want. To do this, from the "Configuration console", click on the "disable" link in the Sate column.

Plugins Permissions

ConfluenceFx allows administrator to manage permissions according to the Confluence permissions system. By default, all access to the plugins are allowed.
To manage the permissions, please follow the instructions below:

1. Go to the Administration Console of Confluence.
2. In the left column, click on « Configuration console » in the new "ConfluenceFx" block.
3. Click on the plugin configure icon (gear).
4. Modify the plugin permissions in the « Permission Settings » section

When a user access a page that contains a plugin macro that he has no permission for it, an error message is displayed. This plugin will not be available for the user on Confluence Desktop

Overriding Confluence functions

People Directory plugin

ConfluenceFx, through its People Directory Plugin, override the confluence people directory by default. However you can disable this by following the instructions below:

1. Go to the Administration Console of Confluence.
2. In the left column, click on « Configuration console » in the new "ConfluenceFx" block.
3. In the plugin list, click on « CFx People Directory » configuration
4. Change the "Enable Flex components for the plugin" option to "No"

Search Reloaded plugin

ConfluenceFx, through its Search Reloaded Plugin, override the confluence search by default. However you can disable this by following the instructions below:

1. Go to the Administration Console of Confluence.
2. In the left column, click on « Configuration console » in the new "ConfluenceFx" block.
3. In the plugin list, click on « CFx Search » configuration
4. Change the "Enable Flex components for the plugin" option to "No"

• Back to Top

Installing Confluence Desktop

Requirements

• ConfluenceFx Plugins : Make sure you have already installed ConfluenceFx Plugins in Confluence (refer to the "ConfluenceFx Plugins Installation" section of this guide)
• Adobe Air : Download and install the latest version of Adobe AIR from http://get.adobe.com/air/

Confluence Desktop installation and configuration

In order to install Confluence Desktop, you need to click on the Confluence Desktop installation badge.

Description of Confluence Desktop macro

This macro displays the Confluence Desktop installation badge. It allows users to install the Confluence Desktop application on their computer.

Install the Confluence Desktop badge

1. Insert the Confluence Desktop macro in the Confluence "Site Welcome Message" using the following syntax

{cfx-desktop-macro}

The macro displays the Confluence Desktop installation badge
2. Click on the Confluence Desktop installation badge and follow the install instructions. Confluence Desktop will automatically launch after the installation.

If Confluence Desktop could not find the connection parameters, you will see the following screen:

You need to enter the Confluence "Server Base Url".

• Back to Top

Upgrade procedure

In order to proceed to the upgrade of ConfluenceFx, please follow the same instructions as the installation guidelines above. The installer will replace the server-side files and you will have to update every ConfluenceFx plugin in the plugins console of Confluence. You can skip the "license" part if you already have a valid license for ConfluenceFx.

If you are upgrading to Confluence 3.2 and upwards, make sure to add the backport-util.jar file available right here to the "lib" folder of your Tomcat installation directory before restarting your Tomcat

• Back to Top

Uninstall Procedure

To remove ConfluenceFx from your application server, please follow the instructions below:

• Shutdown your application server and go to the Confluence WEB-INF directory
• Delete the WEB-INF/classes/flex directory
• Delete the following files from the WEB-INF/lib directory
  • flex-messaging-remoting.jar
  • flex-messaging-proxy.jar
  • flex-messaging-opt.jar
  • flex-messaging-core.jar
  • flex-messaging-common.jar
  • CFx-AMFConnector.jar
• Delete the WEB-INF/flex directory
• Replace the WEB-INF/web.xml with the backup done by the installer called WEB-INF/web.xml.old.

  if you have made any modification in the WEB-INF/web.xml file after the installation of ConfluenceFx, remember to report these modifications to the web.xml.old file before replacing it.

• Start your application server.

• Back to Top

Look & Feel

From the admin side, you can configure Confluence Desktop Look & Feel.

1. Go to the Administration Console of Confluence.
2. In the left column, click on « Configuration console » in the new "ConfluenceFx" block.
3. Click on the Desktop configuration gear.

You can set :

• Wiki's name
  Once this wiki name is set, the real time notification windows will apply the new name. Unless it will use the default name Confluence Desktop.

Example :

• Wiki's Logo
  You can personalize the header logo of the application. The Confluence Desktop will display your custom logo when it is set, unless the default logo will be displayed.

Example :

• Confluence Desktop colors
  You can customize the different colors of the application. By default the application has a grey theme.
  An administrator can choose to set an unique theme (defined through six colors as described below). To do this, tick the "Allow users to make their own color settings" checkbox. By default every user can set his own set of colors from the settings on the Confluence Desktop application.

 <theme>
    <themeColorDark>999999</themeColorDark>
    <themeColorLight>FFFFFF</themeColorLight>
    <themeBorderColor>CCCCCC</themeBorderColor>
    <fontColorTitle>FFFFFF</fontColorTitle>
    <fontColorRenderer>333333</fontColorRenderer>
    <fontColorRead>666666</fontColorRead>
  </theme>

For more details you can refer to : Web-Safe colors.

• Back to Top

Notifications

From the admin side, you can configure whether you want users to receive notifications based on the types of resources, and let your users decide which types they want to be notified on (or don't let them decide)

1. Go to the Administration Console of Confluence.
2. In the left column, click on « Configuration console » in the new "ConfluenceFx" block.
3. Click on the Activity reader configuration gear.

You can then choose which types of resources you want your users to be notified on by checking the boxes.
This will represent a subset of types available for the end-users. For example, if you untick "attachments", users will never have the possibility to receive notifications when attachments are uploaded on Confluence.
Users will be able to choose among this subset unless you select "No" to the "Allow users to choose any type of resources among this subset?" question. In this case, types chosen will be strictly restricted and end-users will not be able to decide which types they want.

The result in Confluence Desktop will look like this :

• Back to Top

Feedback

Please let us know if you encounter any problem during the installation. Contact by E-mail the ConfluenceFx Team at cfx.contact@kapit.fr. You can also refer the the FAQ section to get more details.