Install and run Z2 in 5 minutes¶

« Step 1 - What is z2

Prerequisites¶

You need a properly setup JDK 6 or 7 on Linux, Mac OS X or Windows - that's all.
A halfway modern system will do.

This how-to uses the Git VCS, which has to be installed on your system (we're using Git version 1.7). You can also run Z2 with SVN as described on Step 4 - First steps with Z2 on SVN.

It is beneficial to use the Eclipse IDE (Ganymed, Helios, Indigo, Kepler work all fine). There's a small Eclipse plug-in called "Eclipsoid" which makes it easier to develop z2 applications within Eclipse (see Step 3 - First steps with Z2 on Git for more details). However you can use any IDE (including vi and notepad) together with z2.

Creating a home for Z2¶

This is a best practice approach (and other approaches are possible). We recommend to keep the repositories and the IDE workspace close together. This way we don't need to adjust the path settings in the Z2 configuration files and they can remain relative paths.

Create a folder called z2-base inside your favorite/home/development/what-ever directory and enter it:

mkdir z2-base
cd z2-base

Cloning the Z2 core¶

As described in Step 1 - What is z2 the z2-base project contains several repositories.
You always start with the core repository. Create a clone from git.z2-environment.net which will checkout the "master" branch automatically:

git clone http://git.z2-environment.net/z2-base.core
Cloning into core...

cd z2-base.core
git branch
* master

That's all you need to do in order to install the z2-Environment and you can start the server right away. Before starting, make sure that you have a working Java installation. To test, type

java -version

on a command line. This should output some information on your Java Development Kit of version 1.6 or higher.

Starting the z2-Environment¶

The start scripts are located inside run/bin and are called go.sh on Unix based systems like Linux and Mac OS and go.bat on Windows. There's also a gui-based version that we will discover later.

cd run/bin
./go.sh
09/10 15:59:10 [1]...hers.HomeLauncher[800]: Z2 Home Launcher, (c) ZFabrik Software KG 2010, 2011, 2012
09/10 15:59:10 [1]...ProcessRunnerImpl[800]: Running core build 201208241554 as udoo in z2 home /Users/udoo/dev/temp/z2-base-v2.1/z2-base.core/run/bin/../.., timezone Europe/Berlin, language de, region null
09/10 15:59:10 [1]...ProcessRunnerImpl[800]: Using VM v1.6.0_35 by Apple Inc. at /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home on Mac OS X (arch: 10.6.8)
09/10 15:59:10 [1]...ProcessRunnerImpl[800]: ************************************
09/10 15:59:10 [1]...ProcessRunnerImpl[800]: *** Running in DEVELOPMENT mode! ***
09/10 15:59:10 [1]...ProcessRunnerImpl[800]: ************************************
09/10 15:59:10 [1]...entRepositoryImpl[800]: Using GitCR com.zfabrik.boot.config/systemRepository (origin=http://git.z2-environment.net/z2-base.base, branch=v2.1) com.zfabrik.impl.gitcr.GitComponentRepositoryImpl@71b8b3bb,repo:246d0e3e, component:com.zfabrik.boot.config/systemRepository, prio:500, checkDepth:1073741823, fileSystem:com.zfabrik.components.provider.fs.FileSystemImpl@151ff451, root:/Users/udoo/dev/temp/z2-base-v2.1/z2-base.core/run/bin/../../work/repos/246d0e3e/git
09/10 15:59:12 [1]...entRepositoryImpl[800]: Pulled deltas from GitCR com.zfabrik.boot.config/systemRepository (origin=http://git.z2-environment.net/z2-base.base, branch=v2.1)  within 1684msec
...
09/10 15:59:12 [18]...ent/webWorker@0.1[800]: Listening for transport dt_socket at address: 5100
...
09/10 15:59:13 [18]...ent/webWorker@0.1[800]: INFO  org.eclipse.jetty.server.AbstractConnector  - Started SelectChannelConnector@0.0.0.0:8080
...
09/10 15:59:16 [1]...stemStateResource[800]: System state attained: com.zfabrik.boot.main/home_up
09/10 15:59:16 [1]...hers.HomeLauncher[800]: Completed home process initialization

press (q)uit, (c)omponents, (f)oundation props, (s)ystem props, s(y)nc repo, (v)erify, (g)c:>

Note: On first startup the runtime needs to clone its base repository (z2-base.base). Dependending on your network bandwidth this may require anything between a few seconds to some minutes. Subsequent startups will not require this step again.

When you see the prompt above, the z2-Environment is up and running and excepting requests on localhost port 8080. To verify, open the administration page at http://localhost:8080/adm. Use username z* ("z" followed by an asterisk) and password z.

Essentially the same procedure is used to install the z2-Environment in production. From a system installation point of view, checking out a core distribution as we just did is all that needs to be done.

On the next page we will do some first development step with z2 in combination with the Eclipse IDE.

As it is handy to run the z2 server from inside Eclipse, so you should stop the running server now by pressing 'q'.

» Step 3 - First steps with Z2 on Git