4.2. Installation

In this section are explained several methods to get, install and run YaTiSeWoBe. We are committed to provide the user with the most simple and effective ways to deploy YaTiSeWoBe to your platform.

YaTiSeWoBe is being developed and tested on both Mac-OS X and GNU/Linux operating systems. Please let us know if you are experiencing problems with the procedures described here.

[Note]Note

You will always find the latest version of YaTiSeWoBe on the official homepage: http://www-iis.unil.ch/~jiglesia/wormhole/yatisewobe/

In the following sections, we will discuss separately how to install YaTiSeWoBe on GNU/Linux, Apple Mac-OS X, and Microsoft Windows platforms. Fine tuning of the Java Virtual Machine configuration are discussed along with the general parameters.

All installation procedures suppose that you have installed a Java Virtual Machine 1.4+. For all common operating systems, you can download for free and easily install the virtual machine from Sun Microsystems Java web site [30]. Be sure to read and comply with Section 4.1, “Requirements”.

FIXME: add section on what can be tuned

4.2.1. Using Java WebStart

Java WebStart [33] is a technology developed by Sun Microsystems to deploy and keep up-to-date Java applications. It is the preferred way to download, install and update YaTiSeWoBe because of the simplicity of the procedure. Consult the Java WebStart official homepage for details on running Java WebStart.

4.2.1.1. Download and installation

Procedure 4.1. Installing YaTiSeWoBe with Java WebStart

  1. point your Java WebStart enabled browser to the project homepage [57]

  2. press the "Start YaTiSeWoBe Now" link

    Java WebStart will immediately download, install and launch the application in one shot. Note that this is not the same as running the application as a Java Applet: the application is run independently from the web browser.

4.2.1.2. Update

Procedure 4.2. Updating YaTiSeWoBe with Java WebStart

  1. Using the browser

    1. point your Java WebStart enabled browser to the project homepage [57]

    2. press the "Launch YaTiSeWoBe Now" link. Java WebStart will automatically connect to the web site, check for newer versions of the libraries, download any new version, and run the application.

  2. Using Java WebStart Application

    1. find the Java WebStart application on your computer, and launch it

    2. locate YaTiSeWoBe in the list of installed applications and click it. Java WebStart will automatically connect to the web site, check for newer versions of the libraries, download any new version, and run the application.

4.2.1.3. Tuning

Procedure 4.3. Tuning YaTiSeWoBe with Java WebStart

  • Find the Java WebStart application on your computer, and launch it.

    Use the menus of the application launcher to fine tune the installation.

4.2.1.4. Un-install

[Warning]Warning

missing procedure

4.2.2. Mac-OS X users

With Mac-OS X [17], Apple [16] provided the Java developers community an incredibly simple and powerful architecture to build and deploy "native" applications for the platform. YaTiSeWoBe takes benefit from those "bundle applications" [18] to provide Mac-OS X users a ready-to-launch version that can be found on the homepage.

4.2.2.1. Download

Procedure 4.4. Downloading YaTiSeWoBe on Mac-OS X computers

  1. To get YaTiSeWoBe, go to the project homepage [57].

  2. Click on the link yatisewobe-macosx.dmg.bz2 to download the installer to your computer.

4.2.2.2. Installation

Procedure 4.5. Installing YaTiSeWoBe on Mac-OS X computers

  1. Double-click on the file you downloaded to unpack it. If it doesn't work so, open Stuffit Expander and unpack the file from there.

    You can obtain Stuffit Expander for free from the official web-site [51];

  2. You should now have a new file named yatisewobe-macosx.dmg and certainly a volume named YaTiSeWoBe Installer. If you don't have the second one, double-clicking on the first one will create it;

  3. YaTiSeWoBe Installer contains the application itself, named YaTiSeWoBe, and one directory named doc where you can find all the documentation about YaTiSeWoBe.

    Copy the application and the directory to your hard disk anywhere you want (they should not necessarily be located in the same directory);

  4. Eject the YaTiSeWoBe Installer volume;

  5. You can now safely delete the the files yatisewobe-macosx.dmg and yatisewobe-macosx.dmg.bz2.

