Deskzilla Readme
Last edited: March 25, 2010
http://almworks.com/deskzilla


Contents
========
* System Requirements
* Installation
* Upgrading
* Uninstall
* Backup and Restore
* Trademarks and Copyright


System Requirements
===================

1. Server: Bugzilla 2.14 - 3.6+

   You can install Deskzilla to access already existing Bugzilla installations,
   such as publicly available Bugzilla servers for numerous open-source 
   projects. If you plan to start your own server, you should install Bugzilla
   first. (See also our Virtual Bugzilla Server, http://almworks.com/vbs)

2. Additional server authentication: Basic HTTP, Digest, NTLM (version 1 or 2) 

3. Operating System: Microsoft Windows XP/Vista/7, Linux (with Sun JRE),
   Mac OS X, or any other supported by Java;

4. System Memory: 256MB required, 512MB recommended;

5. Hard Drive Space: 150MB required, 300MB recommended;

6. Screen Resolution: 1024x768 or better;

7. Displays: multiple displays are supported, but Deskzilla should be 
   restarted when a display is connected or disconnected;

8. Network connection: on initial setup, Deskzilla may have to load a lot 
   from Bugzilla, so performance over slow network connection may be 
   degraded. (Hint: turn on gzip compression on the web-server that hosts
   Bugzilla.)

9. Java: In case you downloaded a distribution without Java bundled in, you
   will need Java SE 6 or later. 


Installation - Windows
======================

To install the application, run downloaded executable file and follow 
instructions. If having problems installing on Windows Vista/7, use
"Run as Administrator" to start the installer.


Installation - Linux
====================

To install the application, unpack downloaded archive. Run 
  bin/deskzilla.sh 
to start Deskzilla. 

Deskzilla will create ".Deskzilla" subdirectory in your home 
directory. Make sure the home is writable.


Installation - Mac OS X
=======================

Supported versions:

- Mac OS X 10.5 (Leopard): Mac OS X 10.5.2 and above with
Java for Mac OS X 10.5 Update 1 and above (64-bit Intel-based Macs);

- Mac OS X 10.6 (Snow Leopard): 32-bit and 64-bit Intel-based Macs.

To check Java SE 6 availability on your Mac, run "Java Preferences" application.
On the General tab look for "Java SE 6" under "Java Applications".

Application may be run from the dmg image. It will create ".Deskzilla"
subdirectory in your home directory. Make sure the home is writable.


Upgrading
=========

1. Stop Deskzilla if it is running;

2. Back up your workspace; 
   See http://wiki.almworks.com/display/kb/How+to+Backup+Your+Workspace

3. Uninstall Deskzilla using "Uninstall" menu item on Windows start menu, or by
   deleting all files in the installation folder.

3. Install and run the new version.


Troubleshooting Upgrade
======================= 

There had been incidents in the past that after an upgrade the database indices 
became corrupt. Deskzilla should detect this situation, drop indices and show 
the user an error dialog that suggests to restart the application. 

If Deskzilla does not detect corrupt indices but all queries are shown as grey
and unrunnable, you may drop indices manually. To do so, run Deskzilla 
with -Ddrop.indexes option:

On Windows:
   deskzilla.exe -J-Ddrop.index=true

On other operating systems:
   java -Ddrop.index=true -jar deskzilla.jar


Uninstall
=========

To uninstall Deskzilla on Windows, run uninstaller from 
Control Panel - Add/Remove Programs.

To uninstall JIRA Client on other operating systems, just delete Deskzilla
home directory.

NOTE: Deskzilla workspace (queries, local database, etc.) usually 
resides in a separate directory. Uninstallation should not affect it.


Backup and Restore
==================

See also: http://wiki.almworks.com/display/kb/How+to+Backup+Your+Workspace

All user information is contained within workspace directory. By default,
it is named ".Deskzilla" and it resides in the user's home directory.
(Something like /home/username/.Deskzilla on Unix or 
 C:\Users\username\.Deskzilla on Windows)

To back if up, just copy all of its contents to a directory of your choice. 

To restore from backed up workspace, delete or move current workspace and
copy back the workspace that you have saved earlier. 

NOTE: You must shut down Deskzilla to perform backup and restore.


Trademarks and Copyright
========================

Mozilla(TM) and Bugzilla(TM) are trademarks of the Mozilla Foundation 
in the United States and other countries.

Sun, Sun Microsystems, Java are trademarks of Sun Microsystems, Inc.

Microsoft, Windows are trademarks of Microsoft Corporation.

All other trademarks mentioned in Deskzilla product, documentation and other
files are the property of their respective owners.

Deskzilla is copyright (C) ALM Works Ltd 2004-2010

All files included in this software distribution package are subject to 
copyright by ALM Works Ltd and its licensors.
