Like what you see? Have a play with our trial version.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

Anchor
top
top

Table of Contents
classcontents

Overview

Styleclass
ClasstopLink

top

The Yellowfin Installer supports three modes of operation:

  1. Standard Graphical Installer
  2. Command-line Installer
  3. Silent Installer

See Installer Properties for more information.

The default behaviour is to launch the graphical installer. If no graphical environment is available, for example on a headless linux/unix server, the command-line installer will be launched instead. The installation mode can be specifically selected by adding a switch argument to the command used to run the installer:

Code Block
none
none

java -jar yellowfin-yyyymmdd-full.jar -gui
java -jar yellowfin-yyyymmdd-full.jar -cmd
java -jar yellowfin-yyyymmdd-full.jar -silent

If the graphical installer is requested with -gui–gui, but no graphical environment is available, an error message will be displayed.

...

The silent installer does not display a user interface. This can be useful when bundling the Yellowfin installer as part of another installer that has its own user interface.

Adding Files to the Installer

Styleclass
ClasstopLink

top

The Yellowfin installer is a java archive (.jar) file. This is essentially a zip-compatible file, with some special properties. The Java Development Kit comes with a command-line tool for creating and extracting these files, called jar (jar.exe on Windows).

Customising the Yellowfin installer involves adding certain files to the installer. To do this, you should extract the contents of the installer, add the files in the correct location in the installer's file structure, and then re-create the jar archive.

To extract the contents of the installer archive:

...


jar xvf /path/to/yellowfin-yyyymmdd-full.jar

This will create the expanded file structure of the installer archive in the current directory. You should not modify any of the extracted files. Add any files you need to in the correct location under this directory. The custom properties file must be named custom.properties, and must be in the top-level directory. Any other files referenced as resources in the custom properties file will be specified using a path relative to this directory. After any additional files are added, re-create the archive:

...


jar cvmf META-INF/MANIFEST.MF /path/to/yellowfin-modified.jar

This command creates a new installer jar file, using the contents of the original file and any additional files you have added. The jar manifest file from the original installer is used.

The Windows executable installer file cannot be modified in this way. To create a modified Windows installer, first create a modified .jar installer as above, then use Launch4J to convert it to an executable file.

See http://launch4j.sourceforge.net/Image Removed for more information.

User Options

Styleclass
ClasstopLink

top

These options are required for installation:

...

In the silent installation, there is no user input, so the values specified in the custom properties file and on the command-line are used.

 

...

horizontalrule
Styleclass
ClasstopLink

top

Installer properties are the key to customising the Yellowfin installer. Different properties are used to make different changes to the installer, including:

  1. Providing initial values for user options
  2. Changing the installer's look-and-feel
  3. Changing the installer's behaviour
  4. Changing the configuration of the Yellowfin installation

Values for installer properties can be provided in different ways.

See [something] for more information.

horizontalrule

...

ClasstopLink

...