• Mac OS X 10.5.2+
• An Internet connection to download third-party files required by ScrumWorks Pro. If you do not have an Internet connection, please see below.
• Java for Mac version 6.0. To download Java for Mac 6.0, please see Apple's Java web site.
• The host server will require about 700 MB of space initially, a minimum of 2 GB of RAM, and dual CPU cores.

The MySQL distribution of ScrumWorks Pro allows use of the MySQL database. Before installing the MySQL distribution of ScrumWorks Pro, please read the MySQL requirements and configuration guide.

MySQL is recommended for large production ScrumWorks Pro instances, but requires systems administration knowledge to set up. The Hypersonic distribution is intended for quick and easy set up. If you wish to transfer from a Hypersonic to a MySQL database, please read the Hypersonic-to-MySQL transfer documentation.

Caution: once transferred to MySQL, ScrumWorks Pro data cannot be transferred back to Hypersonic.

Evaluators

Please request a trial license. You will receive an email with instructions on how to obtain ScrumWorks Pro.

Existing Customers

Existing customers can obtain the latest stable version of ScrumWorks Pro Mac OS X 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 distribution and download. The distribution file is an archive named:
   scrumworks-pro-[version]-mac_linux.tar.bz2

1. Extract the file into the directory in which you want to install ScrumWorks Pro.
   tar -jxvf scrumworks-pro-[version]-mac_linux.tar.bz2
2. Change to the directory that was created during extraction.

3. 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).

4. After the installation is complete, ScrumWorks will be started automatically. The ScrumWorks Pro setup.sh program has registered ScrumWorks Pro server as a "launchdaemon" meaning that ScrumWorks Pro server will start automatically on reboot. Use launchctl to manually start/stop the ScrumWorks Pro service:

   # launchctl start scrumworks
# launchctl stop scrumworks
5. 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.

1. Extract the file into the directory in which you want to install ScrumWorks Pro.
   tar -jxvf scrumworks-pro-[version]-mac_linux.tar.bz2
2. Change to the directory that was created during extraction.

3. As an unprivileged user, run:
   ./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).

4. After the upgrade is complete, ScrumWorks can be started as a foreground process with:

   cd /path/to/scrumworks-version/bin
./scrumworks.sh

5. Use "Ctrl-C" to stop the foreground ScrumWorks Pro server process.
6. 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.

Your installation 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/

If a web page loads with login options, your installation is successful, congratulations!

Continue on to the documentation on using the ScrumWorks Pro Desktop Client.

Server Log

INSTALLDIR/server/scrumworks/log/server.log

Log files are rotated once daily.

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.

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

The ports ScrumWorks Pro server listens to by default should be fine for most users. If you have pre-existing software installed on your machine, such as IIS or another copy of JBoss, you may need to change the ports ScrumWorks uses. Also, you may wish to add SSL security to your installation. Please refer to the port and SSL configuration guide.

By default, ScrumWorks Pro is permitted to use up to 768MB of memory. Please read the Performance Tuning Guide for instructions on changing the amount of memory used by the ScrumWorks Pro server.

You will need to restart the server for the changes to take effect.

Note that if the allocated memory is too large, the service will fail to start. In this case, the amount of allocated memory needs to be lowered. Please check with your Windows administrator for advice on adjusting ScrumWorks Pro server's memory allocation. For more information, please read Memory Management in ScrumWorks Pro.