http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/CustomCryptMechanism.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/CustomCryptMechanism.xml b/openmeetings-server/src/site/xdoc/CustomCryptMechanism.xml index 8bef094..fcf97ef 100644 --- a/openmeetings-server/src/site/xdoc/CustomCryptMechanism.xml +++ b/openmeetings-server/src/site/xdoc/CustomCryptMechanism.xml @@ -1,103 +1,103 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> -<document xmlns="http://maven.apache.org/XDOC/2.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> - <properties> - <title>Howto create a Custom Crypt styles</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - <body> - <section name="Configuration of Custom Crypt-Style"> - <p> - You can use custom Crypt-Types, but you should decide during - installation which Type of encryption you want to use. By default - two type are available: - </p> - - <ul> - <li>org.apache.openmeetings.util.crypt.MD5Implementation - this uses common MD5 - Crypt like PHP does, this is the default one (results in something - like: fe01ce2a7fbac8fafaed7c982a04e229)</li> - <li>org.apache.openmeetings.util.crypt.MD5CryptImplementation - does use - BSD-Style of encryption using a salt (results in something like: - $1$GMsj7F2I$5S3r9CeukXGXNwf6b4sph1)</li> - </ul> - <p> - You can edit the config-key during Installation or later in the - Administration Panel. But if you change it using the - Administration-Panel previous passwords might be not working anymore - as they are encrypted with another algorithm. - </p> - </section> - <section name="Configuration of Custom Crypt-Style"> - <p> - To add your own crypt style you need to write a class which - implements the interface: org.apache.openmeetings.util.crypt.ICrypt - <br /> - Example of an Implementation: - </p> - <source> -<![CDATA[ -package org.apache.openmeetings.util.crypt; - -import static org.apache.openmeetings.util.OpenmeetingsVariables.webAppRootKey; - -import java.security.NoSuchAlgorithmException; - -import org.red5.logging.Red5LoggerFactory; -import org.slf4j.Logger; - -public class MD5Implementation implements ICrypt { - private static final Logger log = Red5LoggerFactory.getLogger(MD5Implementation.class, webAppRootKey); - - /* - * (non-Javadoc) - * @see org.apache.openmeetings.utils.crypt.ICrypt#hash(java.lang.String) - */ - @Override - public String hash(String str) { - String passPhrase = null; - try { - passPhrase = MD5.checksum(str); - } catch (NoSuchAlgorithmException e) { - log.error("Error", e); - } - return passPhrase; - } - - /* - * (non-Javadoc) - * @see org.apache.openmeetings.utils.crypt.ICrypt#verify(java.lang.String, java.lang.String) - */ - @Override - public boolean verify(String str, String hash) { - return hash != null && hash.equals(hash(str)); - } -} -]]> - </source> - <p>To add your own Encryption-Class you need to add your class to the - OpenMeetings-Webapp (make it available to the webapp-classpath) and - use your custom-class-name instead of - org.apache.openmeetings.util.crypt.MD5Implementation during the Installation or - at runtime by editing the config-key crypt_ClassName</p> - </section> - <section name="Configuration of Custom Crypt-Style"> - <p>credits goto Mika for sharing his Implementation of the - MD5Crypt-Style</p> - </section> - </body> -</document> +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> + <properties> + <title>Howto create a Custom Crypt styles</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + <body> + <section name="Configuration of Custom Crypt-Style"> + <p> + You can use custom Crypt-Types, but you should decide during + installation which Type of encryption you want to use. By default + two type are available: + </p> + + <ul> + <li>org.apache.openmeetings.util.crypt.MD5Implementation - this uses common MD5 + Crypt like PHP does, this is the default one (results in something + like: fe01ce2a7fbac8fafaed7c982a04e229)</li> + <li>org.apache.openmeetings.util.crypt.MD5CryptImplementation - does use + BSD-Style of encryption using a salt (results in something like: + $1$GMsj7F2I$5S3r9CeukXGXNwf6b4sph1)</li> + </ul> + <p> + You can edit the config-key during Installation or later in the + Administration Panel. But if you change it using the + Administration-Panel previous passwords might be not working anymore + as they are encrypted with another algorithm. + </p> + </section> + <section name="Configuration of Custom Crypt-Style"> + <p> + To add your own crypt style you need to write a class which + implements the interface: org.apache.openmeetings.util.crypt.ICrypt + <br /> + Example of an Implementation: + </p> + <source> +<![CDATA[ +package org.apache.openmeetings.util.crypt; + +import static org.apache.openmeetings.util.OpenmeetingsVariables.webAppRootKey; + +import java.security.NoSuchAlgorithmException; + +import org.red5.logging.Red5LoggerFactory; +import org.slf4j.Logger; + +public class MD5Implementation implements ICrypt { + private static final Logger log = Red5LoggerFactory.getLogger(MD5Implementation.class, webAppRootKey); + + /* + * (non-Javadoc) + * @see org.apache.openmeetings.utils.crypt.ICrypt#hash(java.lang.String) + */ + @Override + public String hash(String str) { + String passPhrase = null; + try { + passPhrase = MD5.checksum(str); + } catch (NoSuchAlgorithmException e) { + log.error("Error", e); + } + return passPhrase; + } + + /* + * (non-Javadoc) + * @see org.apache.openmeetings.utils.crypt.ICrypt#verify(java.lang.String, java.lang.String) + */ + @Override + public boolean verify(String str, String hash) { + return hash != null && hash.equals(hash(str)); + } +} +]]> + </source> + <p>To add your own Encryption-Class you need to add your class to the + OpenMeetings-Webapp (make it available to the webapp-classpath) and + use your custom-class-name instead of + org.apache.openmeetings.util.crypt.MD5Implementation during the Installation or + at runtime by editing the config-key crypt_ClassName</p> + </section> + <section name="Configuration of Custom Crypt-Style"> + <p>credits goto Mika for sharing his Implementation of the + MD5Crypt-Style</p> + </section> + </body> +</document>
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/CustomRoomTypeHowTo.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/CustomRoomTypeHowTo.xml b/openmeetings-server/src/site/xdoc/CustomRoomTypeHowTo.xml index 88a2fe6..579e423 100644 --- a/openmeetings-server/src/site/xdoc/CustomRoomTypeHowTo.xml +++ b/openmeetings-server/src/site/xdoc/CustomRoomTypeHowTo.xml @@ -1,104 +1,104 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> -<document xmlns="http://maven.apache.org/XDOC/2.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> - - <properties> - <title>Howto create a custom room type in OpenMeetings</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - - <section name="Why creating a custom room type in OpenMeetings"> - - <p>If you want to create your own styled room the best thing to do in - order to be "update-save" is to create your own custom room type. There is an empty configuration - by default shipped with every release of OpenMeetings, the room type "custom" (ID = 5).<br/> - <br/> - You can use that and extend it, or you can add more room types to fit your use case. - </p> - <p></p> - </section> - - <section name="Create your own room type class (User Interface)"> - - <p>Lets start by creating your custom room type class. - <br/> - You could for example duplicate an existing room class, from <br/> - <tt>src/modules/conference/flexibleConferenceRoom</tt> folder, for example the - flexibleConferenceRoom.lzx: Generate a duplicate, change the name, for example to - myCustomConferenceRoom.lzx and edit the class name inside the file name="flexibleConferenceRoom" to - name="myCustomConferenceRoom". Also don't miss to add an entry to library.lzx so that the compiler - will find your new class. - </p> - - </section> - - <section name="Create nesseccary entries in configuration tables"> - - <p>You first need to create a number of configuration files </p> - <ul> - <li>To have your roomtype available everytime you install OpenMeetings you need to add - it to the default rooms: <tt>ImportInitvalues.java Method: loadDefaultRooms()</tt>. Add your entry here. - You can choose any random name for the room. The ID is the important trigger for the room type - to identify later. You need to run the installer so that your new room type is in the database.</li> - - <li>Add your room type in the default module configuration: - <tt>src/base/moduleConfiguration.lzx</tt>, - here you need to add a default class name for your room type </li> - - <li>Add your room type in the real configuration: public/config.xml, add a new entry. - <br/> - You should fix also the file <tt>public/config.xsd</tt> that is the Schema file for the public/config.xml. - </li> - - <li>Add a parser entry to modify the room type mapping: - <tt>base/mainMethods.lzx method: myinit</tt>. You - can see some example parsing, you should add your one similar to the existing room types.</li> - - </ul> - - </section> - - <section name="Link your room type config with your room type class "> - - <p>Now you need to make sure that everytime the conference room is created - your new class "myCustomConferenceRoom" is used. There are 3 places you need to add your mapping.</p> - - <ul> - <li>In the global mapping: - <tt>base/mainMethods.lzx method name="setRoomValues"</tt> - </li> - <li>In file: - <tt>modules/conference/conference/roomListItem.lzx method name="initRoom"</tt> - </li> - <li>In file: - <tt>modules/invitation/autoloaderBarOnly.lzx netRemoteCallHib name="setUsernameAndSession"</tt> - </li> - </ul> - - <p>Thats it. You can add/edit/delete your room with the new room type in the Administration > Rooms interface of - OpenMeetings like any other room.</p> - <p>If you need to have this room type available as option in the Calendar UI, you need to add it to the combobox manually.</p> - - </section> - - - - </body> - +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> + + <properties> + <title>Howto create a custom room type in OpenMeetings</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + + <section name="Why creating a custom room type in OpenMeetings"> + + <p>If you want to create your own styled room the best thing to do in + order to be "update-save" is to create your own custom room type. There is an empty configuration + by default shipped with every release of OpenMeetings, the room type "custom" (ID = 5).<br/> + <br/> + You can use that and extend it, or you can add more room types to fit your use case. + </p> + <p></p> + </section> + + <section name="Create your own room type class (User Interface)"> + + <p>Lets start by creating your custom room type class. + <br/> + You could for example duplicate an existing room class, from <br/> + <tt>src/modules/conference/flexibleConferenceRoom</tt> folder, for example the + flexibleConferenceRoom.lzx: Generate a duplicate, change the name, for example to + myCustomConferenceRoom.lzx and edit the class name inside the file name="flexibleConferenceRoom" to + name="myCustomConferenceRoom". Also don't miss to add an entry to library.lzx so that the compiler + will find your new class. + </p> + + </section> + + <section name="Create nesseccary entries in configuration tables"> + + <p>You first need to create a number of configuration files </p> + <ul> + <li>To have your roomtype available everytime you install OpenMeetings you need to add + it to the default rooms: <tt>ImportInitvalues.java Method: loadDefaultRooms()</tt>. Add your entry here. + You can choose any random name for the room. The ID is the important trigger for the room type + to identify later. You need to run the installer so that your new room type is in the database.</li> + + <li>Add your room type in the default module configuration: + <tt>src/base/moduleConfiguration.lzx</tt>, + here you need to add a default class name for your room type </li> + + <li>Add your room type in the real configuration: public/config.xml, add a new entry. + <br/> + You should fix also the file <tt>public/config.xsd</tt> that is the Schema file for the public/config.xml. + </li> + + <li>Add a parser entry to modify the room type mapping: + <tt>base/mainMethods.lzx method: myinit</tt>. You + can see some example parsing, you should add your one similar to the existing room types.</li> + + </ul> + + </section> + + <section name="Link your room type config with your room type class "> + + <p>Now you need to make sure that everytime the conference room is created + your new class "myCustomConferenceRoom" is used. There are 3 places you need to add your mapping.</p> + + <ul> + <li>In the global mapping: + <tt>base/mainMethods.lzx method name="setRoomValues"</tt> + </li> + <li>In file: + <tt>modules/conference/conference/roomListItem.lzx method name="initRoom"</tt> + </li> + <li>In file: + <tt>modules/invitation/autoloaderBarOnly.lzx netRemoteCallHib name="setUsernameAndSession"</tt> + </li> + </ul> + + <p>Thats it. You can add/edit/delete your room with the new room type in the Administration > Rooms interface of + OpenMeetings like any other room.</p> + <p>If you need to have this room type available as option in the Calendar UI, you need to add it to the combobox manually.</p> + + </section> + + + + </body> + </document> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/Dashboard.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/Dashboard.xml b/openmeetings-server/src/site/xdoc/Dashboard.xml index a67504f..7c43c94 100644 --- a/openmeetings-server/src/site/xdoc/Dashboard.xml +++ b/openmeetings-server/src/site/xdoc/Dashboard.xml @@ -1,70 +1,70 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> -<document xmlns="http://maven.apache.org/XDOC/2.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> - - <properties> - <title>Changing Dashboard</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - - <section name="Changing Dashboard"> - - <p>You can configure the tabs that are visible by default at bottom - of the dashboard. To edit the settings, login as admin and goto - Administration > Configuration </p> - <p></p> - <table> - <tr> - <th> Config-key </th> - <th> Values </th> - <th> Meaning </th> - </tr> - <tr> - <td> dashboard.show.myrooms </td> - <td> 0 or 1 </td> - <td> If the MyRooms tab should be visible or not </td> - </tr> - <tr> - <td> dashboard.show.chat </td> - <td> 0 or 1 </td> - <td> If the Chat tab should be visible or not </td> - </tr> - <tr> - <td> dashboard.show.rssfeed </td> - <td> 0 or 1 </td> - <td> If the RSS-Feed tab should be visible or not </td> - </tr> - <tr> - <td> rss_feed1 </td> - <td> http-URL </td> - <td> ATOM-Feed URL for the dashboard RSS Tab </td> - </tr> - <tr> - <td> rss_feed2 </td> - <td> http-URL </td> - <td> ATOM-Feed URL for the dashboard RSS Tab </td> - </tr> - </table> - <p></p> - <p>Changes are immediately online, no need to restart anything. </p> - </section> - - </body> - +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> + + <properties> + <title>Changing Dashboard</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + + <section name="Changing Dashboard"> + + <p>You can configure the tabs that are visible by default at bottom + of the dashboard. To edit the settings, login as admin and goto + Administration > Configuration </p> + <p></p> + <table> + <tr> + <th> Config-key </th> + <th> Values </th> + <th> Meaning </th> + </tr> + <tr> + <td> dashboard.show.myrooms </td> + <td> 0 or 1 </td> + <td> If the MyRooms tab should be visible or not </td> + </tr> + <tr> + <td> dashboard.show.chat </td> + <td> 0 or 1 </td> + <td> If the Chat tab should be visible or not </td> + </tr> + <tr> + <td> dashboard.show.rssfeed </td> + <td> 0 or 1 </td> + <td> If the RSS-Feed tab should be visible or not </td> + </tr> + <tr> + <td> rss_feed1 </td> + <td> http-URL </td> + <td> ATOM-Feed URL for the dashboard RSS Tab </td> + </tr> + <tr> + <td> rss_feed2 </td> + <td> http-URL </td> + <td> ATOM-Feed URL for the dashboard RSS Tab </td> + </tr> + </table> + <p></p> + <p>Changes are immediately online, no need to restart anything. </p> + </section> + + </body> + </document> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/DrupalPlugin.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/DrupalPlugin.xml b/openmeetings-server/src/site/xdoc/DrupalPlugin.xml index 0fe7f2e..6b6e0ac 100644 --- a/openmeetings-server/src/site/xdoc/DrupalPlugin.xml +++ b/openmeetings-server/src/site/xdoc/DrupalPlugin.xml @@ -1,76 +1,76 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> -<document xmlns="http://maven.apache.org/XDOC/2.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> - - <properties> - <title>Drupal Plugin</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - - <section name="Drupal Plugin for OpenMeetings"> - <p> - Plugin for Drupal currently is not open source. - Please contact <a href="commercial-support.html" target="_blank" rel="nofollow">Commercial Support</a> to get it. - </p> - </section> - - <section name="Installation of the Drupal Plugin for Apache OpenMeetings"> - <p> - You simply download the ZIP or TAR package and unzip it to Drupal "mod" directory. - <br/> - For a detailed description on how to install plugins in Drupal please review their - <a href="http://drupal.org/documentation/install/modules-themes"; target="_blank" rel="nofollow">handbook</a>. - <br /> - Then you visit the module interface of Drupal, where you will find the new module. - You should switch it to "enabled" to get the "Configure" and "Permissions" buttons. - </p> - <a class="fancybox-buttons" href="images/drupal_module_installation.png"> - <img src="images/drupal_module_installation.png" alt="" width="600" - height="150" /> - </a> - <p> - In the configuration you enter the auth data to access your Apache OpenMeetings server: - </p> - <a class="fancybox-buttons" href="images/drupal_module_configuration.png"> - <img src="images/drupal_module_configuration.png" alt="" width="600" - height="340" /> - </a> - </section> - - <section name="Adding a new conference room to Drupal"> - - <p> - After installation of the plugin you can go to the front page in Drupal and add a new content item - "OpenMeetings Rooms" => "Add New Room". You may find following configuration values for each - conference room: - </p> - <a class="fancybox-buttons" href="images/drupal_room_configuration.png"> - <img src="images/drupal_room_configuration.png" alt="" width="600" - height="400" /> - </a> - </section> - - <section name="Demo video"> - <p>The demo video of Drupal plugin show you the plugin in action </p> - <iframe width="640" height="390" src="http://www.youtube.com/embed/LmMIKFCLRV4"; frameborder="0" allowfullscreen=""></iframe> - <iframe width="640" height="390" src="http://www.youtube.com/embed/k5PF3vdVUn0"; frameborder="0" allowfullscreen=""></iframe> - </section> - </body> - +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> + + <properties> + <title>Drupal Plugin</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + + <section name="Drupal Plugin for OpenMeetings"> + <p> + Plugin for Drupal currently is not open source. + Please contact <a href="commercial-support.html" target="_blank" rel="nofollow">Commercial Support</a> to get it. + </p> + </section> + + <section name="Installation of the Drupal Plugin for Apache OpenMeetings"> + <p> + You simply download the ZIP or TAR package and unzip it to Drupal "mod" directory. + <br/> + For a detailed description on how to install plugins in Drupal please review their + <a href="http://drupal.org/documentation/install/modules-themes"; target="_blank" rel="nofollow">handbook</a>. + <br /> + Then you visit the module interface of Drupal, where you will find the new module. + You should switch it to "enabled" to get the "Configure" and "Permissions" buttons. + </p> + <a class="fancybox-buttons" href="images/drupal_module_installation.png"> + <img src="images/drupal_module_installation.png" alt="" width="600" + height="150" /> + </a> + <p> + In the configuration you enter the auth data to access your Apache OpenMeetings server: + </p> + <a class="fancybox-buttons" href="images/drupal_module_configuration.png"> + <img src="images/drupal_module_configuration.png" alt="" width="600" + height="340" /> + </a> + </section> + + <section name="Adding a new conference room to Drupal"> + + <p> + After installation of the plugin you can go to the front page in Drupal and add a new content item + "OpenMeetings Rooms" => "Add New Room". You may find following configuration values for each + conference room: + </p> + <a class="fancybox-buttons" href="images/drupal_room_configuration.png"> + <img src="images/drupal_room_configuration.png" alt="" width="600" + height="400" /> + </a> + </section> + + <section name="Demo video"> + <p>The demo video of Drupal plugin show you the plugin in action </p> + <iframe width="640" height="390" src="http://www.youtube.com/embed/LmMIKFCLRV4"; frameborder="0" allowfullscreen=""></iframe> + <iframe width="640" height="390" src="http://www.youtube.com/embed/k5PF3vdVUn0"; frameborder="0" allowfullscreen=""></iframe> + </section> + </body> + </document> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/EditTemplates.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/EditTemplates.xml b/openmeetings-server/src/site/xdoc/EditTemplates.xml index acc5e1c..0846c24 100644 --- a/openmeetings-server/src/site/xdoc/EditTemplates.xml +++ b/openmeetings-server/src/site/xdoc/EditTemplates.xml @@ -1,64 +1,64 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> -<document xmlns="http://maven.apache.org/XDOC/2.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> - - <properties> - <title>Edit Templates</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - <section name="Changing Labels and text strings"> - <p> - All language string should be localized and stored in the language - section. You have a full featured language editor with every - installation of OpenMeetings, check out the - <a href="LanguageEditor.html">LanguageEditor</a> - . - </p> - <p> - To lookup the labelids in the GUI you can simply run OpenMeetings - client with the debug enabled. That way every text-string has the - labelid in brackets additionally in the textfield. To start the - client in debug mode please check "Tips and Tricks" section of - <a href="installation.html" rel="nofollow">Installation guide</a> - </p> - </section> - <section name="Changing layout, adding footers in emails"> - <p>If you would like to change the standard email layout or add for - example some footer in every email you have to change the email - templates. - </p> - <div>To do that: - <ul> - <li>Stop the Red5/OpenMeetings service</li> - <li>Goto: <tt>$RED5_HOME/webapps/openmeetings/WEB-INF/classes/org/apache/openmeetings/service/mail/template/</tt></li> - <li>Change HTML file(s) according to your needs, BUT do not remove - elements with <tt>wicket:id</tt> attributes! You can hide those - elements by adding <tt>wicket:visible="false"</tt> attribute - </li> - <li>Starting OM 3.1.4 you can change Appointment reminder subject by - modifying "subject" fragment in file - <tt>$RED5_HOME/webapps/openmeetings/WEB-INF/classes/org/apache/openmeetings/service/mail/template/subject/AbstractSubjectEmailTemplate.html</tt> - as described in previous bullet. - </li> - <li>Start the Red5/OpenMeetings service</li> - </ul> - </div> - </section> - </body> -</document> +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> + + <properties> + <title>Edit Templates</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + <section name="Changing Labels and text strings"> + <p> + All language string should be localized and stored in the language + section. You have a full featured language editor with every + installation of OpenMeetings, check out the + <a href="LanguageEditor.html">LanguageEditor</a> + . + </p> + <p> + To lookup the labelids in the GUI you can simply run OpenMeetings + client with the debug enabled. That way every text-string has the + labelid in brackets additionally in the textfield. To start the + client in debug mode please check "Tips and Tricks" section of + <a href="installation.html" rel="nofollow">Installation guide</a> + </p> + </section> + <section name="Changing layout, adding footers in emails"> + <p>If you would like to change the standard email layout or add for + example some footer in every email you have to change the email + templates. + </p> + <div>To do that: + <ul> + <li>Stop the Red5/OpenMeetings service</li> + <li>Goto: <tt>$RED5_HOME/webapps/openmeetings/WEB-INF/classes/org/apache/openmeetings/service/mail/template/</tt></li> + <li>Change HTML file(s) according to your needs, BUT do not remove + elements with <tt>wicket:id</tt> attributes! You can hide those + elements by adding <tt>wicket:visible="false"</tt> attribute + </li> + <li>Starting OM 3.1.4 you can change Appointment reminder subject by + modifying "subject" fragment in file + <tt>$RED5_HOME/webapps/openmeetings/WEB-INF/classes/org/apache/openmeetings/service/mail/template/subject/AbstractSubjectEmailTemplate.html</tt> + as described in previous bullet. + </li> + <li>Start the Red5/OpenMeetings service</li> + </ul> + </div> + </section> + </body> +</document> http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/GeneralConfiguration.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/GeneralConfiguration.xml b/openmeetings-server/src/site/xdoc/GeneralConfiguration.xml index 403e4b7..750724b 100644 --- a/openmeetings-server/src/site/xdoc/GeneralConfiguration.xml +++ b/openmeetings-server/src/site/xdoc/GeneralConfiguration.xml @@ -1,313 +1,313 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> -<document xmlns="http://maven.apache.org/XDOC/2.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> - <properties> - <title>List of general configuration options</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - <body> - <section name="List of general configuration options"> - <p>In Administration > Configuration there are a number of - configuration values. - </p> - <p></p> - <table> - <tr> - <th> key </th> - <th> default </th> - <th> meaning </th> - <th> availabe since OpenMeetings version </th> - </tr> - <tr> - <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> - <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> - <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> - <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> - <td> rss_feed2 </td> - <td> http-URL </td> - <td> Dashboard: ATOM-Feed URL for the dashboard RSS Tab </td> - <td> 1.9.x </td> - </tr> - <tr> - <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> - <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> - <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> - <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> - <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> - <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> - <td> smtp_server </td> - <td> localhost </td> - <td> this is the smtp server to send messages </td> - <td> 1.9.x </td> - </tr> - <tr> - <td> smtp_port </td> - <td> 25 </td> - <td> this is the smtp server port normally 25 </td> - <td> 1.9.x </td> - </tr> - <tr> - <td> email_username </td> - <td> </td> - <td> System auth email username </td> - <td> 1.9.x </td> - </tr> - <tr> - <td> email_userpass </td> - <td> </td> - <td> System auth email password </td> - <td> 1.9.x </td> - </tr> - <tr> - <td> mail.smtp.starttls.enable </td> - <td> 0 </td> - <td> Enable TLS 1=true, 0=false </td> - <td> 1.9.x </td> - </tr> - <tr> - <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> - <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> - <td> system_email_addr </td> - <td> [email protected] </td> - <td> all send e-mails by the system will have this address </td> - <td> 1.9.x </td> - </tr> - <tr> - <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> - <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> - <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> - <td> sms.provider </td> - <td> </td> - <td> SMS service provider (bulksms.http.1) </td> - <td> 2.1.x </td> - </tr> - <tr> - <td> sms.Username </td> - <td> </td> - <td> Login for SMS service provider </td> - <td> 2.1.x </td> - </tr> - <tr> - <td> sms.Userpass </td> - <td> </td> - <td> Password for SMS service provider </td> - <td> 2.1.x </td> - </tr> - <tr> - <td> sms.subject </td> - <td> </td> - <td> Subject of SMS reminder message </td> - <td> 2.1.x </td> - </tr> - <tr> - <td> document.dpi </td> - <td> 150 </td> - <td> DPI for conversion of PDF to images (should be an integer between 50 and 600 with a default value of 150 DPI) </td> - <td> 4.0.x </td> - </tr> - <tr> - <td> document.quality </td> - <td> 90 </td> - <td> Compression quality for conversion of PDF to images (should be an integer between 1 and 100, with a default value of 90) </td> - <td> 4.0.x </td> - </tr> - <tr> - <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> - <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> - <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> - <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> - <td> allow.soap.register </td> - <td> 1 </td> - <td> Is user register available via SOAP/REST </td> - <td> 3.0.x </td> - </tr> - <tr> - <td> allow.oauth.register </td> - <td> 1 </td> - <td> Is user register available via OAuth </td> - <td> 3.0.x </td> - </tr> - <tr> - <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> - <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> - <td> default.fps.screensharing </td> - <td> 10 </td> - <td> Default selection in ScreenSharing FPS. </td> - <td> 3.0.3 </td> - </tr> - <tr> - <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> - <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> - <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> - <td> google.analytics.code </td> - <td> </td> - <td> Code for Google Analytics. </td> - <td> 3.1.0 </td> - </tr> - <tr> - <td> header.x.frame.options </td> - <td> SAMEORIGIN </td> - <td> Value for 'X-Frame-Options' header, more info: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options </td> - <td> 3.3.0 </td> - </tr> - <tr> - <td> header.content.security.policy </td> - <td> default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; </td> - <td> Value for 'Content-Security-Policy' header, have to be modified to enable Google analytics site: https://content-security-policy.com/ </td> - <td> 3.3.0 </td> - </tr> - </table> - </section> - </body> -</document> +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> + <properties> + <title>List of general configuration options</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + <body> + <section name="List of general configuration options"> + <p>In Administration > Configuration there are a number of + configuration values. + </p> + <p></p> + <table> + <tr> + <th> key </th> + <th> default </th> + <th> meaning </th> + <th> availabe since OpenMeetings version </th> + </tr> + <tr> + <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> + <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> + <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> + <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> + <td> rss_feed2 </td> + <td> http-URL </td> + <td> Dashboard: ATOM-Feed URL for the dashboard RSS Tab </td> + <td> 1.9.x </td> + </tr> + <tr> + <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> + <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> + <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> + <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> + <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> + <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> + <td> smtp_server </td> + <td> localhost </td> + <td> this is the smtp server to send messages </td> + <td> 1.9.x </td> + </tr> + <tr> + <td> smtp_port </td> + <td> 25 </td> + <td> this is the smtp server port normally 25 </td> + <td> 1.9.x </td> + </tr> + <tr> + <td> email_username </td> + <td> </td> + <td> System auth email username </td> + <td> 1.9.x </td> + </tr> + <tr> + <td> email_userpass </td> + <td> </td> + <td> System auth email password </td> + <td> 1.9.x </td> + </tr> + <tr> + <td> mail.smtp.starttls.enable </td> + <td> 0 </td> + <td> Enable TLS 1=true, 0=false </td> + <td> 1.9.x </td> + </tr> + <tr> + <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> + <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> + <td> system_email_addr </td> + <td> [email protected] </td> + <td> all send e-mails by the system will have this address </td> + <td> 1.9.x </td> + </tr> + <tr> + <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> + <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> + <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> + <td> sms.provider </td> + <td> </td> + <td> SMS service provider (bulksms.http.1) </td> + <td> 2.1.x </td> + </tr> + <tr> + <td> sms.Username </td> + <td> </td> + <td> Login for SMS service provider </td> + <td> 2.1.x </td> + </tr> + <tr> + <td> sms.Userpass </td> + <td> </td> + <td> Password for SMS service provider </td> + <td> 2.1.x </td> + </tr> + <tr> + <td> sms.subject </td> + <td> </td> + <td> Subject of SMS reminder message </td> + <td> 2.1.x </td> + </tr> + <tr> + <td> document.dpi </td> + <td> 150 </td> + <td> DPI for conversion of PDF to images (should be an integer between 50 and 600 with a default value of 150 DPI) </td> + <td> 4.0.x </td> + </tr> + <tr> + <td> document.quality </td> + <td> 90 </td> + <td> Compression quality for conversion of PDF to images (should be an integer between 1 and 100, with a default value of 90) </td> + <td> 4.0.x </td> + </tr> + <tr> + <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> + <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> + <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> + <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> + <td> allow.soap.register </td> + <td> 1 </td> + <td> Is user register available via SOAP/REST </td> + <td> 3.0.x </td> + </tr> + <tr> + <td> allow.oauth.register </td> + <td> 1 </td> + <td> Is user register available via OAuth </td> + <td> 3.0.x </td> + </tr> + <tr> + <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> + <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> + <td> default.fps.screensharing </td> + <td> 10 </td> + <td> Default selection in ScreenSharing FPS. </td> + <td> 3.0.3 </td> + </tr> + <tr> + <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> + <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> + <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> + <td> google.analytics.code </td> + <td> </td> + <td> Code for Google Analytics. </td> + <td> 3.1.0 </td> + </tr> + <tr> + <td> header.x.frame.options </td> + <td> SAMEORIGIN </td> + <td> Value for 'X-Frame-Options' header, more info: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options </td> + <td> 3.3.0 </td> + </tr> + <tr> + <td> header.content.security.policy </td> + <td> default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; </td> + <td> Value for 'Content-Security-Policy' header, have to be modified to enable Google analytics site: https://content-security-policy.com/ </td> + <td> 3.3.0 </td> + </tr> + </table> + </section> + </body> +</document> http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/GetVersionInfo.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/GetVersionInfo.xml b/openmeetings-server/src/site/xdoc/GetVersionInfo.xml index 3d9cf3e..20db886 100644 --- a/openmeetings-server/src/site/xdoc/GetVersionInfo.xml +++ b/openmeetings-server/src/site/xdoc/GetVersionInfo.xml @@ -1,73 +1,73 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> -<document xmlns="http://maven.apache.org/XDOC/2.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> - - <properties> - <title>How to check which Openmeetings version running</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - <section name="How to check which Openmeetings version running (3.0.0 - )"> - <p>Use Top Menu -> About</p> - </section> - <section name="How to check which Openmeetings version running (2.1.1 - )"> - <p>The version is printed into openmeetings.log file</p> - <p> - Run openmeetings<br/> - Open OM_HOME/log/openmeetings.log - </p> - <p>You get something like this: </p> - <source> - ################################################################################ - # Openmeetings is up # - # 4.0.0-SNAPSHOT 943f172e9d63c3ab7210f895fdede1ad7fa6aebc 2017/05/01 05:56 # - # and ready to use # - ################################################################################ - </source> - </section> - <section name="How to check which Openmeetings version running (1.8.0 - 2.1.0)"> - <p>If you need to know what version of OpenMeetings you are running, - you can check that by the file: openmeetings-*.jar - </p> - <p> - Unzip: /webapps/openmeetings/WEB-INF/lib/openmeetings-*.jar (jars are - zips) - <br /> - <br /> - In the resulting unzipped folder open the file to read: - /META-INF/MANIFEST.MF - </p> - <p>You get something like this: </p> - <source> -<![CDATA[ -Manifest-Version: 1.0 -Built-By: OpenMeetings - http://openmeetings.apache.org -Built-On: 2017/05/01 05:41 -Git-Revision: 943f172e9d63c3ab7210f895fdede1ad7fa6aebc -]]> - </source> - <p>This version info is available since version 1.8.0. If you have an - older version as version 1.8.0 then you might simply check the - language files and the labelid in there, the numbers of labels are - almost always unique in the versions. </p> - - </section> - - </body> - +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> + + <properties> + <title>How to check which Openmeetings version running</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + <section name="How to check which Openmeetings version running (3.0.0 - )"> + <p>Use Top Menu -> About</p> + </section> + <section name="How to check which Openmeetings version running (2.1.1 - )"> + <p>The version is printed into openmeetings.log file</p> + <p> + Run openmeetings<br/> + Open OM_HOME/log/openmeetings.log + </p> + <p>You get something like this: </p> + <source> + ################################################################################ + # Openmeetings is up # + # 4.0.0-SNAPSHOT 943f172e9d63c3ab7210f895fdede1ad7fa6aebc 2017/05/01 05:56 # + # and ready to use # + ################################################################################ + </source> + </section> + <section name="How to check which Openmeetings version running (1.8.0 - 2.1.0)"> + <p>If you need to know what version of OpenMeetings you are running, + you can check that by the file: openmeetings-*.jar + </p> + <p> + Unzip: /webapps/openmeetings/WEB-INF/lib/openmeetings-*.jar (jars are + zips) + <br /> + <br /> + In the resulting unzipped folder open the file to read: + /META-INF/MANIFEST.MF + </p> + <p>You get something like this: </p> + <source> +<![CDATA[ +Manifest-Version: 1.0 +Built-By: OpenMeetings - http://openmeetings.apache.org +Built-On: 2017/05/01 05:41 +Git-Revision: 943f172e9d63c3ab7210f895fdede1ad7fa6aebc +]]> + </source> + <p>This version info is available since version 1.8.0. If you have an + older version as version 1.8.0 then you might simply check the + language files and the labelid in there, the numbers of labels are + almost always unique in the versions. </p> + + </section> + + </body> + </document> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/HotKeys.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/HotKeys.xml b/openmeetings-server/src/site/xdoc/HotKeys.xml index 1d76a57..e4d5d30 100644 --- a/openmeetings-server/src/site/xdoc/HotKeys.xml +++ b/openmeetings-server/src/site/xdoc/HotKeys.xml @@ -1,54 +1,54 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> -<document xmlns="http://maven.apache.org/XDOC/2.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> - <properties> - <title>Hot Keys</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - <body> - <section name="Keys table"> - <table> - <tr> - <th>Key</th> - <th>Functionality</th> - <th>Configurable</th> - <th>Config Key</th> - </tr> - <tr> - <td>F12 (code 123)</td> - <td>A hot key code for the 'give exclusive audio' functionality.</td> - <td>Yes</td> - <td>exclusive.audio.keycode</td> - </tr> - <tr> - <td>F8 (code 119)</td> - <td>If 1 or 2 video windows are present in the room they will be - "rearranged" to take all the place available</td> - <td>No</td> - <td> - </td> - </tr> - <tr> - <td>F7 (code 118)</td> - <td>A hot key code for the 'mute/unmute audio' functionality.</td> - <td>Yes</td> - <td>mute.keycode</td> - </tr> - </table> - </section> - </body> +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> + <properties> + <title>Hot Keys</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + <body> + <section name="Keys table"> + <table> + <tr> + <th>Key</th> + <th>Functionality</th> + <th>Configurable</th> + <th>Config Key</th> + </tr> + <tr> + <td>F12 (code 123)</td> + <td>A hot key code for the 'give exclusive audio' functionality.</td> + <td>Yes</td> + <td>exclusive.audio.keycode</td> + </tr> + <tr> + <td>F8 (code 119)</td> + <td>If 1 or 2 video windows are present in the room they will be + "rearranged" to take all the place available</td> + <td>No</td> + <td> + </td> + </tr> + <tr> + <td>F7 (code 118)</td> + <td>A hot key code for the 'mute/unmute audio' functionality.</td> + <td>Yes</td> + <td>mute.keycode</td> + </tr> + </table> + </section> + </body> </document> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/IBMDB2Config.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/IBMDB2Config.xml b/openmeetings-server/src/site/xdoc/IBMDB2Config.xml index d8b316a..49f81f8 100644 --- a/openmeetings-server/src/site/xdoc/IBMDB2Config.xml +++ b/openmeetings-server/src/site/xdoc/IBMDB2Config.xml @@ -1,73 +1,73 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> -<document xmlns="http://maven.apache.org/XDOC/2.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> - <properties> - <title>IBM DB2 Configuration</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - <section name="IBM DB2 Configuration"> - - <subsection name="Before you start"> - <i>Tested with IBM DB2 Express-C 9.7.x</i> - <ul> - <li> - Get the IBM Data Server Driver for JDBC and SQLJ from IBM website: - <a - href="https://www14.software.ibm.com/webapp/iwm/web/preLogin.do?source=swg-idsdjs";>https://www14.software.ibm.com/webapp/iwm/web/preLogin.do?source=swg-idsdjs - </a> - </li> - <li>Copy JDBC driver db2jcc4.jar to - webapps/openmeetings/WEB-INF/lib/ - </li> - <li> - Create database for OpenMeetings using a pagesize bigger or equal - 8K, sample query: - <br /> - <source><![CDATA[CREATE DATABASE openmeet AUTOMATIC STORAGE YES ON 'C:' DBPATH ON 'C:' USING CODESET UTF-8 TERRITORY DE COLLATE USING System PAGESIZE 16 K]]></source> - </li> - <li>If you encounter issues, you can drop the db and then run - the web based installer again </li> - </ul> - </subsection> - - <subsection name="Steps todo"> - <ul> - <li> - Run red5-service and goto the web-based installer: - http://localhost:5080/openmeetings/install - </li> - </ul> - </subsection> - - <subsection name="DB2 Sample Configuration"> - <p> - There is a sample configuration for IBM DB2 that ships with - every - release in: - <br /> - /webapps/openmeetings/WEB-INF/classes/META-INF/db2_persistence.xml - </p> - </subsection> - - - </section> - - </body> - -</document> +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> + <properties> + <title>IBM DB2 Configuration</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + <section name="IBM DB2 Configuration"> + + <subsection name="Before you start"> + <i>Tested with IBM DB2 Express-C 9.7.x</i> + <ul> + <li> + Get the IBM Data Server Driver for JDBC and SQLJ from IBM website: + <a + href="https://www14.software.ibm.com/webapp/iwm/web/preLogin.do?source=swg-idsdjs";>https://www14.software.ibm.com/webapp/iwm/web/preLogin.do?source=swg-idsdjs + </a> + </li> + <li>Copy JDBC driver db2jcc4.jar to + webapps/openmeetings/WEB-INF/lib/ + </li> + <li> + Create database for OpenMeetings using a pagesize bigger or equal + 8K, sample query: + <br /> + <source><![CDATA[CREATE DATABASE openmeet AUTOMATIC STORAGE YES ON 'C:' DBPATH ON 'C:' USING CODESET UTF-8 TERRITORY DE COLLATE USING System PAGESIZE 16 K]]></source> + </li> + <li>If you encounter issues, you can drop the db and then run + the web based installer again </li> + </ul> + </subsection> + + <subsection name="Steps todo"> + <ul> + <li> + Run red5-service and goto the web-based installer: + http://localhost:5080/openmeetings/install + </li> + </ul> + </subsection> + + <subsection name="DB2 Sample Configuration"> + <p> + There is a sample configuration for IBM DB2 that ships with + every + release in: + <br /> + /webapps/openmeetings/WEB-INF/classes/META-INF/db2_persistence.xml + </p> + </subsection> + + + </section> + + </body> + +</document> http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/Internationalisation.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/Internationalisation.xml b/openmeetings-server/src/site/xdoc/Internationalisation.xml index 020c1a4..3074967 100644 --- a/openmeetings-server/src/site/xdoc/Internationalisation.xml +++ b/openmeetings-server/src/site/xdoc/Internationalisation.xml @@ -1,48 +1,48 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> -<document xmlns="http://maven.apache.org/XDOC/2.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> - <properties> - <title>Internationalisation</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - <body> - <section name="Where to find language files"> - <p>You can find all current language files here: </p> - <p> - <a - href="https://git-wip-us.apache.org/repos/asf/openmeetings.git/KEYS?p=openmeetings.git;a=tree;f=openmeetings-web/src/main/java/org/apache/openmeetings/web/app;hb=HEAD"; - rel="nofollow">https://git-wip-us.apache.org/repos/asf/openmeetings.git/KEYS?p=openmeetings.git;a=tree;f=openmeetings-web/src/main/java/org/apache/openmeetings/web/app;hb=HEAD - </a> - </p> - <p>Just take one file and translate it to your language. </p> - </section> - <section name="Import and export of Language Files"> - <ul> - <li> - Use the - <a href="LanguageEditor.html">LanguageEditor</a> - for translation - </li> - <li> - with the - <a href="LanguageEditor.html">LanguageEditor</a> - you can import and export Language Files - </li> - </ul> - </section> - </body> -</document> +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> + <properties> + <title>Internationalisation</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + <body> + <section name="Where to find language files"> + <p>You can find all current language files here: </p> + <p> + <a + href="https://git-wip-us.apache.org/repos/asf/openmeetings.git/KEYS?p=openmeetings.git;a=tree;f=openmeetings-web/src/main/java/org/apache/openmeetings/web/app;hb=HEAD"; + rel="nofollow">https://git-wip-us.apache.org/repos/asf/openmeetings.git/KEYS?p=openmeetings.git;a=tree;f=openmeetings-web/src/main/java/org/apache/openmeetings/web/app;hb=HEAD + </a> + </p> + <p>Just take one file and translate it to your language. </p> + </section> + <section name="Import and export of Language Files"> + <ul> + <li> + Use the + <a href="LanguageEditor.html">LanguageEditor</a> + for translation + </li> + <li> + with the + <a href="LanguageEditor.html">LanguageEditor</a> + you can import and export Language Files + </li> + </ul> + </section> + </body> +</document> http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/JUnitTesting.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/JUnitTesting.xml b/openmeetings-server/src/site/xdoc/JUnitTesting.xml index 6c55079..24027f4 100644 --- a/openmeetings-server/src/site/xdoc/JUnitTesting.xml +++ b/openmeetings-server/src/site/xdoc/JUnitTesting.xml @@ -1,85 +1,85 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> -<document xmlns="http://maven.apache.org/XDOC/2.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> - <properties> - <title>JUnit Testing</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - <section name="Introduction"> - <p> - Automatic tests are the significant part of development process. - Below is the instruction of how to run Openmeetings <a href="http://junit.org"; rel="nofollow">JUnit</a> tests. - </p> - </section> - <section name="Details"> - <ol> - <li>running tests using command line: </li> - <li> - <ul> - <li>all tests: - <source>mvn test</source> - </li> - <li>subset of tests by mask: - <source>mvn test -Dtest=TestUserService</source> - </li> - </ul> - </li> - <li>running tests from Eclipse IDE: </li> - <li> - <ul> - <li>Start Eclipse </li> - <li>Load workspace with Openmeetings project (or refresh existing project)</li> - <li>Select "Debug Configurations..." </li> - </ul> - </li> - </ol> - <p> - <a class="fancybox-buttons" href="images/DebugConfigurations.png"> - <img src="images/DebugConfigurations.png" alt="" width="367" height="262" /> - </a> - </p> - <ul> - <li>Create New Junit configuration, give it a name and select test class</li> - </ul> - <p> - <a class="fancybox-buttons" href="images/NewConfiguration.png"> - <img src="images/NewConfiguration.png" alt="" width="420" height="206" /> - </a> - </p> - <ul> - <li>Select Arguments tab </li> - <li>Add the following code to the VM section - <source>-javaagent:/home/solomax/.m2/repository/org/apache/openjpa/openjpa/2.4.1/openjpa-2.4.1.jar -Dom.home=${workspace_loc:openmeetings-web}/src/main/webapp/ -Dbackups.dir=${workspace_loc:openmeetings-web}/target/test-data</source> - </li> - <li>To avoid temporary files being created in OM root, modify - "Working Directory" as follows - <source>${workspace_loc:openmeetings-web/target}</source> - </li> - </ul> - <p> - <a class="fancybox-buttons" href="images/Arguments.png"> - <img src="images/Arguments.png" alt="" width="435" height="410" /> - </a> - </p> - <ul> - <li>Select Debug </li> - </ul> - </section> - </body> -</document> +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> + <properties> + <title>JUnit Testing</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + <section name="Introduction"> + <p> + Automatic tests are the significant part of development process. + Below is the instruction of how to run Openmeetings <a href="http://junit.org"; rel="nofollow">JUnit</a> tests. + </p> + </section> + <section name="Details"> + <ol> + <li>running tests using command line: </li> + <li> + <ul> + <li>all tests: + <source>mvn test</source> + </li> + <li>subset of tests by mask: + <source>mvn test -Dtest=TestUserService</source> + </li> + </ul> + </li> + <li>running tests from Eclipse IDE: </li> + <li> + <ul> + <li>Start Eclipse </li> + <li>Load workspace with Openmeetings project (or refresh existing project)</li> + <li>Select "Debug Configurations..." </li> + </ul> + </li> + </ol> + <p> + <a class="fancybox-buttons" href="images/DebugConfigurations.png"> + <img src="images/DebugConfigurations.png" alt="" width="367" height="262" /> + </a> + </p> + <ul> + <li>Create New Junit configuration, give it a name and select test class</li> + </ul> + <p> + <a class="fancybox-buttons" href="images/NewConfiguration.png"> + <img src="images/NewConfiguration.png" alt="" width="420" height="206" /> + </a> + </p> + <ul> + <li>Select Arguments tab </li> + <li>Add the following code to the VM section + <source>-javaagent:/home/solomax/.m2/repository/org/apache/openjpa/openjpa/2.4.1/openjpa-2.4.1.jar -Dom.home=${workspace_loc:openmeetings-web}/src/main/webapp/ -Dbackups.dir=${workspace_loc:openmeetings-web}/target/test-data</source> + </li> + <li>To avoid temporary files being created in OM root, modify + "Working Directory" as follows + <source>${workspace_loc:openmeetings-web/target}</source> + </li> + </ul> + <p> + <a class="fancybox-buttons" href="images/Arguments.png"> + <img src="images/Arguments.png" alt="" width="435" height="410" /> + </a> + </p> + <ul> + <li>Select Debug </li> + </ul> + </section> + </body> +</document> http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/JVMPerformanceTuning.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/JVMPerformanceTuning.xml b/openmeetings-server/src/site/xdoc/JVMPerformanceTuning.xml index fabc06e..2e36b81 100644 --- a/openmeetings-server/src/site/xdoc/JVMPerformanceTuning.xml +++ b/openmeetings-server/src/site/xdoc/JVMPerformanceTuning.xml @@ -1,67 +1,67 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> -<document xmlns="http://maven.apache.org/XDOC/2.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> - <properties> - <title>Performance Tuning</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - - <section name="Performance Tuning"> - - <p>To use the optimum of performance from your server there is a - start-script for red5 available that does some basic settings in the - JVM. It is called red5-highperf.sh. It is recommended to use that - script for production and high-load scenarios. - </p> - <source> -<![CDATA[ -#!/bin/bash - -if [ -z "$RED5_HOME" ]; then export RED5_HOME=.; fi - -# Previous option set -export JAVA_OPTS="-Xrs -Xms512M -Xmx1024M -Xss128K -XX:NewSize=256m \ - -XX:SurvivorRatio=16 -XX:MinHeapFreeRatio=20 -XX:+ExplicitGCInvokesConcurrent \ - -Djava.net.preferIPv4Stack=true -Xverify:none" - -# start Red5 -echo "Setting Hi Performance Options" -exec $RED5_HOME/red5.sh >> $RED5_HOME/log/jvm.stdout 2>&1 & -]]> - </source> - - <p>You have to exclude the "-XX:+UseConcMarkSweepGC" param from the - default red5-highperf.sh to make it functional! However if you are a - performance expert you might also play with the values to find - perfect matches for your use-case. - </p> - <p> - For a complete overview about possible arguments and their meaning - see: - <a - href="http://www.oracle.com/technetwork/java/javase/tech/vmoptions-jsp-140102.html#PerformanceTuning"; - rel="nofollow">http://www.oracle.com/technetwork/java/javase/tech/vmoptions-jsp-140102.html#PerformanceTuning - </a> - </p> - - </section> - - </body> - +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd";> + <properties> + <title>Performance Tuning</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + + <section name="Performance Tuning"> + + <p>To use the optimum of performance from your server there is a + start-script for red5 available that does some basic settings in the + JVM. It is called red5-highperf.sh. It is recommended to use that + script for production and high-load scenarios. + </p> + <source> +<![CDATA[ +#!/bin/bash + +if [ -z "$RED5_HOME" ]; then export RED5_HOME=.; fi + +# Previous option set +export JAVA_OPTS="-Xrs -Xms512M -Xmx1024M -Xss128K -XX:NewSize=256m \ + -XX:SurvivorRatio=16 -XX:MinHeapFreeRatio=20 -XX:+ExplicitGCInvokesConcurrent \ + -Djava.net.preferIPv4Stack=true -Xverify:none" + +# start Red5 +echo "Setting Hi Performance Options" +exec $RED5_HOME/red5.sh >> $RED5_HOME/log/jvm.stdout 2>&1 & +]]> + </source> + + <p>You have to exclude the "-XX:+UseConcMarkSweepGC" param from the + default red5-highperf.sh to make it functional! However if you are a + performance expert you might also play with the values to find + perfect matches for your use-case. + </p> + <p> + For a complete overview about possible arguments and their meaning + see: + <a + href="http://www.oracle.com/technetwork/java/javase/tech/vmoptions-jsp-140102.html#PerformanceTuning"; + rel="nofollow">http://www.oracle.com/technetwork/java/javase/tech/vmoptions-jsp-140102.html#PerformanceTuning + </a> + </p> + + </section> + + </body> + </document> \ No newline at end of file
