Before you begin, back up your data. The ScrumWorks Pro upgrade procedure modifies your existing MySQL database. After the upgrade starts, the database will no longer work correctly with the older version of ScrumWorks Pro.

Please refer to the backup documentation.

Existing customers can obtain the latest stable version of ScrumWorks Pro Mac OS X / MySQL distribution from the ScrumWorks Pro download web site. Note, the same binaries are used for both upgrades and fresh installations.

1. Open the ScrumWorks Pro download web site in a web browser.
2. Enter your Case ID number and the maximum users in your license. These two values can be found by opening the license file in a text editor. Alternatively, existing customers will find the values for the "Case ID" and "Licensed Users" in the "Help > About" menu in the Desktop Client.
3. Select the latest Mac OS X platform MySQL distribution and download. The distribution file is an archive named:
   scrumworks-pro-[version]-mac_linux.tar.bz2

The existing ScrumWorks Pro service must be shutdown prior to running the setup program in the next step. This is done one of two ways, depending on whether you've configured ScrumWorks Pro server to run as a background daemon or a foreground process (started manually via the shell prompt):

• If it is running in the foreground, "CTRL-c" stops it.
• If it is running as a daemon, use root privileges:
  # launchctl stop scrumworks

The ScrumWorks Pro server upgrade process requires that you install a parallel instance of ScrumWorks Pro server. Your data is upgraded migration during the installation process automatically; do not manually copy your data files into your new installation.

1. Extract the file into a new ScrumWorks Pro server directory.
   tar -jxvf scrumworks-pro-[version]-mac_linux.tar.bz2
2. Change to the directory that was created during extraction.
3. Make sure your existing ScrumWorks Pro server installation is completely shutdown.

4. Run with root privileges:
   # ./setup.sh

   Follow the prompts to download the required third-party files. These files are necessary for a successful installation of ScrumWorks Pro (your server has no internet access).

5. You will be asked if this is an upgrade. Answer "y". When prompted, enter the path to the root of your old ScrumWorks installation.
6. The upgrade process will copy and upgrade your existing data into your new installation of ScrumWorks Pro. Your existing data will not be affected, so if you choose to abort the upgrade process, your old installation of ScrumWorks will remain intact.

7. After the upgrade is complete, ScrumWorks can be started. If you chose to run as a daemon background process, the server will be started automatically. If you chose to run as a foreground process:

   cd /path/to/scrumworks-version/bin
./scrumworks.sh
8. In the future, if you wish to change whether ScrumWorks Pro runs as a daemon, shut down the server and run setup.sh again. During the setup.sh script, indicate whether ScrumWorks Pro starts as a daemon or not.

Note: If you have made changes to the ports that ScrumWorks runs on, please see our port configuration documentation.

Your upgraded ScrumWorks Pro server can be accessed via a web browser once the ScrumWorks Pro starts. It may take a few minutes for the service to start, so please be patient. Once the server is up, open a web browser on the local machine and point to:

http://localhost:8080/scrumworks/

In the page footer, confirm the ScrumWorks Pro release number.

Server Log

INSTALLDIR/server/scrumworks/log/server.log

Please see our Support Resources with any questions or issues.

• JBoss Application Server 6.0.0 - For more information about the JBoss Application Server, please see the JBoss website.
• Apache HttpClient 4.1.1 - For more information about Apache HttpClient, please see the Apache website.
• Apache HttpCore 4.1 - For more information about Apache HttpCore, please see the Apache website.
• Apache HttpMime 4.1.1 - For more information about Apache HttpMime, please see the Apache website.
• Apache POI - For more information, please see the Apache POI website.
• Apache Poi-ooxml (For XML-based Excel Spreadsheet Support) - For more information, please see the Apache POI website.
• Apache Poi-ooxml-schemas (For XML-based Excel Spreadsheet Support) - For more information, please see the Apache POI website.

1. Stop the ScrumWorks Pro Server
• If it's running in the foreground, Ctrl-C stops it.
• If it is running as a daemon:
  # launchctl stop scrumworks
# launchctl unload /Library/LaunchDaemons/scrumworks.plist

2. Copy the database if you wish to keep the data
3. Remove the ScrumWorks Pro Server directory