blob: 83795c115bcd458e7323da335507cacd5da2773c [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.7.1 at 2016-09-23
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="author" content="Apache OpenMeetings Team" />
<meta name="Date-Revision-yyyymmdd" content="20160923" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache OpenMeetings Project &#x2013; Build instructions version 3.0.x</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script type="text/javascript" src="./js/apache-maven-fluido-1.5.min.js"></script>
<script type="text/javascript" src="http://openmeetings.apache.org/js/site.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<div id="banner">
<div class="pull-left">
<a href="index.html" id="bannerLeft">
<img src="images/logo.png" alt="Apache OpenMeetings"/>
</a>
</div>
<div class="pull-right"> <a href="http://apache.org" id="bannerRight">
<img src="http://apache.org/img/asf_logo.png" alt="Apache"/>
</a>
</div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2016-09-23
</li>
<li class="pull-right">
<span class="divider">|</span>
<a href="https://cwiki.apache.org/confluence/display/OPENMEETINGS" class="externalLink" title="Wiki">
Wiki</a>
</li>
<li class="pull-right">
<span class="divider">|</span>
<a href="installation.html" title="Installation">
Installation</a>
</li>
<li class="pull-right">
<span class="divider">|</span>
<a href="downloads.html" title="Download">
Download</a>
</li>
<li class="pull-right">
<a href="demo.html" title="Demo">
Demo</a>
</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li>
<a href="#general" title="General">
<span class="icon-chevron-down"></span>
General</a>
<ul class="nav nav-list">
<li>
<a href="index.html" title="Home">
<span class="none"></span>
Home</a>
</li>
<li>
<a href="demo.html" title="Demo">
<span class="none"></span>
Demo</a>
</li>
<li>
<a href="license.html" title="License">
<span class="none"></span>
License</a>
</li>
<li>
<a href="http://www.apache.org/" class="externalLink" title="ASF">
<span class="none"></span>
ASF</a>
</li>
<li>
<a href="downloads.html" title="Downloads">
<span class="none"></span>
Downloads</a>
</li>
<li>
<a href="CallForLogo.html" title="Call For Logo">
<span class="none"></span>
Call For Logo</a>
</li>
<li>
<a href="NewsArchive.html" title="News archive">
<span class="none"></span>
News archive</a>
</li>
<li>
<a href="security.html" title="Security">
<span class="none"></span>
Security</a>
</li>
<li>
<a href="commercial-support.html" title="Commercial Support">
<span class="none"></span>
Commercial Support</a>
</li>
</ul>
</li>
<li>
<a href="#installation" title="Installation and Upgrade">
<span class="icon-chevron-down"></span>
Installation and Upgrade</a>
<ul class="nav nav-list">
<li>
<a href="installation.html" title="Installation">
<span class="none"></span>
Installation</a>
</li>
<li>
<a href="Upgrade.html" title="Upgrade">
<span class="none"></span>
Upgrade</a>
</li>
<li>
<a href="https://cwiki.apache.org/confluence/display/OPENMEETINGS/Tutorials+for+installing+OpenMeetings+and+Tools" class="externalLink" title="Tutorials">
<span class="none"></span>
Tutorials</a>
</li>
<li>
<a href="CommandLineAdmin.html" title="Command Line Admin">
<span class="none"></span>
Command Line Admin</a>
</li>
</ul>
</li>
<li>
<a href="#community" title="Community">
<span class="icon-chevron-down"></span>
Community</a>
<ul class="nav nav-list">
<li>
<a href="get-involved.html" title="Get Involved">
<span class="none"></span>
Get Involved</a>
</li>
<li>
<a href="team-list.html" title="Committers">
<span class="none"></span>
Committers</a>
</li>
<li>
<a href="mail-lists.html" title="Mailing Lists">
<span class="none"></span>
Mailing Lists</a>
</li>
<li>
<a href="http://cwiki.apache.org/confluence/display/OPENMEETINGS/" class="externalLink" title="Wiki">
<span class="none"></span>
Wiki</a>
</li>
</ul>
</li>
<li>
<a href="#dev" title="Development">
<span class="icon-chevron-down"></span>
Development</a>
<ul class="nav nav-list">
<li>
<a href="source-repository.html" title="Source Code">
<span class="none"></span>
Source Code</a>
</li>
<li>
<a href="issue-tracking.html" title="Bugs / Issues">
<span class="none"></span>
Bugs / Issues</a>
</li>
<li>
<a href="dependencies.html" title="Dependencies">
<span class="none"></span>
Dependencies</a>
</li>
<li>
<a href="integration.html" title="Continuous Integration">
<span class="none"></span>
Continuous Integration</a>
</li>
<li class="active">
<a href="#"><span class="none"></span>Build Instructions 3.0.x</a>
</li>
<li>
<a href="BuildInstructions.html" title="Build Instructions">
<span class="none"></span>
Build Instructions</a>
</li>
<li>
<a href="JUnitTesting.html" title="JUnit Testing">
<span class="none"></span>
JUnit Testing</a>
</li>
<li>
<a href="ManualTesting.html" title="Manual Testing">
<span class="none"></span>
Manual Testing</a>
</li>
<li>
<a href="ReleaseGuide.html" title="Release Guide">
<span class="none"></span>
Release Guide</a>
</li>
<li>
<a href="WebsiteGuide.html" title="Website Guide">
<span class="none"></span>
Website Guide</a>
</li>
</ul>
</li>
<li>
<a href="#integration" title="Integration">
<span class="icon-chevron-down"></span>
Integration</a>
<ul class="nav nav-list">
<li>
<a href="openmeetings-webservice/apidocs/index.html" target="_blank" title="SOAP/REST API">
<span class="none"></span>
SOAP/REST API</a>
</li>
<li>
<a href="RestAPISample.html" title="REST API Sample">
<span class="none"></span>
REST API Sample</a>
</li>
<li>
<a href="LdapAndADS.html" title="Ldap and ADS">
<span class="none"></span>
Ldap and ADS</a>
</li>
<li>
<a href="oauth2.html" title="OAuth2">
<span class="none"></span>
OAuth2</a>
</li>
<li>
<a href="voip-sip-integration.html" title="VoIP and SIP">
<span class="none"></span>
VoIP and SIP</a>
</li>
<li>
<a href="errorvalues.html" title="Errors table">
<span class="none"></span>
Errors table</a>
</li>
</ul>
</li>
<li>
<a href="#plugins" title="Plugins">
<span class="icon-chevron-down"></span>
Plugins</a>
<ul class="nav nav-list">
<li>
<a href="MoodlePlugin.html" title="Moodle Plugin">
<span class="none"></span>
Moodle Plugin</a>
</li>
<li>
<a href="SakaiPlugin.html" title="Sakai Plugin">
<span class="none"></span>
Sakai Plugin</a>
</li>
<li>
<a href="JiraPlugin.html" title="Jira Plugin">
<span class="none"></span>
Jira Plugin</a>
</li>
<li>
<a href="JoomlaPlugin.html" title="Joomla Plugin">
<span class="none"></span>
Joomla Plugin</a>
</li>
<li>
<a href="DrupalPlugin.html" title="Drupal Plugin">
<span class="none"></span>
Drupal Plugin</a>
</li>
<li>
<a href="BitrixPlugin.html" title="Bitrix Plugin">
<span class="none"></span>
Bitrix Plugin</a>
</li>
<li>
<a href="ConfluencePlugin.html" title="Confluence Plugin">
<span class="none"></span>
Confluence Plugin</a>
</li>
<li>
<a href="SugarCRMPlugin.html" title="SugarCRM Plugin">
<span class="none"></span>
SugarCRM Plugin</a>
</li>
<li>
<a href="RedminePlugin.html" title="Redmine Plugin">
<span class="none"></span>
Redmine Plugin</a>
</li>
</ul>
</li>
<li>
<a href="#config" title="Configuration">
<span class="icon-chevron-down"></span>
Configuration</a>
<ul class="nav nav-list">
<li>
<a href="#db" title="DB Sample Configurations">
<span class="icon-chevron-down"></span>
DB Sample Configurations</a>
<ul class="nav nav-list">
<li>
<a href="ApacheDerbyConfig.html" title="Apache Derby">
<span class="none"></span>
Apache Derby</a>
</li>
<li>
<a href="IBMDB2Config.html" title="IBM DB2">
<span class="none"></span>
IBM DB2</a>
</li>
<li>
<a href="OracleConfig.html" title="Oracle">
<span class="none"></span>
Oracle</a>
</li>
<li>
<a href="MySQLConfig.html" title="MySQL">
<span class="none"></span>
MySQL</a>
</li>
<li>
<a href="PostgresConfig.html" title="Postgres">
<span class="none"></span>
Postgres</a>
</li>
<li>
<a href="MSSQLConfig.html" title="MSSQL">
<span class="none"></span>
MSSQL</a>
</li>
</ul>
</li>
<li>
<a href="#localization" title="Localization and languages">
<span class="icon-chevron-down"></span>
Localization and languages</a>
<ul class="nav nav-list">
<li>
<a href="Internationalisation.html" title="Internationalisation">
<span class="none"></span>
Internationalisation</a>
</li>
<li>
<a href="LanguageEditor.html" title="LanguageEditor">
<span class="none"></span>
LanguageEditor</a>
</li>
<li>
<a href="TimeZoneHandling.html" title="TimeZoneHandling">
<span class="none"></span>
TimeZoneHandling</a>
</li>
<li>
<a href="EditTemplates.html" title="EditTemplates">
<span class="none"></span>
EditTemplates</a>
</li>
</ul>
</li>
<li>
<a href="#port" title="NAT Port Settings">
<span class="icon-chevron-down"></span>
NAT Port Settings</a>
<ul class="nav nav-list">
<li>
<a href="PortSettings.html" title="Port settings">
<span class="none"></span>
Port settings</a>
</li>
</ul>
</li>
<li>
<a href="#performance" title="Performance">
<span class="icon-chevron-down"></span>
Performance</a>
<ul class="nav nav-list">
<li>
<a href="JVMPerformanceTuning.html" title="JVM performance tuning">
<span class="none"></span>
JVM performance tuning</a>
</li>
<li>
<a href="NetworkCalculator.html" title="Network bandwidth calculator">
<span class="none"></span>
Network bandwidth calculator</a>
</li>
</ul>
</li>
<li>
<a href="#interface" title="User Interface">
<span class="icon-chevron-down"></span>
User Interface</a>
<ul class="nav nav-list">
<li>
<a href="themes-and-branding.html" title="Themes">
<span class="none"></span>
Themes</a>
</li>
<li>
<a href="Dashboard.html" title="Dashboard">
<span class="none"></span>
Dashboard</a>
</li>
<li>
<a href="WebcamResolutions.html" title="Webcam resolutions">
<span class="none"></span>
Webcam resolutions</a>
</li>
<li>
<a href="ConferenceRoomLayoutOptions.html" title="Room layout options">
<span class="none"></span>
Room layout options</a>
</li>
<li>
<a href="HotKeys.html" title="Hot Keys">
<span class="none"></span>
Hot Keys</a>
</li>
</ul>
</li>
<li>
<a href="#customize" title="Customization">
<span class="icon-chevron-down"></span>
Customization</a>
<ul class="nav nav-list">
<li>
<a href="WebappNamePath.html" title="Webapp name/path">
<span class="none"></span>
Webapp name/path</a>
</li>
<li>
<a href="Navigation.html" title="Navigation">
<span class="none"></span>
Navigation</a>
</li>
<li>
<a href="CalendarAndTimezone.html" title="Calendar and timezone">
<span class="none"></span>
Calendar and timezone</a>
</li>
<li>
<a href="CustomRoomTypeHowTo.html" title="Custom room type">
<span class="none"></span>
Custom room type</a>
</li>
<li>
<a href="CustomCryptMechanism.html" title="Custom crypt mechanism">
<span class="none"></span>
Custom crypt mechanism</a>
</li>
<li>
<a href="GeneralConfiguration.html" title="General Configuration">
<span class="none"></span>
General Configuration</a>
</li>
</ul>
</li>
<li>
<a href="#security" title="Security">
<span class="icon-chevron-down"></span>
Security</a>
<ul class="nav nav-list">
<li>
<a href="RestrictedAccess.html" title="Restricted Access">
<span class="none"></span>
Restricted Access</a>
</li>
<li>
<a href="RTMPSAndHTTPS.html" title="RTMPS and HTTPS">
<span class="none"></span>
RTMPS and HTTPS</a>
</li>
</ul>
</li>
<li>
<a href="#convert" title="Converters">
<span class="icon-chevron-down"></span>
Converters</a>
<ul class="nav nav-list">
<li>
<a href="OpenOfficeConverter.html" title="OpenOffice Converter">
<span class="none"></span>
OpenOffice Converter</a>
</li>
<li>
<a href="FFMPEGVersionSwitch.html" title="FFMPEG Version Switch">
<span class="none"></span>
FFMPEG Version Switch</a>
</li>
</ul>
</li>
<li>
<a href="#cluster" title="Clustering">
<span class="icon-chevron-down"></span>
Clustering</a>
<ul class="nav nav-list">
<li>
<a href="Clustering.html" title="Clustering">
<span class="none"></span>
Clustering</a>
</li>
</ul>
</li>
<li>
<a href="#misc" title="Misc">
<span class="icon-chevron-down"></span>
Misc</a>
<ul class="nav nav-list">
<li>
<a href="GetVersionInfo.html" title="Get version info">
<span class="none"></span>
Get version info</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<hr />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
</div>
<div id="bodyColumn" class="span10" >
<div class="section">
<h2><a name="Nightly_Builds"></a>Nightly Builds</h2>
<p>
You can find Nightly Builds of the software at:
<a class="externalLink" href="https://builds.apache.org/view/M-R/view/OpenMeetings/" target="_blank" rel="nofollow">
https://builds.apache.org/view/M-R/view/OpenMeetings/
</a>
</p>
</div>
<div class="section">
<h2><a name="These_instructions_are_for_3.0.x_version_only"></a>These instructions are for 3.0.x version only</h2></div>
<div class="section">
<h2><a name="How_to_Build_a_Distribution"></a>How to Build a Distribution</h2>
<div>
<p>To build a binary release of OpenMeetings you need: </p>
<ul>
<li>Oracle JDK7</li>
<li>Apache ANT (minimum) 1.8.3</li>
<li>
SVN Command line client (Subversion 1.7 required!)
<a class="externalLink" href="http://subversion.apache.org/packages.html" target="_blank" rel="nofollow">http://subversion.apache.org/packages.html</a>
</li>
</ul>
</div>
<p>Get the source: </p>
<div class="source"><pre class="prettyprint">svn checkout https://svn.apache.org/repos/asf/openmeetings/application/branches/3.0.x</pre></div>
<p>Run the command: </p>
<div class="source"><pre class="prettyprint">ant </pre></div>
<p>There is no need to compile the client additionally! The ant task
does it all! You will find a directory dist that contains
OpenMeetings and a red5-server.
</p>
<p>To compile the client you can also use ant: </p>
<div class="source"><pre class="prettyprint">
ant # compiles a complete package into the folder dist
ant compile.laszlo.main # compiles the client into main.as3.swf10.swf and main.swf8.swf
ant compile.laszlo.main.debug # compiles the debug-client into maindebug.as3.swf10.swf and maindebug.swf8.swf
ant -Ddb=&lt;name of DB&gt; # will copy &lt;name of DB&gt;_persistense.xml to persistense.xml
#(for ex. ant -Ddb=mysql will set mysql as default DB)
</pre></div>
<p>To compile just the openmeetings JAR file: </p>
<div class="source"><pre class="prettyprint">ant jar.only</pre></div>
<p>
To run Junit tests using ANT see
<a href="JUnitTesting.html">JUnitTesting</a>
</p>
</div>
<div class="section">
<h2><a name="Run_Develop_Test"></a>Run, Develop, Test</h2>
<p>
To develop or build OpenMeetings you checkout the source as Eclipse
project. You need the Subclipse or Subversive Plugin for Eclipse. If
you just need to change 3 lines of code then your probably better
switch to
<a href="#How_to_build_a_distribution" rel="nofollow">How to build a
distribution
</a>
.
</p>
<div class="section">
<h3><a name="Step1_-_Get_required_Software"></a>Step1 - Get required Software</h3>
<p>To develop OpenMeetings you need at least: </p>
<ul>
<li>Eclipse in a up to date copy and Oracle JDK7 </li>
<li>Apache ANT (minimum) 1.8.3</li>
<li>
Subclipse 1.8 (Subversion 1.7 required!)
<a class="externalLink" href="http://subclipse.tigris.org/" target="_blank" rel="nofollow">http://subclipse.tigris.org/
</a>
</li>
<li>
SVN Command line client (Subversion 1.7 required!)
<a class="externalLink" href="http://subversion.apache.org/packages.html" target="_blank" rel="nofollow">http://subversion.apache.org/packages.html</a>
</li>
<li>Spring IDE for Eclipse (installable via Help &gt; Eclipse
Marketplace)
</li>
<li>
Apache IvyDE&#x2122; For Eclipse (installable via Help &gt; Install
New Software)
URL: http://www.apache.org/dist/ant/ivyde/updatesite
detailed steps can be found here:
<a class="externalLink" href="http://ant.apache.org/ivy/ivyde/download.cgi" target="_blank" rel="nofollow">http://ant.apache.org/ivy/ivyde/download.cgi</a>
</li>
<li>MySQL (or Postgres, or other Databases supported by openJPA)
are optionally but handy to have them
</li>
</ul>
</div>
<div class="section">
<h3><a name="Step2_-_Download_the_Source"></a>Step2 - Download the Source</h3>
<p>Advanced Users: Check out the Code from the Repository as a
Java
project into Eclipse.
</p>
<p>
URL:
<a class="externalLink" href="https://svn.apache.org/repos/asf/openmeetings/branches/3.0.x/">
https://svn.apache.org/repos/asf/openmeetings/branches/3.0.x/
</a>
</p>
<p>To download the required JARs for building and developing
OpenMeetings you need to run the ANT comand:
</p>
<div class="source"><pre class="prettyprint">ant -Ddb=&lt;your_DB&gt; dist prepare-eclipse</pre></div>
<p>After the ANT command you need to press F5 and rebuild the
project from inside Eclipse
</p>
<p>Step-By-Step: </p>
<p>1) Start Eclipse </p>
<p>
2) Change Perspective to SVN Repository Exploring:
<br />
<br />
<a href="images/checkout_1.png" class="fancybox-buttons">
<img src="images/checkout_1.png" alt="" width="400" height="289" />
</a>
</p>
<p>
3) Select SVN Repository Exploring and click ok.
<br />
<br />
<a href="images/checkout_2.png" class="fancybox-buttons">
<img src="images/checkout_2.png" alt="" width="304" height="417" />
</a>
</p>
<p>
4) A new Dialog in Eclipse opens
<b>SVN Repositories</b>
<br />
<br />
<a href="images/checkout_3.png" class="fancybox-buttons">
<img src="images/checkout_3.png" alt="" width="460" height="102" />
</a>
</p>
<p>
5) Click on the icon with the plus in the top right corner in the
SVN Repository Dialog
<br />
<br />
<a href="images/checkout_4.png" class="fancybox-buttons">
<img src="images/checkout_4.png" alt="" width="57" height="38" />
</a>
</p>
<p>
6) Add the URL
<a class="externalLink" href="https://svn.apache.org/repos/asf/openmeetings/branches/3.0.x/" rel="nofollow">
https://svn.apache.org/repos/asf/openmeetings/branches/3.0.x/
</a>
and click Finish
<br />
<br />
<a href="images/checkout_5.png" class="fancybox-buttons">
<img src="images/checkout_5.png" alt="" width="455" height="272" />
</a>
</p>
<p>
7) After download is complete you see a new Source Repository in
the Repository Explorer. Right click on it and choose
<b>checkout</b>
<br />
<br />
<a href="images/checkout_6.png" class="fancybox-buttons">
<img src="images/checkout_6.png" alt="" width="340" height="135" />
</a>
</p>
<p>
8) In the Dialog the opens now just click next
<br />
<br />
<a href="images/checkout_7.png" class="fancybox-buttons">
<img src="images/checkout_7.png" alt="" width="390" height="338" />
</a>
</p>
<p>
9) In the next Dialog just click Finish, Eclipse will then download
the sources
<br />
<br />
<a href="images/checkout_8.png" class="fancybox-buttons">
<img src="images/checkout_8.png" alt="" width="390" height="338" />
</a>
</p>
<p>
10) After the download is complete you will see a new Project in
the Package Explorer Dialog of Eclipse
<br />
<br />
<a href="images/checkout_9.png" class="fancybox-buttons">
<img src="images/checkout_9.png" alt="" width="310" height="297" />
</a>
</p>
<div>
11) Please run
<div class="source"><pre class="prettyprint">ant dist prepare-eclipse</pre></div>
to download all necessary jar files, and perform source
<tt>Refresh</tt>
to resolve all compilation issues.
</div>
</div>
<div class="section">
<h3><a name="Step3_-_Deploy_and_Run"></a>Step3 - Deploy and Run</h3>
<p>
see the first chapter about the ANT tasks to compile the code. You
will find a directory called
<b>dist</b>
which contains a regular openmeetings including red5. You can then
use the usual process like described at
<a href="installation.html">installation</a>
to run the code then.
</p>
</div>
</div>
<div class="section">
<h2><a name="Links"></a>Links</h2>
<ul>
<li>
Getting Started with OpenLaszlo, checkout
<a class="externalLink" href="http://www.openlaszlo.org/demos#Laszlo10" target="_blank" rel="nofollow">Laszlo-in-10-Minutes</a>
and the
<a class="externalLink" href="http://www.openlaszlo.org/taxonomy/term/14" target="_blank" rel="nofollow">Application Developer's Guide</a>
or try the
<a class="externalLink" href="http://www.openlaszlo.org/getstarted" target="_blank" rel="nofollow">ScreenCast</a>
</li>
<li>
<a class="externalLink" href="http://openmeetings.apache.org/source-repository.html">
browse SVN source
</a>
</li>
</ul>
</div>
<div class="section">
<h2><a name="Tips_and_Gotchas"></a>Tips and Gotchas</h2>
<p>When you want to develop only client side there are handy ANT
tasks so that you only rebuild the SWFs, same for the Java side.
</p>
<p>
It
also takes much less time if you do use MySQL as database then
rebuilding the software and waiting for Apache Derby to set up the
database everytime you did rebuild.
</p>
<p>
<b>Working behind a proxy:</b>
If you are sitting behind a proxy you should add some proxy settings
before starting the build process.
<br />
For Apache Ivy see:
<a class="externalLink" href="http://ant.apache.org/ivy/faq.html" target="_blank" rel="nofollow">http://ant.apache.org/ivy/faq.html
</a>
<br />
For SVN Command Line Client (From CollabNet 1.7) see:
<a class="externalLink" href="https://ctf6latest.collab.net/internal-help/index.jsp?topic=/teamforge610/faq/client_proxy_settings.html" target="_blank" rel="nofollow">https://ctf6latest.collab.net/internal-help/index.jsp?topic=/teamforge610/faq/client_proxy_settings.html
</a>
</p>
</div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p >Copyright &copy; 2012&#x2013;2016
<a href="http://apache.org">Apache Software Foundation</a>.
All rights reserved.
</p>
</div>
</div>
</footer>
</body>
</html>