blob: 077b4e08ddaed09445ea34198fff9550f212bdcd [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; List of general configuration options</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>
<a href="BuildInstructions_3.0.x.html" title="Build Instructions 3.0.x">
<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 class="active">
<a href="#"><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="List_of_general_configuration_options"></a>List of general configuration options</h2>
<p>In Administration &gt; Configuration there are a number of
configuration values.
</p>
<p></p>
<table border="0" class="table table-striped">
<tr class="a">
<th> key </th>
<th> default </th>
<th> meaning </th>
<th> availabe since OpenMeetings version </th>
</tr>
<tr class="b">
<td> dashboard.show.myrooms </td>
<td> 0 or 1 </td>
<td> Dashboard: If the MyRooms widget should be visible or not </td>
<td> 1.9.x </td>
</tr>
<tr class="a">
<td> dashboard.show.chat </td>
<td> 0 or 1 </td>
<td> Dashboard: If the Chat widget should be visible or not </td>
<td> 1.9.x </td>
</tr>
<tr class="b">
<td> dashboard.show.rssfeed </td>
<td> 0 or 1 </td>
<td> Dashboard: If the RSS-Feed widget should be visible or not </td>
<td> 1.9.x </td>
</tr>
<tr class="a">
<td> rss_feed1 </td>
<td> http-URL </td>
<td> Dashboard: ATOM-Feed URL for the dashboard RSS Tab </td>
<td> 1.9.x </td>
</tr>
<tr class="b">
<td> rss_feed2 </td>
<td> http-URL </td>
<td> Dashboard: ATOM-Feed URL for the dashboard RSS Tab </td>
</tr>
<tr class="a">
<td> ldap_default_id </td>
<td> 0 </td>
<td> Ldap domain selected by default in the login screen </td>
<td> 1.9.x </td>
</tr>
<tr class="b">
<td> user.login.minimum.length </td>
<td> 4 </td>
<td> minimum chars required for the login to create a user </td>
<td> 1.9.x </td>
</tr>
<tr class="a">
<td> user.pass.minimum.length </td>
<td> 4 </td>
<td> minimum chars required for the password to create a
user
</td>
<td> 1.9.x </td>
</tr>
<tr class="b">
<td> number.minutes.reminder.send </td>
<td> 15 </td>
<td> minutes the one-time reminder in the calender is
send, set to 0 to disable reminder
</td>
<td> 1.9.x </td>
</tr>
<tr class="a">
<td> max_upload_size </td>
<td> 1073741824 </td>
<td> Maximum size of upload file (bytes) 1073741824 bytes
= 1GB
</td>
<td> 1.8.x </td>
</tr>
<tr class="b">
<td> show.whiteboard.draw.status </td>
<td> 0 </td>
<td> Display name of the user who draw the current object
(User Name auto-disapper after 3 seconds.
</td>
<td> 1.8.x </td>
</tr>
<tr class="a">
<td> use.old.style.ffmpeg.map.option </td>
<td> 0 </td>
<td> If the system should &quot;.&quot; (old ffmpeg) instead of &quot;:&quot;
(new ffmpeg) for the -map option in FFMPEG
</td>
<td> 1.9.x </td>
</tr>
<tr class="b">
<td> smtp_server </td>
<td> localhost </td>
<td> this is the smtp server to send messages </td>
<td> 1.9.x </td>
</tr>
<tr class="a">
<td> smtp_port </td>
<td> 25 </td>
<td> this is the smtp server port normally 25 </td>
<td> 1.9.x </td>
</tr>
<tr class="b">
<td> email_username </td>
<td> </td>
<td> System auth email username </td>
<td> 1.9.x </td>
</tr>
<tr class="a">
<td> email_userpass </td>
<td> </td>
<td> System auth email password </td>
<td> 1.9.x </td>
</tr>
<tr class="b">
<td> mail.smtp.starttls.enable </td>
<td> 0 </td>
<td> Enable TLS 1=true, 0=false </td>
<td> 1.9.x </td>
</tr>
<tr class="a">
<td> mail.smtp.connection.timeout </td>
<td> 30000 </td>
<td> Socket connection timeout value in milliseconds. Default is 30 seconds (30000). </td>
<td> 1.9.x </td>
</tr>
<tr class="b">
<td> mail.smtp.timeout </td>
<td> 30000 </td>
<td> Socket I/O timeout value in milliseconds. Default is 30 seconds (30000). </td>
<td> 1.9.x </td>
</tr>
<tr class="a">
<td> system_email_addr </td>
<td> noreply@openmeetings.apache.org </td>
<td> all send e-mails by the system will have this address </td>
<td> 1.9.x </td>
</tr>
<tr class="b">
<td> inviter.email.as.replyto </td>
<td> 1 </td>
<td> Set inviter's email address as ReplyTo in email invitations (1 == set, 0 == NOT set) </td>
<td> 2.0.x </td>
</tr>
<tr class="a">
<td> office.path </td>
<td> </td>
<td> The path to OpenOffice/LibreOffice (optional) please set this to the real path in case jodconverter is unable to find OpenOffice/LibreOffice installation automatically </td>
<td> 2.0.x </td>
</tr>
<tr class="b">
<td> default.landing.zone </td>
<td> user/dashboard </td>
<td> Area to be shown to the user after login. Possible values are: user/dashboard, user/calendar, user/record, rooms/my, rooms/group, rooms/public, admin/user, admin/connection
, admin/group, admin/room, admin/config, admin/lang, admin/ldap, admin/backup, admin/server, admin/oauth2 </td>
<td> 2.1.x, <b> values are changed in 3.0.0</b> </td>
</tr>
<tr class="a">
<td> sms.provider </td>
<td> </td>
<td> SMS service provider (bulksms.http.1) </td>
<td> 2.1.x </td>
</tr>
<tr class="b">
<td> sms.Username </td>
<td> </td>
<td> Login for SMS service provider </td>
<td> 2.1.x </td>
</tr>
<tr class="a">
<td> sms.Userpass </td>
<td> </td>
<td> Password for SMS service provider </td>
<td> 2.1.x </td>
</tr>
<tr class="b">
<td> sms.subject </td>
<td> </td>
<td> Subject of SMS reminder message </td>
<td> 2.1.x </td>
</tr>
<tr class="a">
<td> swftools_zoom </td>
<td> 100 </td>
<td> DPI for conversion of PDF to SWF (should be an integer between 50 and 600 with a default value of 100 DPI) </td>
<td> 2.0.x </td>
</tr>
<tr class="b">
<td> swftools_jpegquality </td>
<td> 85 </td>
<td> Compression quality for conversion of PDF to SWF (should be an integer between 1 and 100, with a default value of 85) </td>
<td> 2.0.x </td>
</tr>
<tr class="a">
<td> sendEmailAtRegister </td>
<td> 0 </td>
<td> User get a EMail with their Account data. Values: 0(No) or 1(Yes) </td>
<td> 2.0.x </td>
</tr>
<tr class="b">
<td> sendEmailWithVerficationCode </td>
<td> 0 </td>
<td> User must activate their account by clicking on the
activation-link in the registering Email. Values: 0(No) or 1(Yes)
It makes no sense to make this(sendEmailWithVerficationCode) 1(Yes) while
sendEmailAtRegister is 0(No) cause you need
to send a EMail. </td>
<td> 2.0.x </td>
</tr>
<tr class="a">
<td> redirect.url.for.external.users </td>
<td> </td>
<td> Users entered the room via invitationHash or secureHash will be redirected to this URL on connection lost </td>
<td> 2.2.x </td>
</tr>
<tr class="b">
<td> allow_frontend_register </td>
<td> (configurable during install) </td>
<td> Is user register available on login screen </td>
<td> 1.8.x </td>
</tr>
<tr class="a">
<td> allow.soap.register </td>
<td> 1 </td>
<td> Is user register available via SOAP/REST </td>
<td> 3.0.x </td>
</tr>
<tr class="b">
<td> allow.oauth.register </td>
<td> 1 </td>
<td> Is user register available via OAuth </td>
<td> 3.0.x </td>
</tr>
<tr class="a">
<td> application.base.url </td>
<td> http://localhost:5080/openmeetings </td>
<td> Base URL your OPenmeetings installation will be accessible at. </td>
<td> 3.0.2 </td>
</tr>
<tr class="b">
<td> default.quality.screensharing </td>
<td> 1 </td>
<td> Default selection in ScreenSharing Quality:<br />
0 - bigger frame rate, no resize<br />
1 - no resize<br />
2 - size == 1/2 of selected area<br />
3 - size == 3/8 of selected area </td>
<td> 3.0.3 </td>
</tr>
<tr class="a">
<td> default.fps.screensharing </td>
<td> 10 </td>
<td> Default selection in ScreenSharing FPS. </td>
<td> 3.0.3 </td>
</tr>
<tr class="b">
<td> screensharing.fps.show </td>
<td> true </td>
<td> Is screensharing FPS should be displayed or not (true/false). </td>
<td> 3.0.3 </td>
</tr>
<tr class="a">
<td> screensharing.allow.remote </td>
<td> true </td>
<td> Is remote control will be enabled while screensharing. Allowing remote control will be not possible in case it is set to 'false' (true/false). </td>
<td> 3.0.4 </td>
</tr>
<tr class="b">
<td> calendar.firstday </td>
<td> 0 </td>
<td> The day that each week begins. The value must be a number that represents the day of the week. Sunday=0, Monday=1, Tuesday=2, etc. </td>
<td> 3.0.4 </td>
</tr>
<tr class="a">
<td> google.analytics.code </td>
<td> </td>
<td> Code for Google Analytics. </td>
<td> 3.1.0 </td>
</tr>
</table>
</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>