wiki:DetaildBuildInstructions
Last modified 4 years ago

  1. Detailed Build Instructions
    1. Terms used
    2. Requirements
      1. Installed Applications
      2. Information Needed
        1. Information on Tomcat Installation
    3. Preparatory Steps
      1. Example Setup
      2. Proteios 2 Source Code Copy
    4. Build Proteios
      1. Steps using Eclipse
      2. Steps using Ant from the Command Line
    5. Installing the Built Proteios Distribution

Detailed Build Instructions

This note describes issues regarding building Proteios 2 from a source code copy of the project.

Note! This Wiki page is under construction. Its contents may change during development of the software, and instructions on this page should therefore be used with caution before the official Proteios 2 release.

Terms used

IDE
Integrated Development Environment
SDK
Software Development Kit
J2SE
Java 2 Standard Edition
JDK
J2SE Development Kit

Requirements

Installed Applications

  1. Java SDK (JDK) version 5 or newer must be installed. Java can be downloaded for free; see information on  http://java.sun.com/. The version to download is SDK for Java 2 Platform Standard Edition 5.0 or newer (make sure that you download the JDK, and not just the JRE, the J2SE Runtime Environment).
  2. Ant (originally "Another Neat Tool") is used to manage the build process. If not already installed on your system, it can be downloaded from  http://ant.apache.org/.
  3. Eclipse is the recommended IDE. See Setting up Eclipse for instructions on how to set up Eclipse for Proteios development.
  4. Apache Tomcat servlet container needs to be installed in order for Proteios to work, but is strictly not necessary for compiling Proteios. However, with information on the Tomcat installation, the Proteios development platform can be configured to reload the web application on Tomcat (target reload in ant build file build.xml). Tomcat can be downloaded for free; see information on  http://tomcat.apache.org/.

Information Needed

Information on Tomcat Installation

  1. Tomcat installation directory, normally stored in environment variable CATALINA_HOME (Catalina is the name of a Java class in the Tomcat package). If you need to find the directory yourself, first search for a directory with "tomcat" in the name. The "Catalina home" directory is the one with a sub-directory named "webapps".
  2. Username and password for the Tomcat manager.

Preparatory Steps

Example Setup

Some steps have been illustrated with examples. These are based on the following assumptions:

Operating system Unix/Linux?
Tomcat manager's username tom
Tomcat manager's password jerry
Tomcat installation directory /usr/local/packages/apache-tomcat-5.5.15/
Proteios-2 installation directory /usr/local/packages/Proteios-2.0/

Example setup.

Proteios 2 Source Code Copy

  1. Download Proteios 2 Source Code
    The recommended way to download Proteios source code is through Eclipse, as described in Setting up Eclipse.

  2. Create Properties File for Local Settings
    In the Proteios installation directory, make a local copy of default.properties and name it build.properties. The latter file is used to store settings for the local system (it should therefore not be put under code revision control). For the example setup:

    cd /usr/local/packages/Proteios-2.0
    cp -p default.properties build.properties

  3. Update Properties File with Local Tomcat Settings
    Update the lines in build.properties for catalina.username, catalina.password, and catalina.home with values for your Tomcat installation. For the example setup:

    catalina.username=tom
    catalina.password=jerry
    catalina.home=/usr/local/packages/apache-tomcat-5.5.15

Build Proteios

Steps using Eclipse

  1. Open Proteios 2 project (if not already open).
    In "Package Explorer", right-click with mouse on item Proteios (in example "Proteios-2.0") to make a pop-up menu appear, and select item "Open Project".
  2. Open ant Build File (if not already open)
    In "Package Explorer", double-click with mouse on file build.xml. The file will open in the "Editor" window and the build targets will be shown in a list in the "Outline" panel.
  3. Select the ant Build File (if not already selected)
    In the "Editor" window, select the tab for file build.xml. The file will be put to the front int the "Editor" window and the build targets will be shown in a list in the "Outline" panel.
  4. Run ant target package
    In the "Outline" panel, right-click with mouse on target package to make a pop-up menu appear, and select item "Run As -> Ant Build" in cascade menu. The Proteios source code will now be compiled and prepared for distribution.

Note. The last step is the crucial one. The description above for Eclipse contains several steps, as it was adapted for a new project.

Steps using Ant from the Command Line

  1. Move to the Proteios 2 Installation Directory
    In the example setup:

    cd /usr/local/packages/Proteios-2.0

  2. Run ant target package

    ant package

Installing the Built Proteios Distribution

Instructions on how to install the built Proteios distribution can be found in Installation.