Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

Fedora CloudSync is distributed as a WAR file that you can drop into any Java servlet container. This guide will walk you through the installation process.

On this page:

Table of Contents

Getting the latest version

See Downloads for the latest WAR file.

Installing CloudSync 1.1.0

Define CloudSync Home

This is the directory where CloudSync will keep all data files and logs. You have four options for defining it:

  1. Don't define it. If undefined, CloudSync will create and use the .cloudsync directory in the home directory of the user the servlet container runs as. For this to work, the home directory of the servlet container user must exist.
  2. Set the value of the CLOUDSYNC_HOME environment variable. If set, the directory will be created and used when CloudSync starts.
  3. Set the value of the cloudsync.home system property. If set, the directory will be created and used when CloudSync starts.
  4. Modify the war file (unzip it, then zip it again when finished) and modify the cloudsync.properties file in the WEB-INF/classes directory.

Configure Sufficient Memory

It is recommended that you allocate at least 128 MB of heap and 128 MB of PermGen memory for use by CloudSync when running in a dedicated servlet container. In a shared container, you should find out what these values are set to currently, and increase them by at least 128 MB each.

This can be done in a variety of ways, depending on the servlet container. In Tomcat, one way to control it is to set the CATALINA_OPTS environment variable before starting up the container.

For example, in Unix:

No Format
export CATALINA_OPTS="-Xms128m -Xmx128m -XX:MaxPermSize=128m"

In Windows:

No Format
set CATALINA_OPTS=-Xms128m -Xmx128m -XX:MaxPermSize=128m

Deploy the WAR File

CloudSync is designed to be installed in the servlet container of your choice. It has been tested with Tomcat 6.

Refer to your servlet container documentation for instructions on deploying war files. This is usually just a matter of copying the WAR file into a certain directory. NOTE: You may wish to rename the WAR file (e.g. cloudsync.war) before deploying it so the application becomes available at a shorter URL than it would be otherwise.

Check the System Log

CloudSync's main logfile can be found in $CLOUDSYNC_HOME/systemlogs/cloudsync.log. If you're having trouble starting or using the service, this file often contains details that will help you resolve the problem.

Upgrading from 1.0.x

Upgrading from the previous feature release will require a re-installation due to significant database changes.