4.2.2.3. Launching

Procedure 4.6. Launching YaTiSeWoBe on Mac-OS X computers

  • To launch YaTiSeWoBe, doucle-click on its icon.

    [Note]Note

    Whatever installer you use, a setup window will be opened the first time you launch YaTiSeWoBe.

    Refer to the Section 4.2.6, “Setup” for more informations.

4.2.2.4. Update

Procedure 4.7. Updating YaTiSeWoBe on Mac-OS X computers

  1. Optionally remove the old version of the application according to procedure Un-installing YaTiSeWoBe on MacOS X computers;

    [Note]Note

    multiple versions of the application coexist gracefully on the same computer.

  2. Install the newer version according to procedure Installing YaTiSeWoBe on Mac-OS X computers;

4.2.2.5. Tuning

[Warning]Warning

Be careful when editing the properties file, as it might cause YaTiSeWoBe to break and impossible to launch anymore.

Procedure 4.8. Tuning YaTiSeWoBe on Mac-OS X computers

  1. Find the YaTiSeWoBe application in the finder: it should be where you installed it, usually /Applications;

  2. Right-click (or Ctrl-left-click) on the application icon, and select "Show Package Content";

  3. Browse in the package contents to Contents/;

  4. Double-click on Info.plist to launch the Property Editor application.

4.2.2.6. Un-install

Procedure 4.9. Un-installing YaTiSeWoBe on MacOS X computers

  • Move the YaTiSeWoBe application and documentation to the Trash.

4.2.3. GNU/Linux users

Deploying and running Java applications on GNU/Linux [37] is performed in the same way as any other applications. YaTiSeWoBe is distributed as a .tar.gz archive that is simply copied on the host and decompressed. The application is then launched through a shell script provided.

4.2.3.1. Download

Procedure 4.10. Downloading YaTiSeWoBe on GNU/Linux computers

  1. To get YaTiSeWoBe, go to the project homepage [57].

  2. Click on the link yatisewobe-linux.tar.gz to download the archive to your computer.

4.2.3.2. Installation

Procedure 4.11. Installing YaTiSeWoBe on GNU/Linux computers

  1. Open a shell;

  2. Enter the directory where you would like to install YaTiSeWoBe, e.g.:

    example$ cd /opt
    example$ 
    
  3. Uncompress the file:

    example$ tar xvzf yatisewobe-linux-<version>.tar.gz
    [...]
    example$ 
    

4.2.3.3. Launching

Procedure 4.12. Launching YaTiSeWoBe on GNU/Linux computers

To launch YaTiSeWoBe, doucle-click on its icon.

[Note]Note

Whatever installer you use, a setup window will be opened the first time you launch YaTiSeWoBe.

Refer to the Section 4.2.6, “Setup” for more informations.

  1. Set the $YATISEWOBE_HOME environment variable to the directory you have installed YaTiSeWoBe, e.g.:

    1. sh family shells

      example$ export YATISEWOBE_HOME=/opt/yatisewobe-<version>
      example$ 
      
    2. csh family shells

      example$ setenv YATISEWOBE_HOME /opt/yatisewobe-<version>
      example$ 
      
  2. $JAVA_HOME envirronment variables must also be set to the directory where the Java Virtual Machine is installed on your system (e.g. /usr/lib/java, …) in order for YaTiSeWoBe to be work properly.

    You can check if this variable is set, by issuing the command:

    example$ echo $JAVA_HOME
    /usr/lib/java
    example$ 
    

    If this variable is not set, you'll have to search for the installation of the virtual machine with the help of commands like which java or locate java. See your distribution documentation to determine where the installation is, or get and install a fresh install of the virtual machine and set the variable accordingly.

  3. You are highly invited to set $YATISEWOBE_HOME and $JAVA_HOME variables in your shell run control scripts: ~/.bashrc for sh family shells, ~/.cshrc for csh family shells.

