Road Runner Documentation

h2. Description:

{color:black}{*}RoadRunner{*}{color} allows you to take {color:black}{*}Confluence{*}{color}content (pages and attachments) with you offline. Also you can create / update / fine tune content offline before sending it back to the server where it's public.

{color:black}{*}RoadRunner{*}{color} is a {color:black}{*}Confluence{*}{color} plugin (or stand alone app) which synchronizes content from one or multiple {color:black}{*}Confluence{*}{color} servers down to a your local desktop or laptop running a personal version of {color:black}{*}Confluence{*}{color}.
| (i) | \\
This is an executable jar so you can either double click to run or type: java \-jar rr.jar |

h2. Uses for Road Runner

* consultants traveling can have an up to date copy of {color:black}{*}Confluence{*}{color} running locally on their laptops without concerns about connectivity.
* creating documentation locally and off line before it's viewable to everyone is now a piece of cake
* creating and updating content is no longer hampered by network latency

h2. Running {color:black}{*}RoadRunner{*}{color}

** at a shell type: java \-jar rr.jar

h3. Learn how to use {color:black}{*}RoadRunner{*}{color}

The fastest ways to learn to use {color:black}{*}RoadRunner{*}{color} are:
* [SeeRoadRunnerDocumentation by screenshot|art:RoadRunner Documentatio by Screenshot]
* [watch this short video on how to use it|http://www.screencast.com/t/aQ3Qw3nxm4] [http://www.screencast.com/t/aQ3Qw3nxm4]

h3. Current Features (updated for v0.4.0)

* synchronization of {color:black}{*}Confluence{*}{color} server content to your local computer
** {color:black}{*}Confluence{*}{color} pages
** attachments
** page hierarchies
** creates spaces locally when necessary
** optional full sync refresh
** real time feedback through progress bars and text logs
* [Page Copy|art:RoadRunner Documentatio by Screenshot] allows you to send selected pages and their attachments to another server with a coupld of clicks
* *HTML export of pages to you local file system (new in v0.4.0)*

h3. [Screenshots|art:RoadRunner Documentatio by Screenshot]:

{gallery:title=roadrunner screenshots}


h2. Current Limitations

* Space synchronization is currently one way from the remote server down to your local, though you CAN send content back up with [the Page Copy feature.|art:RoadRunner Documentatio by Screenshot]
* Content not currently copied down from the remote server
** comments
** labels
** content entity data used by some macros such as voting macros
* document and page authorship data
* page histories are not copied if there were multiple updates between your syncronizations
(there are many more limitations)

h2. Features Roadmap


h5. For version 0.5

* more intelligent tree rendering of just spaces until the space nodes are expanded to get pages
* "max size for attachments to copy" preference setting setting

h5. More planned features

* support for SSL
* detect renamed pages rather than recreating
* available as a {color:black}{*}Confluence{*}{color} plugin
* synchronization history
* synchronization of labels and other additional metadata
* one touch two way synchronization so all local changes are uploaded to remote server(s)


h2. F.A.Q.


h5. Will it delete pages or other content

No. For the foreseeable future {color:black}{*}RoadRunner{*}{color}only adds content. Even if something is removed on a remote server if it already existed on your local server it will not be removed. Additionally when pages and attachments are copied {color:black}{*}Confluence{*}{color} retains older versions of pages and attachments which are easily accessible.

h5. I received a 'java.lang.OutOfMemoryError: Java heap space'

Please try increasing the memory by running it with this command:

java \-Xms512m \-Xmx512m \-jar rr.jar

Or you can [use this batch file from the same location as the jar|http://confluence.atlassian.com/download/attachments/178259211/run_rr.bat?version=1&modificationDate=1251480593610] (Windows).

This happened because attachments you were copying were big enough that it caused it to run out of memory. Running it this way will probably fix the problem. If not then when I add the WebDAV option it will definitely eliminate this issue.