Skip to main content

Notice: This Wiki is now read only and edits are no longer 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"

(Build Local Higgins Development Environment)
Line 14: Line 14:
  
 
=== <meta charset="utf-8">
 
=== <meta charset="utf-8">
=== Build Local Higgins Development Environment ===
+
<h3>Build Local Higgins Development Environment</h3>
  
'''Base requirements:'''&nbsp;Java JRE/SDK
+
<p><strong>Base requirements:</strong> Java JRE/SDK</p>
  
#'''Download Maven (Required for building)'''
+
<ol class="instruct">
Download Link:&nbsp;[http://maven.apache.org/download.html http://maven.apache.org/download.html]<br>Follow installation instructions for platform.<br>Add "&lt;MAVEN_INSTALL_PATH&gt;/bin" directory to system PATH environment.
+
<li><strong>Download Maven (Required for building)</strong>
 +
<p>Download Link: <a href="http://maven.apache.org/download.html" target="_blank">http://maven.apache.org/download.html</a><br/>
 +
Follow installation instructions for platform.<br/>
 +
Add &quot;&lt;MAVEN_INSTALL_PATH&gt;/bin&quot; directory to system PATH environment.</p>
 +
</li>
 +
<li><strong>Download and install OpenAnzo</strong>
 +
<p>Download Link: <a href="http://www.openanzo.org/downloads.html" target="_blank">http://www.openanzo.org/downloads.html</a><br/>
 +
Extract and copy to appropriate path.<br/>
 +
Startup OpenAnzo server: &quot;&lt;OPENANZO_INSTALL_PATH&gt;/startAnzo.bat&quot;</p>
 +
</li>
 +
<li><strong>Download and install latest Apache Tomcat, setup configuration</strong>
 +
<p>Download Link: <a href="http://tomcat.apache.org/download-70.cgi" target="_blank">http://tomcat.apache.org/download-70.cgi</a><br/>
  
#'''Download and install OpenAnzo'''
+
<dl class="code">
Download Link:&nbsp;[http://www.openanzo.org/downloads.html http://www.openanzo.org/downloads.html]<br>Extract and copy to appropriate path.<br>Startup OpenAnzo server: "&lt;OPENANZO_INSTALL_PATH&gt;/startAnzo.bat"
+
<dt>Change local http port to 8088</dt>
 +
<dd>Extract Tomcat archive and copy to appropriate path.</dd>
 +
<dd>Edit: &quot;&lt;TOMCAT_INSTALL_PATH&gt;/conf/server.xml&quot;</dd>
 +
<dd>Update: Line #70</dd>
 +
<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>
 +
</dl>
  
#'''Download and install latest Apache Tomcat, setup configuration'''
+
<dl class="code">
Download Link:&nbsp;[http://tomcat.apache.org/download-70.cgi http://tomcat.apache.org/download-70.cgi]<br>
+
<dt>Add local server user account</dt>
 +
<dd>Edit: &quot;&lt;TOMCAT_INSTALL_PATH&gt;/conf/tomcat-users.xml&quot;</dd>
 +
<dd>Add entry inside of &lt;tomcat-users&gt; block</dd>
 +
<dd><i>(NOTE: Change &quot;<u>myUserName</u>&quot; and &quot;<u>myUserPass</u>&quot; to whatever you want them to be)</i></dd>
 +
<dd>Example:</dd>
 +
<pre class="code">&lt;user username=&quot;myUserName&quot;
 +
      password=&quot;myUserPass&quot;
 +
      roles=&quot;manager-gui,manager-script,admin,admin-gui,manager,tomcat,admin-script&quot;/&gt;</pre>
 +
</dl>
  
#;Change local http port to 8088
+
<p>Start Apache Tomcat server via: &quot;&lt;TOMCAT_INSTALL_PATH&gt;/bin/startup.bat&quot;</p>
#:Extract Tomcat archive and copy to appropriate path.
+
#:Edit: "&lt;TOMCAT_INSTALL_PATH&gt;/conf/server.xml"
+
#: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
+
#:Edit: "&lt;TOMCAT_INSTALL_PATH&gt;/conf/tomcat-users.xml"
+
#:Add entry inside of &lt;tomcat-users&gt; block
+
#:''(NOTE: Change "<u>myUserName</u>" and "<u>myUserPass</u>" to whatever you want them to be)''
+
#: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'''
+
</li>
Edit: "&lt;USER_HOME_DIRECTORY&gt;/.m2/settings.xml"<br>Make sure the following code exists within the &lt;settings&gt; block:<br>
+
<li><strong>Create maven profile</strong>
<pre class="code">&lt;profiles&gt;
+
<p>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 53: Line 70:
 
       &lt;/properties&gt;
 
       &lt;/properties&gt;
 
   &lt;/profile&gt;
 
   &lt;/profile&gt;
&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><br>
+
&lt;/profiles&gt;</pre>
#'''Download Nginx and setup configuration'''
+
<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/><br/>
Download Link:&nbsp;[http://nginx.org/en/download.html http://nginx.org/en/download.html]<br>Extract Nginx archive and copy to appropriate path.
+
  
#;Configure nginx.conf file
+
</li>
#:Edit: "&lt;NGINX_INSTALL_PATH&gt;/conf/nginx.conf"
+
<li><strong>Download Nginx and setup configuration</strong>
#:Inside of "server" section, replace the entire "location /" block with the following entries:<pre class="code">location / {
+
<p>Download Link: <a href="http://nginx.org/en/download.html" target="_blank">http://nginx.org/en/download.html</a><br/>
 +
Extract Nginx archive and copy to appropriate path.</p>
 +
 +
<dl class="code">
 +
<dt>Configure nginx.conf file</dt>
 +
<dd>Edit: &quot;&lt;NGINX_INSTALL_PATH&gt;/conf/nginx.conf&quot;</dd>
 +
<dd>Inside of &quot;server&quot; section, replace the entire &quot;location /&quot; block with the following entries:</dd>
 +
<pre class="code">
 +
location / {
 
access_log      off;
 
access_log      off;
 
proxy_pass http://localhost:8044/;
 
proxy_pass http://localhost:8044/;
Line 90: Line 114:
 
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;
+
 
 +
<dd>Inside of "server" section, just after "listen" and "server_name" properties, add:</dd>
 +
<pre class="code">
 +
client_max_body_size 40M;
 
client_body_buffer_size 128k;</pre>
 
client_body_buffer_size 128k;</pre>
Start nginx via "&lt;NGINX_INSTALL_PATH&gt;/nginx.exe"
+
</dl>
  
#'''Checkout Higgins R2 project'''
+
<p>Start nginx via &quot;&lt;NGINX_INSTALL_PATH&gt;/nginx.exe&quot;</p>
SVN Repo:&nbsp;[https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2 https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2]
+
  
#'''Perform base build of PDS client'''
+
</li>
#:From a shell:<pre class="code">&gt; cd &lt;HIGGINS_INSTALL_PATH&gt;/org.eclipse.higgins.pds.client
+
<li><strong>Checkout Higgins R2 project</strong>
&gt; mvn clean install -P local</pre>
+
<p>SVN Repo: <a href="https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2" target="_blank">https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2</a></p>
</meta> ===
+
</li>
 +
<li><strong>Perform base build of PDS client</strong>
 +
<dl class="code">
 +
<dd>From a shell:</dd>
 +
<pre class="code">
 +
> cd &lt;HIGGINS_INSTALL_PATH&gt;/org.eclipse.higgins.pds.client
 +
> mvn clean install -P local</pre>
 +
</dl>
 +
</li>
 +
</ol>
  
 
== Misc: ==  
 
== Misc: ==  

Revision as of 18:05, 25 April 2011

{{#eclipseproject:technology.higgins|eclipse_custom_style.css}}
Higgins logo 76Wx100H.jpg
Bugzilla

Mailing lists:

Get the Code

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

=== <meta charset="utf-8">

Build Local Higgins Development Environment

Base requirements: Java JRE/SDK

  1. Download Maven (Required for building)

    Download Link: <a href="http://maven.apache.org/download.html" target="_blank">http://maven.apache.org/download.html</a>
    Follow installation instructions for platform.
    Add "<MAVEN_INSTALL_PATH>/bin" directory to system PATH environment.

  2. Download and install OpenAnzo

    Download Link: <a href="http://www.openanzo.org/downloads.html" target="_blank">http://www.openanzo.org/downloads.html</a>
    Extract and copy to appropriate path.
    Startup OpenAnzo server: "<OPENANZO_INSTALL_PATH>/startAnzo.bat"

  3. Download and install latest Apache Tomcat, setup configuration

    Download Link: <a href="http://tomcat.apache.org/download-70.cgi" target="_blank">http://tomcat.apache.org/download-70.cgi</a>

    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"/>
    <p>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.)

    </li>

  5. Download Nginx and setup configuration <p>Download Link: <a href="http://nginx.org/en/download.html" target="_blank">http://nginx.org/en/download.html</a>
    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 R2 project

    SVN Repo: <a href="https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2" target="_blank">https://dev.eclipse.org/svnroot/technology/org.eclipse.higgins/trunk/H2</a>

  7. Perform base build of PDS client
    From a shell:
    > cd <HIGGINS_INSTALL_PATH>/org.eclipse.higgins.pds.client
    > mvn clean install -P local

Misc:

Back to the top