4.2.3.4. Update

[Warning]Warning

missing procedure

4.2.3.5. Tuning

[Warning]Warning

missing procedure

4.2.3.6. Un-install

[Warning]Warning

missing procedure

4.2.4. Microsoft Windows users

to be written...

4.2.4.1. Download

Procedure 4.13. Downloading YaTiSeWoBe on Windows computers

  1. To get YaTiSeWoBe, go to the page [57].

  2. Click on the link yatisewobe-windows.exe or on the link yatisewobe-windows-jre.exe to download the installer to your computer.

    The second file includes a Java Virtual Machine (JVM).

4.2.4.2. Installation

Procedure 4.14. Installing YaTiSeWoBe on Windows computers

  1. Double-click on the file you downloaded (yatisewobe-windows.exe or yatisewobe-windows-jre.exe;

  2. Answer to the different questions of the installation wizard;

  3. During the installation procedure, you are given the possibility to add an icon to the "start" menu and/or on the desktop: you can double-click on those icons to launch YaTiSeWoBe.

  4. When the installation is finished, you can delete the file you downloaded.

4.2.4.3. Launching

Procedure 4.15. Launching YaTiSeWoBe on Windows computers

[Note]Note

Whatever installer you use, a setup window will be opened the first time you launch YaTiSeWoBe.

Refer to the Section 4.2.6, “Setup” for more informations.

  • Double-click on the YaTiSeWoBe icon located on the desktop, if you choose to create one when you installed the application, or in the yatisewobe-<version> directory, where <version> is the version number you've dowloaded.

4.2.4.4. Update

Procedure 4.16. Updating YaTiSeWoBe on Windows computers

  1. Optionally remove the old version of the application according to procedure Section 4.2.4.6, “Un-install”;

    [Note]Note

    Multiple versions of the application coexist gracefully on the same computer.

  2. Install the newer version according to procedure Section 4.2.4.2, “Installation”;

4.2.4.5. Tuning

Procedure 4.17. Tuning YaTiSeWoBe on Windows computers

  1. Use the explorer to browse to the directory where you installed YaTiSeWoBe;

  2. Open the yatisewobe.cfg file with your favorite text editor.

4.2.4.6. Un-install

Procedure 4.18. Un-installing YaTiSeWoBe on Windows computers

  • To uninstall YaTiSeWoBe, double-click on the file named unins000.exe located in the yatisewobe-<version> directory, where <version> is the version number of the file you dowloaded.

    [Note]Note

    After uninstall, the yatisewobe-<version> directory may still exist. You can safely delete it with all its contents.

4.2.5. Advanced Java users

4.2.5.1. Download

[Warning]Warning

missing procedure

4.2.5.2. Installation

[Warning]Warning

missing procedure

4.2.5.3. Installation

[Warning]Warning

missing procedure

4.2.5.4. Update

[Warning]Warning

missing procedure

4.2.5.5. Tuning

[Warning]Warning

missing procedure

4.2.5.6. Un-install

[Warning]Warning

missing procedure

4.2.6. Setup

Procedure 4.19. Setting up YaTiSeWoBe

The setup window will appear the first time you launch YaTiSeWoBe. It will help you to prepare your system for running YaTiSeWoBe.

  1. You first have to read and accept the license to use YaTiSeWoBe

  2. The setup assistant will check that your computer has the minimum requirements to run YaTiSeWoBe;

  3. You have to create or select a directory in which can be saved information while you will be working like style sheets, log files,…;

  4. You are given the possibility to select one or more directories to share the information you will store in with other people;

  5. With your permission, we would like to collect information about your computer (OS, Java Virtual Machine version, …). It would help us to develop future versions of YaTiSeWoBe more effectively. The statistics we compute from the collected data are available from the application website [58]. No personnal information will be sent on Internet, only information concerning your setup that might help us to match the needs of the user base. The information is collected anonymously.