Installation"
From Documentation
| Line 1: | Line 1: | ||
{{ZKStudioEssentialsPageHeader}} | {{ZKStudioEssentialsPageHeader}} | ||
| + | |||
| + | |||
== Support Version == | == Support Version == | ||
| − | Eclipse 3.7, Eclipse 3.6, Eclipse 3.5. | + | Eclipse 4.2, Eclipse 3.7, Eclipse 3.6, Eclipse 3.5. |
== Prerequisite == | == Prerequisite == | ||
| Line 8: | Line 10: | ||
=== Java SE Development Kit (JDK) === | === Java SE Development Kit (JDK) === | ||
Java version 5 or 6 is required in order to run Eclipse, you can download either of them by following the links below: | Java version 5 or 6 is required in order to run Eclipse, you can download either of them by following the links below: | ||
| − | + | * JDK: [http://www.oracle.com/technetwork/java/javase/downloads/index.html Java SE Downloads] | |
| − | JDK | + | ** select which '''''Java SE Development Kit (JDK)''''' you want to download, please do '''NOT''' select the JRE. |
| − | :[http://www.oracle.com/technetwork/java/javase/downloads/index.html Java SE Downloads] | + | * Installation Instructions: [http://www.oracle.com/technetwork/java/javase/index-137561.html Platform Installation] |
| − | |||
| − | select which | ||
| − | |||
| − | |||
| − | Installation Instructions | ||
| − | |||
| − | :[http://www.oracle.com/technetwork/java/javase/index-137561.html Platform Installation] | ||
| − | |||
| − | |||
=== Eclipse IDE for Java EE Developers === | === Eclipse IDE for Java EE Developers === | ||
| − | ZK-Studio is an Eclipse Plug-in, therefore you must install Eclipse. We recommend using the | + | ZK-Studio is an Eclipse Plug-in, therefore you must install Eclipse. We recommend using the '''''Eclipse IDE for Java EE Developers''''' package, currently [http://www.eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/junosr1 v4.2 (Juno)], [http://www.eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/indigosr2 v3.7 (Indigo)], and [http://www.eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/heliossr1 v3.6 (Helios)]. |
'''Install:''' | '''Install:''' | ||
| − | + | * Extract "eclipse" from the downloaded zip file to a location of your choice. To make sure Eclipse can run on your system, execute '''eclipse.exe''' (in Windows) or '''eclipse''' (in Unix or Linux). You can locate these files in your extracted eclipse folder. | |
| − | Extract "eclipse" from the downloaded zip file to a location of your choice. To make sure Eclipse can run on your system, execute '''eclipse.exe''' (in | + | * We recommend setting Eclipse's default JRE to JDK, please refer to the '''''Setup/Preferences''''' section in [http://www.eclipse.org/webtools/community/tutorials/BuildJ2EEWebApp/BuildJ2EEWebApp.html WTP Tutorials – Building and Running a Web Application]. |
| − | |||
| − | We recommend setting Eclipse's default JRE to JDK, please refer to the Setup/Preferences section in [http://www.eclipse.org/webtools/community/tutorials/BuildJ2EEWebApp/BuildJ2EEWebApp.html | ||
'''Tips:''' | '''Tips:''' | ||
| − | + | # We recommend modifying some parameters in the configuration file eclipse.ini which will result in performance gain, please refer [http://www.eclipsezone.com/eclipse/forums/t61618.html here] and [http://blog.xam.dk/archives/68-Eclipse-and-memory-settings.html here]. | |
| − | + | # We also recommend using the Java Development Kit (JDK) as the default JRE for Eclipse IDE, please follow [[Setting_Default_JRE_In_Eclipse#Setup_Default_JRE_as_JDK | these instructions]] to make the JDK the default JRE. | |
| − | |||
| − | |||
| − | |||
| − | |||
=== Application Servers === | === Application Servers === | ||
| Line 42: | Line 29: | ||
'''Install:''' | '''Install:''' | ||
| − | + | : Download the zip file of Tomcat distribution and extract it to a proper location (with no illegal characters or space in the path). Tomcat requires configuration before it can be used with Eclipse, this process is described in the following link [[ZK_Studio_Essentials/Begin_Your_First_ZK_Project/Create_a_New_ZK_Project#Running_the_ZUL_File | Running the ZUL File]]. | |
| − | Download the zip file of Tomcat distribution and extract it to a proper location (with no illegal characters or space in the path). Tomcat requires configuration before it can be used with Eclipse, this process is described in the following link [[ZK_Studio_Essentials/Begin_Your_First_ZK_Project/Create_a_New_ZK_Project#Running_the_ZUL_File | Running the ZUL File]]. | ||
'''Tips:''' | '''Tips:''' | ||
| − | + | : If you not only want to develop Web Applications, but also need to deploy them on Apache Tomcat, links to the official installation instructions for directly running Apache Tomcat in your environment are provided below: | |
| − | If you not only want to develop Web Applications, but also need to deploy them on Apache Tomcat, links to the official installation instructions for directly running Apache Tomcat in your environment are provided below: | + | :* Tomcat 7: http://tomcat.apache.org/tomcat-7.0-doc/setup.html |
| − | + | :* Tomcat 6: http://tomcat.apache.org/tomcat-6.0-doc/setup.html | |
| − | |||
| − | |||
| − | : | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Installation Guide == | == Installation Guide == | ||
| − | + | ZK Studio can be installed by using either the online installation with the update site URL, or by downloading the offline installation zip file provided [http://www.zkoss.org/download/zkstudio here] and following the Offline Installation Guide. | |
| − | ZK Studio can be installed by using either the online installation with the update site URL, or by downloading the offline installation zip file provided [http://www.zkoss.org/download/zkstudio | ||
| − | |||
=== Marketplace (Since Eclipse 3.6) === | === Marketplace (Since Eclipse 3.6) === | ||
| − | Since Eclipse 3.6, marketplace is another way to install plugin. In menu: '''Help -> Eclipse Markpetplace''' and search '''zk studio''' you'll find '''ZK Studio''' to install. | + | Since Eclipse 3.6, marketplace is another way to install plugin. In menu: '''Help -> Eclipse Markpetplace''' and search '''"zk studio"''' you'll find '''ZK Studio''' to install. |
[[Image:Eclipse36_marketplace.png]] | [[Image:Eclipse36_marketplace.png]] | ||
| − | === | + | === Update Site URL === |
| − | Since Eclipse 3.7 and the Studio Service update, the new URL format is '''http://studio.zkoss.org/resource/plugins/eclipse_ver/''' | + | Since Eclipse 3.7 and the Studio Service update, the new URL format is '''''<nowiki>http://studio.zkoss.org/resource/plugins/eclipse_ver</nowiki>''''' |
| − | + | * The URL of ZK Studio for Eclipse 4.2: http://studio.zkoss.org/resource/plugins/eclipse_4_2 | |
| − | The URL of ZK Studio for Eclipse 3.7: | + | * The URL of ZK Studio for Eclipse 3.7: http://studio.zkoss.org/resource/plugins/eclipse_3_7 |
| − | + | * The URL of ZK Studio for Eclipse 3.6: http://studio.zkoss.org/resource/plugins/eclipse_3_6 | |
| − | The URL of ZK Studio for Eclipse 3.6: | + | * The URL of ZK Studio for Eclipse 3.5: http://studio.zkoss.org/resource/plugins/eclipse_3_5 |
| − | |||
| − | The URL of ZK Studio for Eclipse 3.5: | ||
[[Image:zkstudio_installation_36_2.png]] | [[Image:zkstudio_installation_36_2.png]] | ||
| Line 81: | Line 55: | ||
=== Online Installation on Eclipse=== | === Online Installation on Eclipse=== | ||
| − | + | # Open Eclipse, click the '''[Help]''' menu and select '''[Install New Software...]'''. A install window popup and then click '''Add''' button. | |
| − | + | #: [[Image:zkstudio_installation_35_1.png|800px]] | |
| − | [[Image:zkstudio_installation_35_1. | + | # Name the site as '''"ZK Studio"''' and copy corresponding update site's URL (for example, http://studio.zkoss.org/resource/plugins/eclipse_3_7 when using Eclipse 3.7) into '''Location''' field and click '''OK''' button. |
| − | + | #: [[Image:zkstudio_installation_35_2.png]] | |
| − | + | # Expand the '''ZK Studio Update''' entry, check '''ZK Studio''' and then click '''Next''' button. | |
| − | + | #: [[Image:zkstudio_installation_35_3.png|800px]] | |
| − | [[Image:zkstudio_installation_35_2. | + | #: The Eclipse Installation System will now attempt to retrieve information from the update site. This will take some time depending on your eclipse environment, please be patient. |
| − | + | # Click '''Next''' button on the pop-up install wizard dialog. | |
| − | + | #: [[Image:zkstudio_installation_35_4.png|800px]] | |
| − | + | #: Check '''"I accept the terms of the license agrement"''' and click '''Finish''' button on the wizard dialog. | |
| − | [[Image:zkstudio_installation_35_3. | + | #: [[Image:zkstudio_installation_35_4_licenses.png|800px]] |
| − | + | #: The Installation process will now begin. | |
| − | :The Eclipse Installation System will now attempt to retrieve information from the update site. This will take some time depending on your eclipse environment, please be patient. | + | #: [[Image:zkstudio_installation_35_5.png]] |
| − | + | #: If there is a pop-up dialog with unsigned content warning, please click '''OK''' button to continue. | |
| − | + | #: [[Image:zkstudio_installation_35_5_warning.png]] | |
| − | + | # Once the installation is complete, please restart Eclipse as prompted. | |
| − | + | #: [[Image:zkstudio_installation_35_6.png]] | |
| − | |||
| − | [[Image:zkstudio_installation_35_4. | ||
| − | |||
| − | :The Installation process will now begin. | ||
| − | |||
| − | [[Image:zkstudio_installation_35_5. | ||
| − | |||
| − | : | ||
| − | |||
| − | [[Image:zkstudio_installation_35_6. | ||
=== Offline Installation on Eclipse === | === Offline Installation on Eclipse === | ||
| − | + | # Download the offline installation zip file [http://www.zkoss.org/download/zkstudio here] | |
| − | + | # The following steps are much like [[#Online_Installation_on_Eclipse|Online Installation on Eclipse]]. But click '''Archive...''' button in '''step 2'''. Then, use file explorer to choose downloaded file in previous step. | |
| − | + | #: [[Image:zkstudio_installation_35_manual_2.png]] | |
| − | |||
| − | |||
| − | [[Image:zkstudio_installation_35_manual_2. | ||
== Activate ZK Studio == | == Activate ZK Studio == | ||
| − | + | In Eclipse's menu, please choose '''[Help]''' and select '''[Activate ZK Studio]'''. A dialog will show: | |
| − | In Eclipse's | ||
| − | |||
[[Image:Studio_activation_dialog.png]] | [[Image:Studio_activation_dialog.png]] | ||
| + | * Please input your account and password in [http://www.zkoss.org/forum/ ZK Forum] to activate ZK Studio. | ||
| + | * If you have to connect the internet through proxy, you may setup proxy URL and port to make it work. | ||
| − | + | Since ZK Studio 1.0.1, user still have full featured ZK Studio even if not activated. But it will prompt to activate every 7 days. | |
| − | |||
| − | |||
| − | |||
| − | Since ZK Studio 1.0.1, user still have full featured ZK Studio even if not activated. But it will prompt to activate every 7 days. | ||
== Trouble Shooting == | == Trouble Shooting == | ||
| Line 135: | Line 92: | ||
=== WTP not installed === | === WTP not installed === | ||
| − | If you get the following error message while installing ZK Studio, that means you are not using Eclipse for J2EE user , and you need to install [http://www.eclipse.org/webtools | + | If you get the following error message while installing ZK Studio, that means you are not using Eclipse for J2EE user , and you need to install [http://www.eclipse.org/webtools Eclipse WTP] plug-in manually or download Eclipse for J2EE. |
<pre> | <pre> | ||
Revision as of 06:06, 17 October 2012
Support Version
Eclipse 4.2, Eclipse 3.7, Eclipse 3.6, Eclipse 3.5.
Prerequisite
There are three pieces of software that you need to download and install in order to use ZK Studio.
Java SE Development Kit (JDK)
Java version 5 or 6 is required in order to run Eclipse, you can download either of them by following the links below:
- JDK: Java SE Downloads
- select which Java SE Development Kit (JDK) you want to download, please do NOT select the JRE.
- Installation Instructions: Platform Installation
Eclipse IDE for Java EE Developers
ZK-Studio is an Eclipse Plug-in, therefore you must install Eclipse. We recommend using the Eclipse IDE for Java EE Developers package, currently v4.2 (Juno), v3.7 (Indigo), and v3.6 (Helios).
Install:
- Extract "eclipse" from the downloaded zip file to a location of your choice. To make sure Eclipse can run on your system, execute eclipse.exe (in Windows) or eclipse (in Unix or Linux). You can locate these files in your extracted eclipse folder.
- We recommend setting Eclipse's default JRE to JDK, please refer to the Setup/Preferences section in WTP Tutorials – Building and Running a Web Application.
Tips:
- We recommend modifying some parameters in the configuration file eclipse.ini which will result in performance gain, please refer here and here.
- We also recommend using the Java Development Kit (JDK) as the default JRE for Eclipse IDE, please follow these instructions to make the JDK the default JRE.
Application Servers
Before developing web applications in Java using the ZK Ajax Framework, you need to install an application server. Apache Tomcat is one of the most popular Web containers. Tomcat versions 6 and 7 are supported and can be downloaded at the following link http://tomcat.apache.org/.
Install:
- Download the zip file of Tomcat distribution and extract it to a proper location (with no illegal characters or space in the path). Tomcat requires configuration before it can be used with Eclipse, this process is described in the following link Running the ZUL File.
Tips:
- If you not only want to develop Web Applications, but also need to deploy them on Apache Tomcat, links to the official installation instructions for directly running Apache Tomcat in your environment are provided below:
Installation Guide
ZK Studio can be installed by using either the online installation with the update site URL, or by downloading the offline installation zip file provided here and following the Offline Installation Guide.
Marketplace (Since Eclipse 3.6)
Since Eclipse 3.6, marketplace is another way to install plugin. In menu: Help -> Eclipse Markpetplace and search "zk studio" you'll find ZK Studio to install.
Update Site URL
Since Eclipse 3.7 and the Studio Service update, the new URL format is http://studio.zkoss.org/resource/plugins/eclipse_ver
- The URL of ZK Studio for Eclipse 4.2: http://studio.zkoss.org/resource/plugins/eclipse_4_2
- The URL of ZK Studio for Eclipse 3.7: http://studio.zkoss.org/resource/plugins/eclipse_3_7
- The URL of ZK Studio for Eclipse 3.6: http://studio.zkoss.org/resource/plugins/eclipse_3_6
- The URL of ZK Studio for Eclipse 3.5: http://studio.zkoss.org/resource/plugins/eclipse_3_5
Online Installation on Eclipse
- Open Eclipse, click the [Help] menu and select [Install New Software...]. A install window popup and then click Add button.
- Name the site as "ZK Studio" and copy corresponding update site's URL (for example, http://studio.zkoss.org/resource/plugins/eclipse_3_7 when using Eclipse 3.7) into Location field and click OK button.
- Expand the ZK Studio Update entry, check ZK Studio and then click Next button.
- The Eclipse Installation System will now attempt to retrieve information from the update site. This will take some time depending on your eclipse environment, please be patient.
- Click Next button on the pop-up install wizard dialog.
- Check "I accept the terms of the license agrement" and click Finish button on the wizard dialog.
- The Installation process will now begin.
- If there is a pop-up dialog with unsigned content warning, please click OK button to continue.
- Once the installation is complete, please restart Eclipse as prompted.
Offline Installation on Eclipse
- Download the offline installation zip file here
- The following steps are much like Online Installation on Eclipse. But click Archive... button in step 2. Then, use file explorer to choose downloaded file in previous step.
Activate ZK Studio
In Eclipse's menu, please choose [Help] and select [Activate ZK Studio]. A dialog will show:
- Please input your account and password in ZK Forum to activate ZK Studio.
- If you have to connect the internet through proxy, you may setup proxy URL and port to make it work.
Since ZK Studio 1.0.1, user still have full featured ZK Studio even if not activated. But it will prompt to activate every 7 days.
Trouble Shooting
Can't activate in Spring Tool Suite 2.6.0
Spring tool suite 2.6 series asks that encrypt/decrypt library must be signed by trusted source. You must modify java.security file to enable the license management of ZK Studio (Bouncy Castle Cryptography Provider). Please refer to JCE Authenticate Provider for more information.
WTP not installed
If you get the following error message while installing ZK Studio, that means you are not using Eclipse for J2EE user , and you need to install Eclipse WTP plug-in manually or download Eclipse for J2EE.
Cannot complete the install because one or more required items could not be found. Software currently installed: ZK Studio Eclipse Plugins 0.9.6.v200912041237 (org.zkoss.eclipse.feature.group 0.9.6.v200912041237) Missing requirement: ZK Studio Storage Plug-in 0.9.6.v200912041237 (org.zkoss.eclipse.zks 0.9.6.v200912041237) requires 'bundle org.eclipse.wst.common.project.facet.ui 0.0.0' but it could not be found Cannot satisfy dependency: From: ZK Studio Eclipse Plugins 0.9.6.v200912041237 (org.zkoss.eclipse.feature.group 0.9.6.v200912041237) To: org.zkoss.eclipse.ve [0.9.6.v200912041237] Cannot satisfy dependency: From: ZK Studio Visual Editor Plug-in 0.9.6.v200912041237 (org.zkoss.eclipse.ve 0.9.6.v200912041237) To: bundle org.zkoss.eclipse.zks 0.0.0