Installation"

From Documentation
(update for zkstudio 2.0.0 release)
Line 2: Line 2:
  
  
−
== Support Version ==
+
= Prerequisite =
−
Eclipse 4.2, Eclipse 3.7, Eclipse 3.6, Eclipse 3.5.
+
There are some software you need to install before installing ZK Studio.
  
−
== Prerequisite ==
+
== Java SE Development Kit (JDK) ==
−
There are three pieces of software that you need to download and install in order to use ZK Studio.
+
Java version 5 or 6 is required in order to run Eclipse, you can download it from [http://www.oracle.com/technetwork/java/javase/downloads Oracle official site].
  
−
=== Java SE Development Kit (JDK) ===
+
== Eclipse IDE for Java EE Developers ==
−
Java version 5 or 6 is required in order to run Eclipse, you can download either of them by following the links below:
+
ZK Studio is an Eclipse Plug-in, therefore you must install Eclipse. We recommend the '''Eclipse IDE for Java EE Developers''' package. Currently [http://www.eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/junosr1 4.2 (Juno)] and [http://www.eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/indigosr2 3.7 (Indigo)] are supported.
−
* JDK: [http://www.oracle.com/technetwork/java/javase/downloads/index.html Java SE Downloads]
 
−
** select which '''''Java SE Development Kit (JDK)''''' you want to download, please do '''NOT''' select the JRE.
 
−
* Installation Instructions: [http://www.oracle.com/technetwork/java/javase/index-137561.html Platform Installation]
 
  
−
=== Eclipse IDE for Java EE Developers ===
+
'''Install:'''  
−
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)].
+
 
 +
Installation is done simply by extracting the downloaded zip file to a proper local folder. To make sure Eclipse can run on your system, execute <tt>eclipse.exe</tt> (in Windows) or <tt>eclipse</tt> (in Unix or Linux). You can locate these files in your extracted eclipse folder.
  
−
'''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 [http://www.eclipse.org/webtools/community/tutorials/BuildJ2EEWebApp/BuildJ2EEWebApp.html WTP Tutorials – Building and Running a Web Application].
 
  
 
'''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 recommend modifying some parameters in the configuration file <tt>eclipse.ini</tt> 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 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 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.
 
# 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 ==
−
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/ http://tomcat.apache.org/].
+
Before developing web applications in Java using ZK 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 [http://tomcat.apache.org Apache Tomcat].
  
 
'''Install:'''
 
'''Install:'''
Line 32: Line 30:
  
 
'''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 7: http://tomcat.apache.org/tomcat-7.0-doc/setup.html
 
:* Tomcat 6: http://tomcat.apache.org/tomcat-6.0-doc/setup.html
 
:* Tomcat 6: http://tomcat.apache.org/tomcat-6.0-doc/setup.html
  
−
== Installation Guide ==
+
= Install ZK Studio =
−
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_on_Eclipse|Offline Installation on Eclipse]].
+
ZK Studio can be installed in several ways. We recommend to install through Marketplace.
  
−
=== 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.
 
  
−
[[Image:Eclipse36_marketplace.png]]
+
== Marketplace (Since Eclipse 3.6) ==
 +
Marketplace is the easiest way to install plugins. Go to menu '''[Help] > [Eclipse Markpetplace]''' and search '''"zk studio"''' you'll find '''ZK Studio''' to install.
  
−
=== Update Site URL ===
+
[[Image:Eclipse36_marketplace.png | center | 500px]]
−
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
+
== Update Site==
−
* 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: 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
 
* The URL of ZK Studio for Eclipse 3.5: http://studio.zkoss.org/resource/plugins/eclipse_3_5
 +
-->
  
−
[[Image:zkstudio_installation_36_2.png]]
+
# Open Eclipse, click the '''[Help]''' menu and select '''[Install New Software...]'''.  A install window will popup, and then click '''Add'''
−
 
+
#: [[Image:zkstudio_installation_35_1.png| center | 600px]]
−
=== Online Installation on Eclipse===
+
#: <br/>
−
 
+
# Name the site as '''"ZK Studio"''' and copy corresponding update site's URL into '''Location''' field and click '''OK'''.
−
# Open Eclipse, click the '''[Help]''' menu and select '''[Install New Software...]'''.  A install window popup and then click '''Add''' button.
+
#: The URL of ZK Studio for Eclipse 4.2: http://studio.zkoss.org/resource/plugins/eclipse_4_2
−
#: [[Image:zkstudio_installation_35_1.png|800px]]
+
#: The URL of ZK Studio for Eclipse 3.7: http://studio.zkoss.org/resource/plugins/eclipse_3_7
−
# 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 | center | 500px]]
−
#: [[Image:zkstudio_installation_35_2.png]]
+
#: <br/>
−
# Expand the update entry of ZK Studio, check '''ZK Studio''' and then click '''Next''' button.
+
# Expand the update entry of ZK Studio, check '''ZK Studio''' and then click '''Next'''
−
#: [[Image:zkstudio_installation_35_3.png|800px]]
+
#: [[Image:zkstudio_installation_35_3.png| center | 600px]]
 
#: 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.
 
#: 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.
+
# Click '''Next''' on the pop-up install wizard dialog.
−
#: [[Image:zkstudio_installation_35_4.png|800px]]
+
#: [[Image:zkstudio_installation_35_4.png| center | 600px]]
−
#: Check '''"I accept the terms of the license agrement"''' and click '''Finish''' button on the wizard dialog.
+
#: <br/>
−
#: [[Image:zkstudio_installation_35_4_licenses.png|800px]]
+
#: Check '''"I accept the terms of the license agrement"''' and click '''Finish''' on the wizard dialog.
 +
#: [[Image:zkstudio_installation_35_4_licenses.png | center | 600px]]
 +
#: <br/>
 
#: The Installation process will now begin.
 
#: The Installation process will now begin.
−
#: [[Image:zkstudio_installation_35_5.png]]
+
#: [[Image:zkstudio_installation_35_5.png | center | 600px]]
−
#: If there is a pop-up dialog with unsigned content warning, please click '''OK''' button to continue.
+
#: <br/>
−
#: [[Image:zkstudio_installation_35_5_warning.png]]
+
#: If there is a pop-up dialog with unsigned content warning, please click '''OK''' to continue.
 +
#: [[Image:zkstudio_installation_35_5_warning.png | center | 500px]]
 +
#: <br/>
 
# Once the installation is complete, please restart Eclipse as prompted.
 
# Once the installation is complete, please restart Eclipse as prompted.
−
#: [[Image:zkstudio_installation_35_6.png]]
+
#: [[Image:zkstudio_installation_35_6.png | center | 500px]]
  
−
=== Offline Installation on Eclipse ===
+
== Offline Installation==
−
# Download the offline installation zip file [http://www.zkoss.org/download/zkstudio here]
+
# Download the offline installation zip file from [http://www.zkoss.org/download/zkstudio ZK Studio download page].
−
# 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.
+
# The step is the same as step 1 we do for [[# Update Site| Update Site]]. Open Eclipse, click '''[Help]''' menu and select '''[Install New Software...]'''. An install window will popup, click '''Add'''
−
#: [[Image:zkstudio_installation_35_manual_2.png]]
+
# Click '''Archive...''' to open a file explorer. Then, use file explorer to choose downloaded file and click "OK" to install.
 +
#: [[Image:zkstudio_installation_35_manual_2.png | center | 500px]]
  
 
== 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 menu, please choose '''[Help]''' and select '''[Activate ZK Studio]'''. A dialog will show up:
−
[[Image:Studio_activation_dialog.png]]
+
[[Image:Studio_activation_dialog.png | center | 500px]]
−
* Please input your account and password in [http://www.zkoss.org/forum/ ZK Forum] to activate ZK Studio.
+
* Please enter 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.
 
* 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.
+
  Activate ZK Studio to tell us you are using it and show your recognition for this product. If you don't want to activate, you can still use full-featured ZK Studio.
  
−
== Trouble Shooting ==  
+
= Trouble Shooting =
  
−
=== Can't activate in Spring Tool Suite 2.6.0 ===
+
== 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 [http://www.randombugs.com/java/javalangsecurityexception-jce-authenticate-provider-bc.html JCE Authenticate Provider] for more information.
 
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 [http://www.randombugs.com/java/javalangsecurityexception-jce-authenticate-provider-bc.html JCE Authenticate Provider] for more information.
  
−
=== 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 Eclipse WTP] plug-in manually or download Eclipse for J2EE.
+
If you get the following error message while installing ZK Studio, that means you are not using Eclipse for JavaEE Developers, and you need to install [http://www.eclipse.org/webtools Eclipse WTP] plug-in manually or download Eclipse for JavaEE Developers.
  
 
<pre>
 
<pre>
Line 103: Line 106:
 
To: bundle org.zkoss.eclipse.zks 0.0.0
 
To: bundle org.zkoss.eclipse.zks 0.0.0
 
</pre>
 
</pre>
 +
 +
==Still have problem?==
 +
Please contact [mailto:info@zkoss.org info@zkoss.org] if there's any issue after referencing the above note.
  
  
−
===Still have problem?===
 
−
Please contact [mailto:info@zkoss.org info@zkoss.org] if there's any issue after referencing the above note.
 
  
 
{{ZKStudioEssentialsPageFooter}}
 
{{ZKStudioEssentialsPageFooter}}

Revision as of 07:31, 9 April 2013

DocumentationZK Studio EssentialsInstallation
Installation




Prerequisite

There are some software you need to install before installing ZK Studio.

Java SE Development Kit (JDK)

Java version 5 or 6 is required in order to run Eclipse, you can download it from Oracle official site.

Eclipse IDE for Java EE Developers

ZK Studio is an Eclipse Plug-in, therefore you must install Eclipse. We recommend the Eclipse IDE for Java EE Developers package. Currently 4.2 (Juno) and 3.7 (Indigo) are supported.

Install:

Installation is done simply by extracting the downloaded zip file to a proper local folder. 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.


Tips:

  1. We recommend modifying some parameters in the configuration file eclipse.ini which will result in performance gain, please refer here and here.
  2. We also recommend setting Eclipse's default JRE to JDK, please refer to the "Setup/Preferences" section in WTP Tutorials – Building and Running a Web Application.

Application Servers

Before developing web applications in Java using ZK 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 Apache Tomcat.

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 ZK Project.

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:

Install ZK Studio

ZK Studio can be installed in several ways. We recommend to install through Marketplace.


Marketplace (Since Eclipse 3.6)

Marketplace is the easiest way to install plugins. Go to menu [Help] > [Eclipse Markpetplace] and search "zk studio" you'll find ZK Studio to install.

Eclipse36 marketplace.png

Update Site

  1. Open Eclipse, click the [Help] menu and select [Install New Software...]. A install window will popup, and then click Add
    Zkstudio installation 35 1.png

  2. Name the site as "ZK Studio" and copy corresponding update site's URL into Location field and click OK.
    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
    Zkstudio installation 35 2.png

  3. Expand the update entry of ZK Studio, check ZK Studio and then click Next
    Zkstudio installation 35 3.png
    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.
  4. Click Next on the pop-up install wizard dialog.
    Zkstudio installation 35 4.png

    Check "I accept the terms of the license agrement" and click Finish on the wizard dialog.
    Zkstudio installation 35 4 licenses.png

    The Installation process will now begin.
    Zkstudio installation 35 5.png

    If there is a pop-up dialog with unsigned content warning, please click OK to continue.
    Zkstudio installation 35 5 warning.png

  5. Once the installation is complete, please restart Eclipse as prompted.
    Zkstudio installation 35 6.png

Offline Installation

  1. Download the offline installation zip file from ZK Studio download page.
  2. The step is the same as step 1 we do for Update Site. Open Eclipse, click [Help] menu and select [Install New Software...]. An install window will popup, click Add
  3. Click Archive... to open a file explorer. Then, use file explorer to choose downloaded file and click "OK" to install.
    Zkstudio installation 35 manual 2.png

Activate ZK Studio

In Eclipse's menu, please choose [Help] and select [Activate ZK Studio]. A dialog will show up:

Studio activation dialog.png
  • Please enter 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.
Activate ZK Studio to tell us you are using it and show your recognition for this product. If you don't want to activate, you can still use full-featured ZK Studio.

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 JavaEE Developers, and you need to install Eclipse WTP plug-in manually or download Eclipse for JavaEE Developers. 

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

Still have problem?

Please contact info@zkoss.org if there's any issue after referencing the above note.




Last Update : 2013/04/09

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.


Retrieved from "https://www.zkoss.org/_w/index.php?title=ZK_Studio_Essentials/Installation&oldid=36835"