Difference between revisions of "Build Instructions"

Latest revision as of 15:09, 15 August 2014

Higgins 2.0 build instructions.

Source Code

SVN Repo: https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2

Build Local Higgins Development Environment

Base requirements:Java JRE/SDK</p>

1. Download Maven (Required for building)

   Download Link: http://maven.apache.org/download.html

   • Follow installation instructions for platform.
     
   • Add "<MAVEN_INSTALL_PATH>/bin" directory to system PATH environment.
     
2. Download and install OpenAnzo

   Download Link: http://www.openanzo.org/downloads.html

   • Extract and copy to appropriate path.
     
   • Startup OpenAnzo server: "<OPENANZO_INSTALL_PATH>/startAnzo.bat"
     

   NOTE: Anzo is not fully started until you see the message "All Currently Registered Services started."

3. Download and install latest Apache Tomcat, setup configuration

   Download Link: http://tomcat.apache.org/download-70.cgi

   Change local http port to 8088
   

   • Extract Tomcat archive and copy to appropriate path.
     
   • Edit: "<TOMCAT_INSTALL_PATH>/conf/server.xml"
     
   • Update: Line #70

   ORIGINAL: <Connector port="8080" protocol="HTTP/1.1" 
   CHANGED: <Connector port="8088" protocol="HTTP/1.1"

   Add local server user account
   

   • Edit: "<TOMCAT_INSTALL_PATH>/conf/tomcat-users.xml"
     
   • Add entry inside of <tomcat-users> block
     
   • (NOTE: Change "myUserName" and "myUserPass" to whatever you want them to be)
     

   Example:

   <user username="myUserName" 
         password="myUserPass" 
         roles="manager-gui,manager-script,admin,admin-gui,manager,tomcat,admin-script"/>

   Start Apache Tomcat server via: "<TOMCAT_INSTALL_PATH>/bin/startup.bat"

4. Create maven profile
   • Edit: "<USER_HOME_DIRECTORY>/.m2/settings.xml"
     
   • Make sure the following code exists within the <settings> block:
     

   <profiles>
      <profile>
         <id>local</id>
         <properties>
            <chromium.bin>/opt/google/chrome/chrome</chromium.bin>
            <tomcat.url>http://localhost:8088/manager/text/</tomcat.url>
            <tomcat.username>myUserName</tomcat.username>
            <tomcat.password>myUserPass</tomcat.password>
         </properties>
      </profile>
   </profiles>

   • (NOTE: "myUserName" and "myUserPass" should match to the entries you entered for the line in the tomcat-users.xml file from step 3.)
     
5. Download Nginx and setup configuration

   Download Link: http://nginx.org/en/download.html
   Extract Nginx archive and copy to appropriate path.

   Configure nginx.conf file
   

   • Edit: "<NGINX_INSTALL_PATH>/conf/nginx.conf"
     
   • Inside of "server" section, replace the entire "location /" block with the following entries:
     

   location / {
   	access_log      off;
   	proxy_pass http://localhost:8044/;
   	proxy_set_header X-Real-IP  $remote_addr;
   	proxy_set_header Host $host;
   	proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
   }
   
   location /cometd {
   	access_log      off;
   	proxy_pass http://localhost:8080/cometd/;
   	proxy_set_header X-Real-IP  $remote_addr;
   	proxy_set_header Host $host;
   	proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
   }
   
   location /hdsp {
   	access_log      off;
   	proxy_pass http://localhost:8088/hdsp/;
   	proxy_set_header X-Real-IP  $remote_addr;
   	proxy_set_header Host $host;
   	proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
   }
   
   location /test-project {
   	access_log      off;
   	proxy_pass http://localhost:8078/test-project;
   	proxy_set_header X-Real-IP  $remote_addr;
   	proxy_set_header Host $host;
   	proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
   }

   Inside of "server" section, just after "listen" and "server_name" properties, add:

   client_max_body_size 40M;
   client_body_buffer_size 128k;

   Start nginx via "<NGINX_INSTALL_PATH>/nginx.exe"

6. Checkout Higgins H2 project

   SVN Repo: https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2

7. Perform base build of PDS client
   

   From a shell:

   > cd <HIGGINS_INSTALL_PATH>/org.eclipse.higgins.pds.client
   > mvn clean install -P local

Setting up a new Project using Higgins Dependencies

When creating a new project to utilize Higgins, please make sure that the pom.xml files contain the following entry:

NOTE: You will only need to add this section to new projects you create which are based off of Higgins code. Look for examples of the pom.xml files in the root of each of the projects downloaded from the Higgins SVN.

<project>
 ...
   <repositories>

      <repository>
         <id>higgins-snapshots</id>
         <name>Higgins 2.0 Snapshots</name>
         <url>http://my.azigo.net/repo/content/repositories/higgins-snapshots/</url>
         <snapshots>
            <enabled>true</enabled>
         </snapshots>
      </repository>

   </repositories>
 ...
</project>

Bugzilla

For Higgins 2.0 use Components=H2-XXXX:

• Enter a bug
• Search for Higgins bugs

Mailing lists

• higgins-dev, archive - main list
• higgins-announce, archive

Misc

• Higgins 1.x Developer Page - internal committers page - archived version
• Related Communities