eagle-i software is available under a BSD 3 license.
Currently, there are a two ways to install eagle-i: from scratch (source code) or from pre-packaged applications. To make deployment even easier in the future, we anticipate offering eagle-i as a pre-configured virtual machine and via a hosted SaaS (cloud) model. Wonder Lake Software offers technical support and software engineering services to organizations wishing to integrate with, customize or extend the eagle-i platform.
Contents
Getting started: for developers
Get the code
Subversion organization overview
Browse the Subversion repository:
https://open.med.harvard.edu/svn/eagle-i-dev/
Check out the software development trunk:
svn co https://open.med.harvard.edu/svn/eagle-i-dev/apps/trunk
Check out a release of the software, e.g.:
svn co https://open.med.harvard.edu/svn/eagle-i-dev/apps/branches/1.5-MS3.x
Check out the data model development trunk:
svn co https://open.med.harvard.edu/svn/eagle-i-dev/datamodel/trunk
Check out a data model release, e.g.:
svn co https://open.med.harvard.edu/svn/eagle-i-dev/datamodel/releases/0.8.2
Set up a development environment
The eagle-i source code is a multi-module maven project (see code organization). Our code is IDE-agnostic, though we've had a good experience using eclipse with the m2eclipse plugin (standard with the latest version of eclipse):
- After installing m2eclipse, open the eclipse subversion perspective and select "check out as maven project" at the trunk level.
- This will create an eclipse project per maven module
- eagle-i-base contains the root POM. mvn install at this level builds the entire tree.
Alternately, here are some notes on setting up eclipse for GWT debugging from one of our team members.
Browse the Javadocs
Latest release
http://search.eagle-i.net/javadoc
Latest snapshot
http://qa.search.eagle-i.net/javadoc
Get the eagle-i resource ontology
http://code.google.com/p/eagle-i/
Getting started: for system administrators, install from scratch
System requirements
The current eagle-i network deployment is a reference configuration. In this deployment, eagle-i institutional servers are VMs with the following configuration:
- RAM: 6 GB
- Disk: 100 GB
- CPU: 2 core
- Operating system: Fedora 14
- Java environment: Sun JDK v. 1.6.0_27, 64 bit
- Servlet container: Tomcat 6 or 7
- RDBMS: MySQL 5.1 (optional, used for logging search usage)
- Mail server: postfix (optional, used to enable resource owner contact feature in Search pages)
In addition, the eagle-i network uses a central server for hosting the central search application and a few other central services. The configuration of the central server is similar to that of the institutional servers.
Install the repository and applications
For an institutional installation, you will only need: Repository, SWEET, Help, and (optionally) institutional search. They constitute an eagle-i institutional server. Please download each of them and follow their respective installation guides. The repository needs to be installed first, followed by the applications in any order.
Central search, identity service and ontology browser are central applications, which run on the central search server. Institutions will not typically need to download or install these.
See also this high level overview: Quick Start Installation Guide
|
Component |
Releases |
Snapshots (daily builds) |
What to download? |
Installation |
|||||
---|---|---|---|---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b131ac5c-878e-47c6-bd9d-1f51f2e82be8"><ac:plain-text-body><![CDATA[ |
Institution |
Repository distribution |
[Repository releases |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/releases/org/eagle-i/eagle-i-repository-dist/] |
[Repository snapshots |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/snapshots/org/eagle-i/eagle-i-repository-dist/] |
|
[Repository Administrator Guide |
Repository Installation, Upgrade and Administration Guide] |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="51f7744a-e101-463a-ab07-dd08a25c8076"><ac:plain-text-body><![CDATA[ |
Institution |
SWEET webapp |
[SWEET releases |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/releases/org/eagle-i/eagle-i-webapp-sweet/] |
[SWEET snapshots |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/snapshots/org/eagle-i/eagle-i-webapp-sweet/] |
|
[Application Installation guide |
SWEET and Institutional Search Installation and Upgrade Guide] |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7970a4f5-5011-4dfd-974e-acb30741683f"><ac:plain-text-body><![CDATA[ |
Institution |
Institutional search webapp |
[Insitutional search releases |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/releases/org/eagle-i/eagle-i-webapp-institution/] |
[Institutional search snapshots |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/snapshots/org/eagle-i/eagle-i-webapp-institution/] |
|
[Application installation guide |
SWEET and Institutional Search Installation and Upgrade Guide] |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7be448e2-d30a-47ba-9ad6-a60129ea0a70"><ac:plain-text-body><![CDATA[ |
Institution |
Online help webapp |
[Help releases |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/releases/org/eagle-i/eagle-i-help/] |
[Help snapshots |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/snapshots/org/eagle-i/eagle-i-help/] |
|
[Application installation guide |
SWEET and Institutional Search Installation and Upgrade Guide] |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="fa35862c-fc9e-443b-af06-9ea0c19f406c"><ac:plain-text-body><![CDATA[ |
Institution |
Data management toolkit |
[Data management toolkit releases |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/releases/org/eagle-i/eagle-i-datatools-datamanagement/] |
[Data management toolkit snapshots |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/snapshots/org/eagle-i/eagle-i-datatools-datamanagement/] |
|
|
]]></ac:plain-text-body></ac:structured-macro> |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2a49de3c-2f33-4785-81b5-1d9c2697198f"><ac:plain-text-body><![CDATA[ |
Central |
Central search webapp |
[Central search releases |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/releases/org/eagle-i/eagle-i-webapp-central/] |
[Central search snapshots |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/snapshots/org/eagle-i/eagle-i-webapp-central/] |
|
|
]]></ac:plain-text-body></ac:structured-macro> |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ce5d4ddb-4255-42f2-ba54-90fc514e154a"><ac:plain-text-body><![CDATA[ |
Central |
Ontology browser webapp |
[Ontology browser releases |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/releases/org/eagle-i/eagle-i-webapp-model/] |
[Ontology browser snapshots |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/snapshots/org/eagle-i/eagle-i-webapp-model/] |
|
[Application installation guide |
SWEET and Institutional Search Installation and Upgrade Guide] |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7a594288-c9ab-405f-9af0-3e2fa0a84e05"><ac:plain-text-body><![CDATA[ |
Central |
Identity service |
[Identity service releases |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/releases/org/eagle-i/eagle-i-webapp-identity-service/] |
[Identity service snapshots |
http://infra.search.eagle-i.net:8081/nexus/content/repositories/snapshots/org/eagle-i/eagle-i-webapp-identity-service/] |
|
|
]]></ac:plain-text-body></ac:structured-macro> |
How are we doing?
Is there anything that could be clearer in our documentation? We welcome your questions and feedback.