Transferring jiveHome

When you upgrade from version 2.5.x, you need to transfer the jiveHome directory from its existing form and location to the new ones. This ensures that the information your installation needs will be correctly suited to the new platform. For example, as of version 3, the contents of the former jiveHome directory are no longer all contained in a single directory. Use the tools described here to make that transfer easier.

All previous versions of this software required a locally-mounted writeable directory that a Jive deployment could use for instance-specific storage. This directory must be migrated to the new Jive-managed environment controlled by the package installation.

Export the Existing jiveHome Directory

To make moving the home directory easier, Jive includes an export tool you can execute on the current host where the home directory resides. This export tool is packaged as a Java JAR file that you can execute directly from any Java 1.5-compliant Java Runtime Environment. This tool is intended to be executed with the JRE used to host the existing instance.

You'll find the tool in a package installation on the target host at:

/usr/local/jive/bin/export/export.jar
  1. Locate the export tool in a package installation on the target host at:
    /usr/local/jive/bin/export/export.jar
  2. Copy this file to the source host containing the existing home directory:
    [1638][jive@targethost:~/bin/export]$ scp export.jar root@oldhost:
    root@oldhost's password:
    export.jar
  3. From the source machine, use the export tool to archive the existing home directory (formerly referred to as jiveHome) from the file system.

    Note: Before invoking the following commands, be sure to stop the current instance (stopping an existing instance will depend on the current application server).

    You should invoke the export tool from a command shell (for Windows cmd.exe, for Unix or Linux any standard shell). Commonly, the java command will be on the path of the shell executing the command. If it's not, prefix the following examples with the full path to a Java 1.5 JRE on the local system.

    To invoke the export tool, pass the “-jar <path_to_export.jar>” option to the java command in the working shell, as well as the path to the current home directory.

    For example, the following commands demonstrate how to export the home directory at “/usr/local/jive/jiveHome” when the “java” command is on the local user’s path:

    root@oldhost ~/opt/jive/home $ cd /home/eonnen/opt/jive/home/
    root@oldhost ~/opt/jive/home $ java -jar export.jar csc csc.zip

    For detailed export instructions, the “--help” option may be passed to the command which results in the following output:

    root@oldhost ~ $ cd opt/jive/home/
    root@oldhost ~/opt/jive/home $ java -jar export.jar --help
    usage: java -jar export.jar [options] jive_home archive_output
    
    Where jive_home is the path to the existing jive home directory and
    archive_output is the path where the export archive will be written.
     -a,--all          Include all artifacts in the existing jive home.
     -c,--caches       Include local attachment and plugin caches [default
                       disabled].
     -h,--help         Display this message.
     -i,--indexes      Include calculated search indexes [default disabled].
     -l,--logs         Include log files [default disabled].
     -o,--overwrite    Overwrite an existing artifact if one exists [default
                       disabled].
     -v,--verbose      Be verbose.
     -x,--no-exports   Do not include database exports [default enabled].
     -z,--no-themes    Do not include themes [default enabled].
    
    
    Home directory is required.

    In most cases, you should use the “--all” option. In large deployments, the size of index files may be too large to copy practically across a network. If this is the case, you can specify the “--indexes" option to exclude the index files from the export.

Import the Contents of the jiveHome Directory

After you complete the preceding export step, you should copy the exported file to the installation host where the Jive platform was installed.

  1. Before using the export, make sure the target application is stopped. In a default Jive Platform package installation, a single application named “sbs” will be running. Stop this application by using the “appstop” command as the jive user.
    [root@targethost ~]# su - jive
    [1055][jive@targethost:~]$ appstop --verbose sbs
    Stopping sbs...
    Executing /usr/local/jive/applications/sbs/bin/manage stop
    sbs stopped successfully.
  2. After stopping the application, back up the existing home directory installed with the package. Unzip the exported home directory to the application’s home directory. In a standard package installation, the application’s home directory will be “/usr/local/jive/applications/sbs/home”. In the following example, the csc.zip archive of the exported home is located in the user’s home directory and is readable by the jive user.
    [root@targethost ~]# su - jive
    [1104][jive@targethost:~]$ appstop --verbose sbs
    Stopping sbs...
    Executing /usr/local/jive/applications/sbs/bin/manage stop
    sbs stopped successfully.
    sbs stopped successfully.
    [1104][jive@targethost:~]$ cd applications/sbs/home/
    [1104][jive@targethost:~/applications/sbs/home]$ cd ~
    [1104][jive@targethost:~]$ cd applications/sbs
    [1105][jive@targethost:~/applications/sbs]$ ll
    total 16K
    lrwxrwxrwx  1 jive jive   49 Jan 20 15:52 application 
        -> /usr/local/jive/applications/template/application
    drwxr-x---  2 jive jive 4.0K Jan 20 15:52 bin
    drwxr-x---  2 jive jive 4.0K Jan 20 15:51 conf
    drwxr-x--- 16 jive jive 4.0K Jan 22 11:02 home
    -rw-r--r--  1 jive jive  694 Jan 20 15:20 README
    [1105][jive@targethost:~/applications/sbs]$ mv home home.bak
    [1106][jive@targethost:~/applications/sbs]$ mkdir home
    [1107][jive@targethost:~/applications/sbs]$ cd home
    [1107][jive@targethost:~/applications/sbs/home]$ unzip ~/csc.zip 
    Archive:  /usr/local/jive/csc.zip
    [1108][jive@targethost:~/applications/sbs/home]$ ll
    total 32K
    drwxr-xr-x 2 jive jive 4.0K Jan 22 11:08 conf
    drwxr-xr-x 2 jive jive 4.0K Jan 22 11:08 database
    drwxr-xr-x 2 jive jive 4.0K Jan 22 11:08 geoip
    -rw-r--r-- 1 jive jive  958 Jan 22  2009 jive.license
    -rw-r--r-- 1 jive jive 1.7K Jan 22  2009 jive_startup.xml
    drwxr-xr-x 3 jive jive 4.0K Jan 22 11:08 resources
    drwxr-xr-x 2 jive jive 4.0K Jan 22 11:08 spelling
    drwxr-xr-x 3 jive jive 4.0K Jan 22 11:08 themes