Installation and Initialization
Previous Next
Quick Start for Installing OSEE Screencasts

Installation and Initialization

Requirements

Eclipse Installation

To install OSEE: Start by downloading the OSEE Application Server and the OSEE Client Update Archive from the downloads page.

Quick Server Installation

If you are interested in a quick start, and are not setting up a custom database installation, setting up the OSEE server with the bundled HSQLDB database is simple.

You should end up with the following files and directories:

- configuration demo eclipse etc plugins runDemo.bat runDemo.sh runHsql.sh runPostgreSqlLocal.sh

For example, if you were using Windows, and you installed to C:/UserData/OseeDemo, you would change the line in the batch file to:

-
-Dosee.application.server.data="C:/UserData/OseeDemo/demo/binary_data"

Set the jdbc.server.db.data.path to the location of the hsql db. Following the example above, for instance, you would change the line in the json file to:

- "jdbc.server.db.data.path": "<file:c:/UserData/OseeDemo/demo/hsql/osee.hsql.db>",

That completes the simple server setup. Run the server by setting up a command window, then running the script file to start the server. For example, if you were running with Windows, you would start a windows command shell, then run the "runDemo.bat" batch script. See [Launch Application Server](#Launch_Application_Server "wikilink") for details on running the server.

Client Installation

The OSEE client can be installed from within Eclipse like any other Eclipse plugin.

  1. Start Eclipse and select the menu item **Help \> Install New Software...**
  2. Select the Available Software tab group and click the Add... button. add_site.png ![Image:New_update_site.png](/docs/images/New_update_site.png "Image:New_update_site.png")
  3. In the Add Repository dialog, choose the Archive button, then navigate the file browser to the Client Update file downloaded in step one, "org.eclipse.osee.client.all.p2.zip". **Please note that the use of the software you are about to access may be subject to third party terms and conditions and you are responsible for abiding by such terms and conditions.**
  4. Click on the OK button to store update site information, "Eclipse OSEE Client All - (Incubation)".
  5. Select the OSEE update site entry and all features listed under its category. Click the Next button. ![Image:AvailableSoftware.png](/docs/images/AvailableSoftware.png "Image:AvailableSoftware.png")
  6. If you receive a security popup Window regarding unsigned content, click OK.
  7. The update manager calculates dependencies and offers you a list of features to install. Select the needed ones and click the Next button.
  8. Accept terms of license agreement and click the Finish button in order to start the installation of selected features.![Image:AcceptTerms.png](AcceptTerms.png "Image:AcceptTerms.png")
  9. To apply installation changes click on the No button and shutdown Eclipse. It is important that you don't restart Eclipse until you have completed the database initialization steps below.

image:restart_dialog.png If you are using the default demo database and did the server quick start above, you just need to make one change to the eclipse eclipse.ini file - add the line

-
-Dosee.application.server= http://localhost:8089 to the end of the file.

Your installation is complete.

Additional Configuration Options

  1. The following instructions apply if you are setting up a custom database, or if you are configuring OSEE for use by multiple users.
  2. Custom Data Base: Follow the instructions at [Supported Databases](#Supported_Databases "wikilink") to complete this step.
  3. Initialize the database with default OSEE data. See [Database Initialization](#Database_Initialization "wikilink")
  4. Setup config.ini and launch eclipse to start using OSEE [Launch and Configuration](#Launch_.26_Configuration "wikilink")
  5. You can find different OSEE perspectives, such as Define and ATS, and views in correspondent dialogs, activated by menu items *Window \> Open Perspective \> Other... andWindow \> Show View \> Other...*.

image:open_perspective.png

image:show_view.png

Server Installation

  1. Download the server zip file from downloads.
  2. Unzip the file
  3. Set up the database (as described below)

Supported Databases

Data created and managed by OSEE is persisted into a data store divided into two sections. A relational database to store type, configuration, and small content (\< 4000 bytes) and a remote file system to store larger binary content.

Before you can use OSEE, you will need to select and install a relational database suited for your needs and identify a file system path for binary content storage. OSEE provides support for the databases listed below. For launch and configuration instructions visit [Launch and Configuration](#Launch_.26_Configuration "wikilink").

PostgreSQL Installation

Prerequisites

Instructions

  1. Download PostgreSQL from http://www.postgresql.org/download
  2. Follow PostgreSQL installation instructions
  3. Unless required, do not change the default port number (5432)
  4. By default, the PostgreSQL database server is configured to allow only local connections. If remote connections are to be allowed, edit postgresql.conf and pg_hba.conf to set the necessary permissions.
    1. To setup an unsecured database instance(only for old postgres driver):
      1. Set listen_addresses = '\*' in postgresql.conf (located in the \PostgreSQL[version]\data directory)
      2. Set host all all 0.0.0.0/0 trust in pg_hba.conf (located in the \PostgreSQL[version]\data directory)
      3. You may need to set all METHODs to trust
  5. Configure PostgreSQL for OSEE
    1. Launch pgAdmin (in windows Start→All Programs→PostgreSQL*→pgAdmin *)
    2. Double click on PostgreSQL Database Server (listed under Servers on the left hand side)
      1. If you are prompted for a password type the password selected during installation (user should be postgres by default)
    3. Create an "osee" user
      1. Right-click on Login/Group Roles (in the tree on the left hand side) and select "Create → Login/Group Role..."
      2. Enter the following in the dialog:
        1. General Tab
          1. Name: osee
        2. Definition Tab
          1. Password: osee
        3. Privileges Tab
          1. Can login? Yes
          2. Superuser: Yes
          3. Create roles? Yes
          4. Create databases: Yes
          5. Update catalog? Yes
      3. Click 'Save'
      4. You should now have an "osee" user under Login Roles
    4. Expand the "Databases" item in the tree
      1. Create the "osee" database by right-clicking on "Databases" and selecting "Create → Database..."
      2. Enter the following in the dialog:
        1. General Tab
          1. Database: osee
          2. Owner: osee
        2. Definition Tab
          1. Encoding: UTF-8
      3. Click 'Save'
      4. You should now have an "osee" Database under Databases
    5. Click on "osee" and then expand it, then expand "Schemas"
      1. Create the "osee" schema:
        1. Right click on "Schemas" and select "Create → Schema..."
        2. Enter the following in the dialog:
          1. General Tab
            1. Name: osee
            2. Owner: osee
        3. Click 'Save'
        4. You should now have an "osee" schema under schemas
    6. Enable view that provides database statistics
      1. Uncomment (Remove '#') and set shared_preload_libraries = 'pg_stat_statements' in postgresql.conf
      2. Run this query against the osee database: create extension pg_stat_statements;
      3. Restart the postgres database (e.g. Windows: command prompt navigate to Postgres bin and run restart command on postgres exe)
    7. The relational database is now configured. Proceed to OSEE Database Initialization

Launch Application Server

Prerequisites

Instructions

<file:serverstatus.jpg>

Database Initialization

Prerequisites

Visit the 'User's Guide' if you need more information about any of the pre-requisites below.

*Warning: This process will delete all data from OSEE Data Store. Make sure you are certain before running this process. *

Instructions

| | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | eclipsec -nosplash -application org.eclipse.osee.framework.database.init.configClient -vmargs -XX:MaxPermSize=256m -Xmx512m -Dosee.application.server=http://localhost:8089 -Dosee.default.log=INFO -Dosee.authentication.protocol=trustAll |

*When prompted select "Y"

Messaging Service

OSEE utilizes the [Java Message Service (JMS) API](http://en.wikipedia.org/wiki/Java_Message_Service) for loosely coupled, reliable, and asynchronous communication with OSEE clients. You will need an implementation of this API such as ActiveMQ in order for clients to receive updates to cached artifacts that were modified by another client (remote events). Download the latest version from here.

Install

General installation instructions.

If you are downloading a release of ActiveMQ from the terminal and need to use an http proxy, this command will set up your proxy:

$ export http_proxy=http://proxy.host.com:1234

Start

General instructions on how to start ActiveMQ are here.

To direct the OSEE client to use this service, in your launcher ini file, include the following Java system property:

-Dosee.default.broker.uri=tcp://{localhost_or_your_server}:61616

Launch & Configuration

Before you can launch OSEE, you will need the address of an arbitration server or an application server to access the OSEE data store. If you have questions regarding client/server interactions, visit 'Client/Server Overview'. If everything is on the same machine, the following examples will work.

Prerequisites

Application Server Launch Instructions

| | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | java -Dorg.osgi.service.http.port=8089 -Dosee.check.tag.queue.on.startup=true -Dosee.db.connection.id={ConnectionId} -jar plugins/org.eclipse.equinox.launcher_{VersionForYourEclipse}.jar -console |

For PostgreSQL: {| style="background:rgb(230,230,230);color:black; border:1px solid gray; font-family: fixedsys;text-align: left" cellpadding=20px cellspacing=0 width=80% | runPostgresqlLocal.sh |}

OSEE Client Launch Instructions

| | | ---------------------------------------------------------------------------------------------------------------------------------------- | | eclipse -vmargs -Xmx512m -Dosee.log.default=INFO -Dosee.application.server=http://localhost:8089 -Dosee.authentication.protocol=trustAll |

Configure a New Project in OSEE

  1. Create baseline branch
    1. From the Branch Manager's select parent branch → open context menu → select "branch" and enter new branch name
    2. From the Branch Manager's select new branch → open context menu → access control
      1. Add system administrators with Full Access
      2. Add Everyone with Read Access
Previous Getting_Started Next
Quick Start for Installing OSEE Screencasts