Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Build Instructions"

(Get the Code)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{#eclipseproject:technology.higgins|eclipse_custom_style.css}} [[Image:Higgins logo 76Wx100H.jpg|right]]  
+
[[Image:Higgins logo 76Wx100H.jpg|right]]  
 +
Higgins 2.0 build instructions.
  
 +
== Source Code  ==
  
=== Get the Code  ===
+
'''SVN Repo:''' [https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2 https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2]
  
'''SVN Repo:''' [https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2 https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2]
+
==Build Local Higgins Development Environment==
  
=== Build Local Higgins Development Environment ===
+
'''Base requirements:'''Java JRE/SDK</p>
  
'''Base requirements:''' Java JRE/SDK
+
<ol class="instruct">
 +
<li><strong>Download Maven (Required for building)</strong>
 +
<p>Download Link: [http://maven.apache.org/download.html http://maven.apache.org/download.html]</p>
 +
*Follow installation instructions for platform.<br/>
 +
*Add &quot;&lt;MAVEN_INSTALL_PATH&gt;/bin&quot; directory to system PATH environment.<br/>
 +
</li>
 +
<li><strong>Download and install OpenAnzo</strong>
 +
<p>Download Link: [http://www.openanzo.org/downloads.html http://www.openanzo.org/downloads.html]</p>
 +
*Extract and copy to appropriate path.<br/>
 +
*Startup OpenAnzo server: &quot;&lt;OPENANZO_INSTALL_PATH&gt;/startAnzo.bat&quot;<br/>
 +
<p><i>NOTE: Anzo is not fully started until you see the message "All Currently Registered Services started."</i></p>
  
#'''Download Maven (Required for building)'''
+
</li>
Download Link: [http://maven.apache.org/download.html http://maven.apache.org/download.html]
+
<li><strong>Download and install latest Apache Tomcat, setup configuration</strong>
  
#*Follow installation instructions for platform.<br>  
+
<p>Download Link: [http://tomcat.apache.org/download-70.cgi http://tomcat.apache.org/download-70.cgi]</p>
#*Add "&lt;MAVEN_INSTALL_PATH&gt;/bin" directory to system PATH environment.<br> 
+
#'''Download and install OpenAnzo'''
+
Download Link: [http://www.openanzo.org/downloads.html http://www.openanzo.org/downloads.html]
+
  
#*Extract and copy to appropriate path.<br>  
+
<strong>Change local http port to 8088</strong><br/>
#*Startup OpenAnzo server: "&lt;OPENANZO_INSTALL_PATH&gt;/startAnzo.bat"<br>
+
*Extract Tomcat archive and copy to appropriate path.<br/>
#'''Download and install latest Apache Tomcat, setup configuration'''
+
*Edit: &quot;&lt;TOMCAT_INSTALL_PATH&gt;/conf/server.xml&quot;<br/>
Download Link: [http://tomcat.apache.org/download-70.cgi http://tomcat.apache.org/download-70.cgi]
+
*Update: Line #70
 +
<pre class="code">
 +
ORIGINAL: &lt;Connector port=&quot;8080&quot; protocol=&quot;HTTP/1.1&quot;
 +
CHANGED: &lt;Connector port=&quot;8088&quot; protocol=&quot;HTTP/1.1&quot;</pre>
  
'''Change local http port to 8088'''<br>  
+
<strong>Add local server user account</strong><br/>
 +
*Edit: &quot;&lt;TOMCAT_INSTALL_PATH&gt;/conf/tomcat-users.xml&quot;<br/>
 +
*Add entry inside of &lt;tomcat-users&gt; block<br/>
 +
*<i>(NOTE: Change &quot;<u>myUserName</u>&quot; and &quot;<u>myUserPass</u>&quot; to whatever you want them to be)</i><br/>
  
#*Extract Tomcat archive and copy to appropriate path.<br>  
+
<p>Example:</p>
#*Edit: "&lt;TOMCAT_INSTALL_PATH&gt;/conf/server.xml"<br>
+
#*Update: Line #70 <pre class="code">ORIGINAL: &lt;Connector port="8080" protocol="HTTP/1.1"
+
CHANGED: &lt;Connector port="8088" protocol="HTTP/1.1"</pre>
+
'''Add local server user account'''<br>  
+
  
#*Edit: "&lt;TOMCAT_INSTALL_PATH&gt;/conf/tomcat-users.xml"<br>
+
<pre class="code">&lt;user username=&quot;myUserName&quot;
#*Add entry inside of &lt;tomcat-users&gt; block<br>
+
       password=&quot;myUserPass&quot;
#*''(NOTE: Change "<u>myUserName</u>" and "<u>myUserPass</u>" to whatever you want them to be)''<br>
+
       roles=&quot;manager-gui,manager-script,admin,admin-gui,manager,tomcat,admin-script&quot;/&gt;</pre>
Example:
+
<pre class="code">&lt;user username="myUserName"
+
       password="myUserPass"
+
       roles="manager-gui,manager-script,admin,admin-gui,manager,tomcat,admin-script"/&gt;</pre>  
+
Start Apache Tomcat server via: "&lt;TOMCAT_INSTALL_PATH&gt;/bin/startup.bat"
+
  
#'''Create maven profile'''
+
<p>Start Apache Tomcat server via: &quot;&lt;TOMCAT_INSTALL_PATH&gt;/bin/startup.bat&quot;</p>
#*Edit: "&lt;USER_HOME_DIRECTORY&gt;/.m2/settings.xml"<br>  
+
 
#*Make sure the following code exists within the &lt;settings&gt; block:<br> <pre class="code">&lt;profiles&gt;
+
</li>
 +
<li><strong>Create maven profile</strong>
 +
*Edit: &quot;&lt;USER_HOME_DIRECTORY&gt;/.m2/settings.xml&quot;<br/>
 +
*Make sure the following code exists within the &lt;settings&gt; block:<br/>
 +
<pre class="code">
 +
&lt;profiles&gt;
 
   &lt;profile&gt;
 
   &lt;profile&gt;
 
       &lt;id&gt;local&lt;/id&gt;
 
       &lt;id&gt;local&lt;/id&gt;
Line 52: Line 63:
 
       &lt;/properties&gt;
 
       &lt;/properties&gt;
 
   &lt;/profile&gt;
 
   &lt;/profile&gt;
&lt;/profiles&gt;</pre>  
+
&lt;/profiles&gt;</pre>
#*''(NOTE: "myUserName" and "myUserPass" should match to the entries you entered for the line in the tomcat-users.xml file from step 3.)''<br>
+
*<i>(NOTE: &quot;myUserName&quot; and &quot;myUserPass&quot; should match to the entries you entered for the line in the tomcat-users.xml file from step 3.)</i><br/>
#'''Download Nginx and setup configuration'''
+
</li>
Download Link: [http://nginx.org/en/download.htm http://nginx.org/en/download.html]<br> Extract Nginx archive and copy to appropriate path.
+
<li><strong>Download Nginx and setup configuration</strong>
 +
<p>Download Link: [http://nginx.org/en/download.htm http://nginx.org/en/download.html]<br/>
 +
Extract Nginx archive and copy to appropriate path.</p>
 +
 +
<strong>Configure nginx.conf file</strong><br/>
 +
*Edit: &quot;&lt;NGINX_INSTALL_PATH&gt;/conf/nginx.conf&quot;<br/>
 +
*Inside of &quot;server&quot; section, replace the entire &quot;location /&quot; block with the following entries:<br/>
  
'''Configure nginx.conf file'''<br>
+
<pre class="code">
 
+
location / {
#*Edit: "&lt;NGINX_INSTALL_PATH&gt;/conf/nginx.conf"<br>
+
#*Inside of "server" section, replace the entire "location /" block with the following entries:<br> <pre class="code">location / {
+
 
access_log      off;
 
access_log      off;
 
proxy_pass http://localhost:8044/;
 
proxy_pass http://localhost:8044/;
Line 90: Line 105:
 
proxy_set_header Host $host;
 
proxy_set_header Host $host;
 
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
 
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}</pre>  
+
}</pre>
Inside of "server" section, just after "listen" and "server_name" properties, add:
+
<pre class="code">client_max_body_size 40M;
+
client_body_buffer_size 128k;</pre>
+
Start nginx via "&lt;NGINX_INSTALL_PATH&gt;/nginx.exe"
+
  
#'''Checkout Higgins R2 project'''
+
Inside of "server" section, just after "listen" and "server_name" properties, add:
SVN Repo: [https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2 https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2]
+
<pre class="code">
 +
client_max_body_size 40M;
 +
client_body_buffer_size 128k;</pre>
  
#'''Perform base build of PDS client'''<br>
+
<p>Start nginx via &quot;&lt;NGINX_INSTALL_PATH&gt;/nginx.exe&quot;</p>
From a shell:
+
<pre class="code">&gt; cd &lt;HIGGINS_INSTALL_PATH&gt;/org.eclipse.higgins.pds.client
+
&gt; mvn clean install -P local</pre>
+
  
=== Setting up a new Project using Higgins Dependancies ===
+
</li>
 +
<li><strong>Checkout Higgins H2 project</strong>
 +
<p>SVN Repo: [https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2 https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2]</p>
 +
</li>
 +
<li><strong>Perform base build of PDS client</strong><br/>
 +
<p>From a shell:</p>
 +
<pre class="code">
 +
> cd &lt;HIGGINS_INSTALL_PATH&gt;/org.eclipse.higgins.pds.client
 +
> mvn clean install -P local</pre>
 +
</li>
 +
</ol>
  
When creating a new project to utilize Higgins, please have the pom.xml file contain the following entries:
+
==Setting up a new Project using Higgins Dependencies==
<pre class="code">&lt;project&gt;
+
 
 +
<p>When creating a new project to utilize Higgins, please make sure that the pom.xml files contain the following entry:</p>
 +
<p><i>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.</i></p>
 +
<pre class="code">
 +
&lt;project&gt;
 
  ...
 
  ...
 
   &lt;repositories&gt;
 
   &lt;repositories&gt;
Line 124: Line 148:
 
&lt;/project&gt;
 
&lt;/project&gt;
 
</pre>
 
</pre>
 +
  
 
== Bugzilla ==
 
== Bugzilla ==
  
*[https://bugs.eclipse.org/bugs/query.cgi?product=Higgins search for Higgins bugs]  
+
For Higgins 2.0 use Components=H2-XXXX:
*[https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Higgins enter a Higgins bug]
+
*[https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Higgins Enter a bug]  
 +
*[https://bugs.eclipse.org/bugs/query.cgi?product=Higgins Search for Higgins bugs]
  
 
== Mailing lists ==
 
== Mailing lists ==
Line 134: Line 160:
 
*[https://dev.eclipse.org/mailman/listinfo/higgins-dev higgins-dev], [http://dev.eclipse.org/mhonarc/lists/higgins-dev/maillist.html archive] - main list  
 
*[https://dev.eclipse.org/mailman/listinfo/higgins-dev higgins-dev], [http://dev.eclipse.org/mhonarc/lists/higgins-dev/maillist.html archive] - main list  
 
*[https://dev.eclipse.org/mailman/listinfo/higgins-announce higgins-announce], [http://dev.eclipse.org/mhonarc/lists/higgins-announce/maillist.html archive]
 
*[https://dev.eclipse.org/mailman/listinfo/higgins-announce higgins-announce], [http://dev.eclipse.org/mhonarc/lists/higgins-announce/maillist.html archive]
 +
 
== Misc ==  
 
== Misc ==  
  

Latest revision as of 15:09, 15 August 2014

Higgins logo 76Wx100H.jpg

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:

Mailing lists

Misc

Back to the top