End User Installation

The following installation procedure should be used if you want to run armidale applications over the internet or an intranet. If you want to develop armidale applications you will need to install the armidale development system.

Step 1: Preparation.

For end user installations (ie. no developer support) the Sun JRE version 1.3 or 1.4 is required. JRE 1.4 is preferred. It shouldn't matter which operating system you use as long as it supports Java 1.3 or 1.4.

Use the following command to see if you already have the required version of the JDK installed.

java -version

Step 2: Create an installation directory.

Create a new directory in which to install armidale. By convention, the directory should be called 'armidale', but any name will do. The directory can be placed anywhere on your system.

Step 3: Download the installation files.

The armidale end user distribution comprises the following executable Java jars which can be downloaded from here. Download the files to the directory created in step 2.

armidale-<version>-user.jar. This jar contains the armidale application launcher and will configure your computer to use the armidale system.

armidale-<version>-documentation.jar. Installation of this jar is optional. It contains the HTML pages and images that comprises the armidale web site (ie. the pages you are reading now).

<version> in the above file names is a version number like 0.9.2 (eg. armidale-0.9.2-user.jar). Always download the latest version of armidale.

Step 4: Install the user jar.

In a command shell, 'cd' to the directory created in step 2, and then use the following command to install the end user armidale system.

java -jar armidale-<version>-user.jar

Installation of this jar will create a subdirectory called jars containing the main armidale jar. It will also save some initial state information for the armidale application launcher and will create an armidale resources directory called .armidale in your home directory.

Step 5: Install the Documentation.

If you want to install the armidale documentation, 'cd' to the directory created in step 2, and then use the following command.

java -jar armidale-<version>-documentation.jar

Installation of this jar will create a subdirectory called documentation containing the armidale documentation.

What's next?

See Using the armidale launcher for information on running armidale applications.