Difference between revisions of "Zimbra Desktop Download and Install FAQ"

(How do I know which version/build I'm running?)
Line 1: Line 1:
====What are the prerequisites of installing and running YZD?====
+
====What are the prerequisites of installing and running ZD?====
:Before you start, you should check out the [http://wiki.zimbra.com/index.php?title=Yahoo!_Zimbra_Desktop Yahoo! Zimbra Desktop wiki page] where you can read about the latest release and known issues.
+
:Before you start, you should check out the [http://wiki.zimbra.com/index.php?title=Zimbra_Desktop Zimbra Desktop wiki page] where you can read about the latest release and known issues.
  
 
====Where do I download the installer?====
 
====Where do I download the installer?====
 
:Go [http://www.zimbra.com/products/desktop.html here] to download the installer for your platform.
 
:Go [http://www.zimbra.com/products/desktop.html here] to download the installer for your platform.
  
====What platforms do YZD support?====
+
====What platforms do ZD support?====
:YZD can run on Windows XP (x86), Windows Vista (x86), Mac OS X Tiger (Intel), Mac OS X Leopard (Intel), a variety of Linux (i686) flavors including Ubuntu, Debian, Fedora, Suse and others.
+
:ZD can run on Windows XP (x86), Windows Vista (x86), Mac OS X Tiger (Intel), Mac OS X Leopard (Intel), a variety of Linux (i686) flavors including Ubuntu, Debian, Fedora, Suse and others.
  
 
====Where is the install location?====
 
====Where is the install location?====
Line 16: Line 16:
 
:In the rest of this FAQ we will refer to the install location as <install>.
 
:In the rest of this FAQ we will refer to the install location as <install>.
  
====I installed a previous version of YZD.  Can I upgrade?====
+
====I installed a previous version of ZD.  Can I upgrade?====
 
:If you are running build 1083 or later, you can upgrade by simply running the installer of the latest release.  The installer will migrate existing data if necessary.  If you are running a version earlier than build 1083, you must first do a clean uninstall of the old version and delete all data on your computer before proceeding.
 
:If you are running build 1083 or later, you can upgrade by simply running the installer of the latest release.  The installer will migrate existing data if necessary.  If you are running a version earlier than build 1083, you must first do a clean uninstall of the old version and delete all data on your computer before proceeding.
  
====I'm an existing YZD user and today a dialog pops up asking me to upgrade.  What should I do?====
+
====I'm an existing ZD user and today a dialog pops up asking me to upgrade.  What should I do?====
:When running, YZD periodically checks for new updates.  If there is an update, it will ask the user to upgrade.  To start the upgrade, all you need to do is to click the Install button and follow the wizard.
+
:When running, ZD periodically checks for new updates.  If there is an update, it will ask the user to upgrade.  To start the upgrade, all you need to do is to click the Install button and follow the wizard.
  
 
====How do I know which version/build I'm running?====
 
====How do I know which version/build I'm running?====
:Run YZD.  All platforms: The main YZD has a "Commands" icon (a grey gear) in the bottom left of the main YZD window. On Windows YZD has a tray icon in the system tray.  Left-click on the  "Commands" Icon or right-click the tray icon and select About Yahoo! Zimbra Desktop.  The About dialog will show your version and build number.  Please remember to always include your version and build number when reporting issues.
+
:Run ZD.  All platforms: The main ZD has a "Commands" icon (a grey gear) in the bottom left of the main ZD window. On Windows ZD has a tray icon in the system tray.  Left-click on the  "Commands" Icon or right-click the tray icon and select About Zimbra Desktop.  The About dialog will show your version and build number.  Please remember to always include your version and build number when reporting issues.
  
 
====How to install spell checker dictionaries?====
 
====How to install spell checker dictionaries?====
:YZD includes one default spell checker dictionary of U.S. English (en-US). You may follow these steps to install dictionaries in other locales we support.
+
:ZD includes one default spell checker dictionary of U.S. English (en-US). You may follow these steps to install dictionaries in other locales we support.
  
 
:(1) Download the dictionaries from these links:
 
:(1) Download the dictionaries from these links:
Line 50: Line 50:
 
::    user_pref("spellchecker.dictionary", "en-GB");
 
::    user_pref("spellchecker.dictionary", "en-GB");
  
:(4) Restart YZD.
+
:(4) Restart ZD.
  
====How do I uninstall Yahoo! Zimbra Desktop?====
+
====How do I uninstall Zimbra Desktop?====
:You can uninstall Yahoo! Zimbra Desktop by running the uninstaller. The uninstaller is located under the folder where you installed the Yahoo! Zimbra Desktop software. On Windows you can also use "Add or Remove Programs" to uninstall.
+
:You can uninstall Zimbra Desktop by running the uninstaller. The uninstaller is located under the folder where you installed the Zimbra Desktop software. On Windows you can also use "Add or Remove Programs" to uninstall.
  
 
:(1) Run the uninstaller and follow the on-screen instructions.
 
:(1) Run the uninstaller and follow the on-screen instructions.
  
:(2) By default the uninstaller will only remove the software and will leave any downloaded data intact.  This allows future software upgrades without resyncing mailbox data from scratch.  If however you intend to delete all data as well, you can check the “DELETE ALL DATA” checkbox during uninstall.  Alternatively, you can first use the uninstaller to remove the software and then simply delete the entire folder where Yahoo! Zimbra Desktop was installed.
+
:(2) By default the uninstaller will only remove the software and will leave any downloaded data intact.  This allows future software upgrades without resyncing mailbox data from scratch.  If however you intend to delete all data as well, you can check the “DELETE ALL DATA” checkbox during uninstall.  Alternatively, you can first use the uninstaller to remove the software and then simply delete the entire folder where Zimbra Desktop was installed.
  
 
:(3) For a clean uninstall, make sure the existing install folder is completely removed.
 
:(3) For a clean uninstall, make sure the existing install folder is completely removed.
  
====I ran into an error when uninstalling Yahoo! Zimbra Desktop.  What do I do now?====
+
====I ran into an error when uninstalling Zimbra Desktop.  What do I do now?====
  
:Sometimes due to unexpected install failures, uninstall will fail. If the uninstall process fails, use the following steps to manually uninstall Yahoo! Zimbra Desktop.
+
:Sometimes due to unexpected install failures, uninstall will fail. If the uninstall process fails, use the following steps to manually uninstall Zimbra Desktop.
  
 
:'''NOTE''': These steps are for experienced users only.  If you are not comfortable with changing system settings, STOP!
 
:'''NOTE''': These steps are for experienced users only.  If you are not comfortable with changing system settings, STOP!
Line 71: Line 71:
 
:(1) Close the GUI client window.  The GUI client can minimize to tray, so make sure you actually quit it.  In Task Manager the name of the GUI client process is zdclient.exe.
 
:(1) Close the GUI client window.  The GUI client can minimize to tray, so make sure you actually quit it.  In Task Manager the name of the GUI client process is zdclient.exe.
  
:(2) Make sure that the Yahoo! Zimbra Desktop service is not running.  In Task Manager the name of the service is zdesktop.exe.  If it is, use the Service Manager to stop the service. If that fails to stop, you can use the Task Manager to stop the process.
+
:(2) Make sure that the Zimbra Desktop service is not running.  In Task Manager the name of the service is zdesktop.exe.  If it is, use the Service Manager to stop the service. If that fails to stop, you can use the Task Manager to stop the process.
  
:(3) Use the registry editor (regedt32) to remove the uninstaller entry in "Add or Remove Programs." Find and delete the Yahoo! Zimbra Desktop entry under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall.
+
:(3) Use the registry editor (regedt32) to remove the uninstaller entry in "Add or Remove Programs." Find and delete the Zimbra Desktop entry under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall.
  
:(4) Use the registry editor to remove the Window service. Find and delete the Yahoo! Zimbra Desktop entry under HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services.
+
:(4) Use the registry editor to remove the Window service. Find and delete the Zimbra Desktop entry under HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services.
  
 
:(5) Delete the installation directory.  Note that if you want to preserve mailbox data, don't delete these 3 folders: derby, store, index.
 
:(5) Delete the installation directory.  Note that if you want to preserve mailbox data, don't delete these 3 folders: derby, store, index.
Line 85: Line 85:
 
:(1) Close the GUI client window.
 
:(1) Close the GUI client window.
  
:(2) Make sure that the Yahoo! Zimbra Desktop service process is not running.  It is a java process.  If the service process is running, open a terminal window and cd into the install directory.  Then run the following at the command line:
+
:(2) Make sure that the Zimbra Desktop service process is not running.  It is a java process.  If the service process is running, open a terminal window and cd into the install directory.  Then run the following at the command line:
  
 
         ./zdesktop stop
 
         ./zdesktop stop
Line 103: Line 103:
 
:(1) Close the GUI client window.
 
:(1) Close the GUI client window.
  
:(2) Make sure that the Yahoo! Zimbra Desktop service process is not running.  It is a java process.  If the service process is running, open a terminal window and cd into the install directory.  Then run the following at the command line:
+
:(2) Make sure that the Zimbra Desktop service process is not running.  It is a java process.  If the service process is running, open a terminal window and cd into the install directory.  Then run the following at the command line:
  
 
         ./zdesktop stop
 
         ./zdesktop stop

Revision as of 17:45, 3 February 2010

What are the prerequisites of installing and running ZD?

Before you start, you should check out the Zimbra Desktop wiki page where you can read about the latest release and known issues.

Where do I download the installer?

Go here to download the installer for your platform.

What platforms do ZD support?

ZD can run on Windows XP (x86), Windows Vista (x86), Mac OS X Tiger (Intel), Mac OS X Leopard (Intel), a variety of Linux (i686) flavors including Ubuntu, Debian, Fedora, Suse and others.

Where is the install location?

While you can choose to install to any folder on your computer, the default location is under the home directory of your system. In particular, these are the default paths on their respective platforms.
  • Windows XP - C:\Documents and Settings\<username>\Local Settings\Application Data\Zimbra\zdesktop
  • Windows Vista - C:\Users\<username>\AppData\Local\Zimbra\zdesktop
  • Mac OS - /Users/<username>/zimbra/zdesktop
  • Linux - /home/<username>/zimbra/zdesktop
In the rest of this FAQ we will refer to the install location as <install>.

I installed a previous version of ZD. Can I upgrade?

If you are running build 1083 or later, you can upgrade by simply running the installer of the latest release. The installer will migrate existing data if necessary. If you are running a version earlier than build 1083, you must first do a clean uninstall of the old version and delete all data on your computer before proceeding.

I'm an existing ZD user and today a dialog pops up asking me to upgrade. What should I do?

When running, ZD periodically checks for new updates. If there is an update, it will ask the user to upgrade. To start the upgrade, all you need to do is to click the Install button and follow the wizard.

How do I know which version/build I'm running?

Run ZD. All platforms: The main ZD has a "Commands" icon (a grey gear) in the bottom left of the main ZD window. On Windows ZD has a tray icon in the system tray. Left-click on the "Commands" Icon or right-click the tray icon and select About Zimbra Desktop. The About dialog will show your version and build number. Please remember to always include your version and build number when reporting issues.

How to install spell checker dictionaries?

ZD includes one default spell checker dictionary of U.S. English (en-US). You may follow these steps to install dictionaries in other locales we support.
(1) Download the dictionaries from these links:
   da     Dansk
   de     Deutsch
   en-GB  English(UK)
   es-ES  Español(de España)
   fr     Français
   it     Italiano
   nl     Nederlands
   pl     Polski
   pt-BR  Português(do Brasil)
   ru     Русский
   sv     Svenska
(2) Unzip the dictionary package to the "dictionaries" directory. Depending on which OS you are running, the directory location is:
  • Windows: <install>\win32\prism\xulrunner\dictionaries
  • MacOS: <install>/macos/prism/Prism.app/Contents/Frameworks/XUL.framework/dictionaries
  • Linux: <install>/linux/prism/xulrunner/dictionaries
(3) Edit <install>/profile/user.js file and set correct locale to "spellchecker.dictionary" user preference. For example, if you want to use U.K. English dictionary, you should have this line in your user.js:
user_pref("spellchecker.dictionary", "en-GB");
(4) Restart ZD.

How do I uninstall Zimbra Desktop?

You can uninstall Zimbra Desktop by running the uninstaller. The uninstaller is located under the folder where you installed the Zimbra Desktop software. On Windows you can also use "Add or Remove Programs" to uninstall.
(1) Run the uninstaller and follow the on-screen instructions.
(2) By default the uninstaller will only remove the software and will leave any downloaded data intact. This allows future software upgrades without resyncing mailbox data from scratch. If however you intend to delete all data as well, you can check the “DELETE ALL DATA” checkbox during uninstall. Alternatively, you can first use the uninstaller to remove the software and then simply delete the entire folder where Zimbra Desktop was installed.
(3) For a clean uninstall, make sure the existing install folder is completely removed.

I ran into an error when uninstalling Zimbra Desktop. What do I do now?

Sometimes due to unexpected install failures, uninstall will fail. If the uninstall process fails, use the following steps to manually uninstall Zimbra Desktop.
NOTE: These steps are for experienced users only. If you are not comfortable with changing system settings, STOP!
On Windows
(1) Close the GUI client window. The GUI client can minimize to tray, so make sure you actually quit it. In Task Manager the name of the GUI client process is zdclient.exe.
(2) Make sure that the Zimbra Desktop service is not running. In Task Manager the name of the service is zdesktop.exe. If it is, use the Service Manager to stop the service. If that fails to stop, you can use the Task Manager to stop the process.
(3) Use the registry editor (regedt32) to remove the uninstaller entry in "Add or Remove Programs." Find and delete the Zimbra Desktop entry under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall.
(4) Use the registry editor to remove the Window service. Find and delete the Zimbra Desktop entry under HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services.
(5) Delete the installation directory. Note that if you want to preserve mailbox data, don't delete these 3 folders: derby, store, index.
(6) Reboot Windows. This is important for your registry updates to take effect.
On Mac OS
(1) Close the GUI client window.
(2) Make sure that the Zimbra Desktop service process is not running. It is a java process. If the service process is running, open a terminal window and cd into the install directory. Then run the following at the command line:
       ./zdesktop stop
If that fails to stop the service, you can terminate the process using the Activity Monitor GUI.
(3) Delete the install directory. Note that if you want to preserve mailbox data, don't delete these 3 folders: derby, store, index.
(4) In the terminal window type the following to remove the launched agent:
       launchctl stop com.zimbra.zdesktop
       launchctl remove com.zimbra.zdesktop
       rm ~/Library/LaunchAgents/com.zimbra.zdesktop.plist
On Linux
(1) Close the GUI client window.
(2) Make sure that the Zimbra Desktop service process is not running. It is a java process. If the service process is running, open a terminal window and cd into the install directory. Then run the following at the command line:
       ./zdesktop stop
(3) Delete the install directory. Note that if you want to preserve mailbox data, don't delete these 3 folders: derby, store, index.



Verified Against: N/A Date Created: 12/31/2008
Article ID: https://wiki.zimbra.com/index.php?title=Zimbra_Desktop_Download_and_Install_FAQ Date Modified: 2010-02-03



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search