http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/OpenOfficeConverter.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/OpenOfficeConverter.xml b/openmeetings-server/src/site/xdoc/OpenOfficeConverter.xml index b4848b5..66e48b9 100644 --- a/openmeetings-server/src/site/xdoc/OpenOfficeConverter.xml +++ b/openmeetings-server/src/site/xdoc/OpenOfficeConverter.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>OpenOffice converter for OpenMeetings</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - <section name="OpenOffice Service for OpenMeetings"> - <p> - To import .doc, .docx, .odp, .xls, .xlsx, .ppt, .pptx, ... [ all - files that you can open with OpenOffice ] - to OpenMeetings and use - them in the whiteboard you need OpenOffice or LibreOffice - installed the machine that runs OpenMeetings. - </p> - <div class="alert alert-success"> - <i>Since Version 2.0 of OpenMeetings starting of - OpenOffice/LibreOffice as service in not required, JODConverter - will automatically start and shut down the service! - </i> - </div> - <div class="alert alert-success"> - <i>JODConverter is bundled into OpenMeetings since 3.1.4</i> - </div> - <p> - Installation of JODConverter means: You download the ZIP binary from - their - <a href="https://code.google.com/archive/p/jodconverter/downloads"; target="_blank" rel="nofollow">website</a> - and then configure in Apache OpenMeetings Administration > - Configuration (or during installation) the config key - <tt>jod.path</tt> - to point to the "lib" directory of the unpacked JODConverter binary. - There is no restart of OpenMeetings required. - </p> - <p>You should use an OpenOffice version greater 3</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>OpenOffice converter for OpenMeetings</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + <section name="OpenOffice Service for OpenMeetings"> + <p> + To import .doc, .docx, .odp, .xls, .xlsx, .ppt, .pptx, ... [ all + files that you can open with OpenOffice ] + to OpenMeetings and use + them in the whiteboard you need OpenOffice or LibreOffice + installed the machine that runs OpenMeetings. + </p> + <div class="alert alert-success"> + <i>Since Version 2.0 of OpenMeetings starting of + OpenOffice/LibreOffice as service in not required, JODConverter + will automatically start and shut down the service! + </i> + </div> + <div class="alert alert-success"> + <i>JODConverter is bundled into OpenMeetings since 3.1.4</i> + </div> + <p> + Installation of JODConverter means: You download the ZIP binary from + their + <a href="https://code.google.com/archive/p/jodconverter/downloads"; target="_blank" rel="nofollow">website</a> + and then configure in Apache OpenMeetings Administration > + Configuration (or during installation) the config key + <tt>jod.path</tt> + to point to the "lib" directory of the unpacked JODConverter binary. + There is no restart of OpenMeetings required. + </p> + <p>You should use an OpenOffice version greater 3</p> + </section> + </body> +</document>
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/OracleConfig.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/OracleConfig.xml b/openmeetings-server/src/site/xdoc/OracleConfig.xml index 3165724..e59c78a 100644 --- a/openmeetings-server/src/site/xdoc/OracleConfig.xml +++ b/openmeetings-server/src/site/xdoc/OracleConfig.xml @@ -1,61 +1,61 @@ -<?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>Oracle Configuration</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - <section name="IBM DB2 Configuration"> - - <subsection name="Before you start"> - <ul> - <li>Download the latest JDBC Driver from Oracle for your database - version. Place those JARs into - $Red5/webapps/openmeetings/WEB-INF/lib - </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="Oracle Sample Configuration"> - <p> - There is a sample configuration for Oracle that ships with - every release in: - <br /> - /webapps/openmeetings/WEB-INF/classes/META-INF/oracle_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>Oracle Configuration</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + <section name="IBM DB2 Configuration"> + + <subsection name="Before you start"> + <ul> + <li>Download the latest JDBC Driver from Oracle for your database + version. Place those JARs into + $Red5/webapps/openmeetings/WEB-INF/lib + </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="Oracle Sample Configuration"> + <p> + There is a sample configuration for Oracle that ships with + every release in: + <br /> + /webapps/openmeetings/WEB-INF/classes/META-INF/oracle_persistence.xml + </p> + </subsection> + + + </section> + + </body> + +</document> http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/PortSettings.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/PortSettings.xml b/openmeetings-server/src/site/xdoc/PortSettings.xml index e5a15d5..19ff013 100644 --- a/openmeetings-server/src/site/xdoc/PortSettings.xml +++ b/openmeetings-server/src/site/xdoc/PortSettings.xml @@ -1,86 +1,86 @@ -<?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>Port settings</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - <section name="Default Configuration"> - <ul> - <li>Port 5080: HTTP (For example for file upload and download) </li> - <li>Port 1935: RTMP (Flash Stream and Remoting/RPC) </li> - </ul> - <p>Additionally red5 uses some ports internally. However those ports - are not in use by OpenMeetings by default. - </p> - </section> - - <section name="Configure alternative ports"> - <p>You need to change two files: </p> - <ul> - <li>Server-Side configuration: $RED5_HOME/conf/red5.properties, you - need to restart the red5-service so that changes are online. - </li> - <li>Client-Side configuration: - $RED5_HOME/webapps/openmeetings/public/config.xml, you need to clear your - browser cache after changing the file. - </li> - <li> - <tt>Every server side configuration has a client side representative</tt> - </li> - </ul> - <p></p> - <table> - <tr> - <th style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> Config-Name </th> - <th style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> Default-value </th> - <th style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> Name in red5.properties </th> - <th style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> Name in public/config.xml </th> - </tr> - <tr> - <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> HTTP </td> - <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> 5080 </td> - <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> http.port </td> - <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> red5httpport </td> - </tr> - <tr> - <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> RTMP </td> - <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> 1935 </td> - <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> rtmp.port </td> - <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> rtmpport </td> - </tr> - </table> - </section> - - <section name="Preventing Firewall issues"> - <p>A common way of bypassing the firewall is to change HTTP port to 80</p> - <p>A short description about the connection mechanism: The - application first tries connecting to rtmp 3 times, because rtmp is - the protocol that is less performance hungry. If that fails the - application will fallback to rtmpT. - </p> - </section> - - <section name="OpenMeetings over SSL"> - <p> - You can run OpenMeetings completely over SSL. See <a href="RTMPSAndHTTPS.html">RTMPSAndHTTPS</a>. - </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>Port settings</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + <section name="Default Configuration"> + <ul> + <li>Port 5080: HTTP (For example for file upload and download) </li> + <li>Port 1935: RTMP (Flash Stream and Remoting/RPC) </li> + </ul> + <p>Additionally red5 uses some ports internally. However those ports + are not in use by OpenMeetings by default. + </p> + </section> + + <section name="Configure alternative ports"> + <p>You need to change two files: </p> + <ul> + <li>Server-Side configuration: $RED5_HOME/conf/red5.properties, you + need to restart the red5-service so that changes are online. + </li> + <li>Client-Side configuration: + $RED5_HOME/webapps/openmeetings/public/config.xml, you need to clear your + browser cache after changing the file. + </li> + <li> + <tt>Every server side configuration has a client side representative</tt> + </li> + </ul> + <p></p> + <table> + <tr> + <th style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> Config-Name </th> + <th style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> Default-value </th> + <th style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> Name in red5.properties </th> + <th style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> Name in public/config.xml </th> + </tr> + <tr> + <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> HTTP </td> + <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> 5080 </td> + <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> http.port </td> + <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> red5httpport </td> + </tr> + <tr> + <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> RTMP </td> + <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> 1935 </td> + <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> rtmp.port </td> + <td style="border: 1px solid rgb(204, 204, 204); padding: 5px;"> rtmpport </td> + </tr> + </table> + </section> + + <section name="Preventing Firewall issues"> + <p>A common way of bypassing the firewall is to change HTTP port to 80</p> + <p>A short description about the connection mechanism: The + application first tries connecting to rtmp 3 times, because rtmp is + the protocol that is less performance hungry. If that fails the + application will fallback to rtmpT. + </p> + </section> + + <section name="OpenMeetings over SSL"> + <p> + You can run OpenMeetings completely over SSL. See <a href="RTMPSAndHTTPS.html">RTMPSAndHTTPS</a>. + </p> + </section> + </body> +</document> http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/PostgresConfig.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/PostgresConfig.xml b/openmeetings-server/src/site/xdoc/PostgresConfig.xml index 1bbdfe2..9f6b33d 100644 --- a/openmeetings-server/src/site/xdoc/PostgresConfig.xml +++ b/openmeetings-server/src/site/xdoc/PostgresConfig.xml @@ -1,72 +1,72 @@ -<?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>PostgreSQL Configuration</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - <section name="PostgreSQL Configuration"> - - <subsection name="Before you start"> - <ul> - <li>Make sure that you have set utf8 as default/server-character-set - </li> - <li> - make sure PostgreSQL is listening on TCP/IP connections! - <br /> - To verify if PostgreSQL connection is working: OpenMeetings will - automatically create all tables in the database and all tables - should have utf8 as encoding/collation! - </li> - <li>If you encounter issues, you can drop the db and then run - the web based installer again - </li> - <li><span style="font-size: larger; color: blue;">IMPORTANT</span> According to - <a href="http://markmail.org/message/opymlab2e6wygb7p";>this</a> thread you need to ensure:<br/> - <tt>standard_conforming_strings</tt> is set to <tt><b>on</b></tt> and <br/> - <tt>escape_string_warning</tt> is set to <tt><b>off</b></tt> - </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="PostgreSQL Sample Configuration"> - <p> - There is a sample configuration for PostgreSQL that ships with - every - release in: - <br /> - /webapps/openmeetings/WEB-INF/classes/META-INF/postgresql_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>PostgreSQL Configuration</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + <section name="PostgreSQL Configuration"> + + <subsection name="Before you start"> + <ul> + <li>Make sure that you have set utf8 as default/server-character-set + </li> + <li> + make sure PostgreSQL is listening on TCP/IP connections! + <br /> + To verify if PostgreSQL connection is working: OpenMeetings will + automatically create all tables in the database and all tables + should have utf8 as encoding/collation! + </li> + <li>If you encounter issues, you can drop the db and then run + the web based installer again + </li> + <li><span style="font-size: larger; color: blue;">IMPORTANT</span> According to + <a href="http://markmail.org/message/opymlab2e6wygb7p";>this</a> thread you need to ensure:<br/> + <tt>standard_conforming_strings</tt> is set to <tt><b>on</b></tt> and <br/> + <tt>escape_string_warning</tt> is set to <tt><b>off</b></tt> + </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="PostgreSQL Sample Configuration"> + <p> + There is a sample configuration for PostgreSQL that ships with + every + release in: + <br /> + /webapps/openmeetings/WEB-INF/classes/META-INF/postgresql_persistence.xml + </p> + </subsection> + + + </section> + + </body> + +</document> http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/RTMPSAndHTTPS.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/RTMPSAndHTTPS.xml b/openmeetings-server/src/site/xdoc/RTMPSAndHTTPS.xml index ffeec0b..0b2f534 100644 --- a/openmeetings-server/src/site/xdoc/RTMPSAndHTTPS.xml +++ b/openmeetings-server/src/site/xdoc/RTMPSAndHTTPS.xml @@ -1,217 +1,217 @@ -<?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>Using OpenMeetings with RTMPS and HTTPS</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - <section name="Using OpenMeetings with RTMPS and HTTPS"> - <p>There are 3 ways the client communicates with the server: </p> - <ul> - <li>The flash-client uses RTMP protocol to transfer Audio/Video and - to send and receive the user data (login et cetera) to the server - and back - </li> - <li>The browser uses HTTP protocol to load the SWF and to upload and - download the files (documents, pdfs, images) to the server and - back. - </li> - <li>The screensharing client uses RTMP protocol to transfer screen - data and remote control to the server and back - </li> - </ul> - </section> - <section name="Prerequisites"> - <ul> - <li>You need OpenMeetings 1.9.x or later for this, OpenMeetings 1.8.x does not have those options.</li> - <li>Install OpenMeetings according to the install instructions and check that it runs without problems</li> - <li>Rename the existing keystore file <tt>red5/conf/keystore.jmx</tt> to <tt>red5/conf/keystore.bak</tt></li> - <li>Rename the existing truststore file <tt>red5/conf/truststore.jmx</tt> to <tt>red5/conf/truststore.bak</tt></li> - </ul> - </section> - <section name="Create Keystore from the scratch (*)"> - <ol> - <li> - Create a new keystore and key, use the same password for both:<br/> - <br/><source><![CDATA[ -keytool -keysize 2048 -genkey -alias red5 -keyalg RSA -keystore red5/conf/keystore -Enter keystore password: -Re-enter new password: -What is your first and last name? -[Unknown]: <your hostname, e.g demo.openmeetings.de> -What is the name of your organizational unit? -[Unknown]: Dev -What is the name of your organization? -[Unknown]: OpenMeetings -What is the name of your City or Locality? -[Unknown]: Henderson -What is the name of your State or Province? -[Unknown]: Nevada -What is the two-letter country code for this unit? -[Unknown]: US -Is CN=demo.openmeetings.de, OU=Dev, O=OpenMeetings, L=Henderson, ST=Nevada, C=US correct? -[no]: yes -Enter key password for <red5> -]]></source> - </li> - <li>Generate a CSR: <source><![CDATA[keytool -certreq -keyalg RSA -alias red5 -file red5.csr -keystore red5/conf/keystore]]></source> - </li> - <li>Submit CSR to your CA of choice and receive a signed certificate - </li> - <li>Import your chosen CA's root certificate into the keystore (may - need to download it from their site - make sure to get the root CA and - not the intermediate one): - <source><![CDATA[keytool -import -alias root -keystore red5/conf/keystore -trustcacerts -file root.crt]]></source> - (note: you may receive a warning that the certificate already exists in the system wide keystore - import - anyway) - </li> - <li>Import the intermediate certificate(s) you normally receive with - the certificate: - <source><![CDATA[keytool -import -alias intermed -keystore red5/conf/keystore -trustcacerts -file intermediate.crt]]></source> - </li> - <li>Import the certificate you received: - <source><![CDATA[keytool -import -alias red5 -keystore red5/conf/keystore -trustcacerts -file demo.openmeetings.de.crt]]></source> - </li> - <li>Please NOTE according to this <a href="http://javarevisited.blogspot.com/2012/09/difference-between-truststore-vs-keyStore-Java-SSL.html";>http://javarevisited.blogspot.com/2012/09/difference-between-truststore-vs-keyStore-Java-SSL.html</a> - guide you can split keystore and truststore (OPTIONAL you might just copy keystore to truststore) - </li> - <li>Create additional certificate as described above. - Add this certificate to the following keystores: <tt>red5/conf/keystore.screen</tt> and <tt>red5/conf/keystore</tt>. (This step is required to be able to use - screen-sharing web application, you can copy "main" keystore while testing) - </li> - </ol> - </section> - <section name="Create Keystore using existing key-pair (**)"> - <p>Prerequicites:</p> - <ul> - <li>Server key: red5.key</li> - <li>Signed CSR: red5.crt</li> - <li>CA's root certificate: root.crt</li> - <li>** Intermediate certificate(s): intermedXX.crt</li> - </ul> - <ol> - <li> - Export existing keys into PKCS12 format:<br/> - <br/><source><![CDATA[ -openssl pkcs12 -export -in red5.crt -inkey red5.key -out red5.p12 -name red5 -certfile root.crt -certfile intermedXX.crt - -Enter Export Password: password -Verifying - Enter Export Password: password -]]></source> - </li> - <li>Import resulting red5.p12 into keystore: <source><![CDATA[ -keytool -importkeystore -srcstorepass password -srckeystore red5.p12 -srcstoretype PKCS12 -deststorepass password -destkeystore red5/conf/keystore -alias red5 -]]></source> - </li> - <li>Import your chosen CA's root certificate into the keystore (may - need to download it from their site - make sure to get the root CA and - not the intermediate one): - <source><![CDATA[keytool -import -alias root -keystore red5/conf/keystore -trustcacerts -file root.crt]]></source> - (note: you may receive a warning that the certificate already exists in the system wide keystore - import - anyway) - </li> - <li>Import the intermediate certificate(s) you normally receive with - the certificate: - <source><![CDATA[keytool -import -alias intermed -keystore red5/conf/keystore -trustcacerts -file intermedXX.crt]]></source> - </li> - <li>Please NOTE according to this <a href="http://javarevisited.blogspot.com/2012/09/difference-between-truststore-vs-keyStore-Java-SSL.html";>http://javarevisited.blogspot.com/2012/09/difference-between-truststore-vs-keyStore-Java-SSL.html</a> - guide you can split keystore and truststore (OPTIONAL you might just copy keystore to truststore) - </li> - <li>Create additional certificate as described above. - Add this certificate to the following keystores: <tt>red5/conf/keystore.screen</tt> and <tt>red5/conf/keystore</tt>. (This step is required to be able to use - screen-sharing web application, you can copy "main" keystore while testing) - </li> - </ol> - </section> - <section name="SSL for the web interface"> - <p>Please perform following steps if you want to use SSL for the web interface. - This is mainly to secure the server against MITM attacks, additionally some other features - like file uploads also use a plain HTTP connection if this is not - done. The following instructions assume that you have already set up - RTMPS successfully. </p> - <ol> - <li> - Edit <tt>red5/conf/jee-container.xml</tt> file:<br/> - Comment <tt>Tomcat without SSL enabled</tt> section<br/> - UNComment <tt>Tomcat with SSL enabled</tt> section - </li> - <li> - Edit <tt>red5/webapps/openmeetings/public/config.xml</tt> and set - <br/><source><![CDATA[ - <protocol>https</protocol> - <red5httpport>5443</red5httpport> -]]></source> - </li> - <li> - Restart red5 and try to connect to - <u>https://your.server:5443</u> - you should be redirected to the OpenMeetings - app and all access should be via HTTPS and/or RTMPS (close port 5080 to be sure). - </li> - </ol> - </section> - <section name="Set up RTMPS"> - <h3>Tunneling RTMPS</h3> - <ol> - <li>HTTPS need to be enabled otherwise tunneling will not work (it can be set up using frontend nginx/apache as well)</li> - <li> - Edit <tt>red5/webapps/openmeetings/public/config.xml</tt> and set<br/> - <br/><source><![CDATA[ - <rtmpsslport>5443</rtmpsslport> - <useSSL>yes</useSSL> - <proxyType>none</proxyType> -]]></source> - </li> - <li>Please NOTE <tt>rtmpsslport</tt> port set in <tt>red5/webapps/openmeetings/public/config.xml</tt> should match - <tt>https</tt> port set in <tt>red5/conf/red5.properties</tt> - </li> - <li>Restart red5 and try to connect - your connection should now be made via RTMPS (close port 1935 to be sure) - </li> - </ol> - <h3>Native RTMPS</h3> - <ol> - <li> Default RTMPS port is 8443, you can change it by editing <tt>red5/conf/red5.properties</tt> and change the port here: <tt>rtmps.port=8443</tt><br/> - Please set <tt>rtmps.keystorepass=password</tt> and <tt>rtmps.truststorepass=password</tt> - (password = password you set on your new keystore(s))<br/> - Additionally you need to set <tt>rtmps.screen.keystorepass=screenpassword</tt> (screenpassword = password you set on your keystore for screen-sharing application) - </li> - <li> - Edit <tt>red5/conf/red5-core.xml</tt> file:<br/> - UNComment <tt>RTMPS</tt> section - </li> - <li> - Edit <tt>red5/webapps/openmeetings/public/config.xml</tt> and set<br/> - <br/><source><![CDATA[ - <rtmpsslport>8443</rtmpsslport> - <useSSL>yes</useSSL> - <proxyType>best</proxyType> -]]></source> - </li> - <li>Please NOTE <tt>rtmps</tt> port set in <tt>red5/conf/red5.properties</tt> should be in sync with the <tt>rtmpsslport</tt> set in - <tt>red5/webapps/openmeetings/public/config.xml</tt> - </li> - <li>Restart red5 and try to connect - your connection should now be made via RTMPS (close port 1935 to be sure) - </li> - </ol> - </section> - <section name="Credits"> - <p>Credits goto: Nexus and Holger Rabbach for their help and - contribution and configuration documention! </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>Using OpenMeetings with RTMPS and HTTPS</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + <section name="Using OpenMeetings with RTMPS and HTTPS"> + <p>There are 3 ways the client communicates with the server: </p> + <ul> + <li>The flash-client uses RTMP protocol to transfer Audio/Video and + to send and receive the user data (login et cetera) to the server + and back + </li> + <li>The browser uses HTTP protocol to load the SWF and to upload and + download the files (documents, pdfs, images) to the server and + back. + </li> + <li>The screensharing client uses RTMP protocol to transfer screen + data and remote control to the server and back + </li> + </ul> + </section> + <section name="Prerequisites"> + <ul> + <li>You need OpenMeetings 1.9.x or later for this, OpenMeetings 1.8.x does not have those options.</li> + <li>Install OpenMeetings according to the install instructions and check that it runs without problems</li> + <li>Rename the existing keystore file <tt>red5/conf/keystore.jmx</tt> to <tt>red5/conf/keystore.bak</tt></li> + <li>Rename the existing truststore file <tt>red5/conf/truststore.jmx</tt> to <tt>red5/conf/truststore.bak</tt></li> + </ul> + </section> + <section name="Create Keystore from the scratch (*)"> + <ol> + <li> + Create a new keystore and key, use the same password for both:<br/> + <br/><source><![CDATA[ +keytool -keysize 2048 -genkey -alias red5 -keyalg RSA -keystore red5/conf/keystore +Enter keystore password: +Re-enter new password: +What is your first and last name? +[Unknown]: <your hostname, e.g demo.openmeetings.de> +What is the name of your organizational unit? +[Unknown]: Dev +What is the name of your organization? +[Unknown]: OpenMeetings +What is the name of your City or Locality? +[Unknown]: Henderson +What is the name of your State or Province? +[Unknown]: Nevada +What is the two-letter country code for this unit? +[Unknown]: US +Is CN=demo.openmeetings.de, OU=Dev, O=OpenMeetings, L=Henderson, ST=Nevada, C=US correct? +[no]: yes +Enter key password for <red5> +]]></source> + </li> + <li>Generate a CSR: <source><![CDATA[keytool -certreq -keyalg RSA -alias red5 -file red5.csr -keystore red5/conf/keystore]]></source> + </li> + <li>Submit CSR to your CA of choice and receive a signed certificate + </li> + <li>Import your chosen CA's root certificate into the keystore (may + need to download it from their site - make sure to get the root CA and + not the intermediate one): + <source><![CDATA[keytool -import -alias root -keystore red5/conf/keystore -trustcacerts -file root.crt]]></source> + (note: you may receive a warning that the certificate already exists in the system wide keystore - import + anyway) + </li> + <li>Import the intermediate certificate(s) you normally receive with + the certificate: + <source><![CDATA[keytool -import -alias intermed -keystore red5/conf/keystore -trustcacerts -file intermediate.crt]]></source> + </li> + <li>Import the certificate you received: + <source><![CDATA[keytool -import -alias red5 -keystore red5/conf/keystore -trustcacerts -file demo.openmeetings.de.crt]]></source> + </li> + <li>Please NOTE according to this <a href="http://javarevisited.blogspot.com/2012/09/difference-between-truststore-vs-keyStore-Java-SSL.html";>http://javarevisited.blogspot.com/2012/09/difference-between-truststore-vs-keyStore-Java-SSL.html</a> + guide you can split keystore and truststore (OPTIONAL you might just copy keystore to truststore) + </li> + <li>Create additional certificate as described above. + Add this certificate to the following keystores: <tt>red5/conf/keystore.screen</tt> and <tt>red5/conf/keystore</tt>. (This step is required to be able to use + screen-sharing web application, you can copy "main" keystore while testing) + </li> + </ol> + </section> + <section name="Create Keystore using existing key-pair (**)"> + <p>Prerequicites:</p> + <ul> + <li>Server key: red5.key</li> + <li>Signed CSR: red5.crt</li> + <li>CA's root certificate: root.crt</li> + <li>** Intermediate certificate(s): intermedXX.crt</li> + </ul> + <ol> + <li> + Export existing keys into PKCS12 format:<br/> + <br/><source><![CDATA[ +openssl pkcs12 -export -in red5.crt -inkey red5.key -out red5.p12 -name red5 -certfile root.crt -certfile intermedXX.crt + +Enter Export Password: password +Verifying - Enter Export Password: password +]]></source> + </li> + <li>Import resulting red5.p12 into keystore: <source><![CDATA[ +keytool -importkeystore -srcstorepass password -srckeystore red5.p12 -srcstoretype PKCS12 -deststorepass password -destkeystore red5/conf/keystore -alias red5 +]]></source> + </li> + <li>Import your chosen CA's root certificate into the keystore (may + need to download it from their site - make sure to get the root CA and + not the intermediate one): + <source><![CDATA[keytool -import -alias root -keystore red5/conf/keystore -trustcacerts -file root.crt]]></source> + (note: you may receive a warning that the certificate already exists in the system wide keystore - import + anyway) + </li> + <li>Import the intermediate certificate(s) you normally receive with + the certificate: + <source><![CDATA[keytool -import -alias intermed -keystore red5/conf/keystore -trustcacerts -file intermedXX.crt]]></source> + </li> + <li>Please NOTE according to this <a href="http://javarevisited.blogspot.com/2012/09/difference-between-truststore-vs-keyStore-Java-SSL.html";>http://javarevisited.blogspot.com/2012/09/difference-between-truststore-vs-keyStore-Java-SSL.html</a> + guide you can split keystore and truststore (OPTIONAL you might just copy keystore to truststore) + </li> + <li>Create additional certificate as described above. + Add this certificate to the following keystores: <tt>red5/conf/keystore.screen</tt> and <tt>red5/conf/keystore</tt>. (This step is required to be able to use + screen-sharing web application, you can copy "main" keystore while testing) + </li> + </ol> + </section> + <section name="SSL for the web interface"> + <p>Please perform following steps if you want to use SSL for the web interface. + This is mainly to secure the server against MITM attacks, additionally some other features + like file uploads also use a plain HTTP connection if this is not + done. The following instructions assume that you have already set up + RTMPS successfully. </p> + <ol> + <li> + Edit <tt>red5/conf/jee-container.xml</tt> file:<br/> + Comment <tt>Tomcat without SSL enabled</tt> section<br/> + UNComment <tt>Tomcat with SSL enabled</tt> section + </li> + <li> + Edit <tt>red5/webapps/openmeetings/public/config.xml</tt> and set + <br/><source><![CDATA[ + <protocol>https</protocol> + <red5httpport>5443</red5httpport> +]]></source> + </li> + <li> + Restart red5 and try to connect to + <u>https://your.server:5443</u> - you should be redirected to the OpenMeetings + app and all access should be via HTTPS and/or RTMPS (close port 5080 to be sure). + </li> + </ol> + </section> + <section name="Set up RTMPS"> + <h3>Tunneling RTMPS</h3> + <ol> + <li>HTTPS need to be enabled otherwise tunneling will not work (it can be set up using frontend nginx/apache as well)</li> + <li> + Edit <tt>red5/webapps/openmeetings/public/config.xml</tt> and set<br/> + <br/><source><![CDATA[ + <rtmpsslport>5443</rtmpsslport> + <useSSL>yes</useSSL> + <proxyType>none</proxyType> +]]></source> + </li> + <li>Please NOTE <tt>rtmpsslport</tt> port set in <tt>red5/webapps/openmeetings/public/config.xml</tt> should match + <tt>https</tt> port set in <tt>red5/conf/red5.properties</tt> + </li> + <li>Restart red5 and try to connect - your connection should now be made via RTMPS (close port 1935 to be sure) + </li> + </ol> + <h3>Native RTMPS</h3> + <ol> + <li> Default RTMPS port is 8443, you can change it by editing <tt>red5/conf/red5.properties</tt> and change the port here: <tt>rtmps.port=8443</tt><br/> + Please set <tt>rtmps.keystorepass=password</tt> and <tt>rtmps.truststorepass=password</tt> + (password = password you set on your new keystore(s))<br/> + Additionally you need to set <tt>rtmps.screen.keystorepass=screenpassword</tt> (screenpassword = password you set on your keystore for screen-sharing application) + </li> + <li> + Edit <tt>red5/conf/red5-core.xml</tt> file:<br/> + UNComment <tt>RTMPS</tt> section + </li> + <li> + Edit <tt>red5/webapps/openmeetings/public/config.xml</tt> and set<br/> + <br/><source><![CDATA[ + <rtmpsslport>8443</rtmpsslport> + <useSSL>yes</useSSL> + <proxyType>best</proxyType> +]]></source> + </li> + <li>Please NOTE <tt>rtmps</tt> port set in <tt>red5/conf/red5.properties</tt> should be in sync with the <tt>rtmpsslport</tt> set in + <tt>red5/webapps/openmeetings/public/config.xml</tt> + </li> + <li>Restart red5 and try to connect - your connection should now be made via RTMPS (close port 1935 to be sure) + </li> + </ol> + </section> + <section name="Credits"> + <p>Credits goto: Nexus and Holger Rabbach for their help and + contribution and configuration documention! </p> + </section> + </body> +</document> http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/RecommendedHardwareList.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/RecommendedHardwareList.xml b/openmeetings-server/src/site/xdoc/RecommendedHardwareList.xml index 7e66cc5..daddf3b 100644 --- a/openmeetings-server/src/site/xdoc/RecommendedHardwareList.xml +++ b/openmeetings-server/src/site/xdoc/RecommendedHardwareList.xml @@ -1,59 +1,59 @@ -<?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>Hardware</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - <section name="Cameras"> - We recommend the following cameras: - <ul> - <li>Logitech QuickCam Sphere AF</li> - <li>Logitech QuickCam E3500</li> - <li>Samsung Pleomax PWC-7100</li> - <li>Genius Look320S</li> - <li>Integrated Lenovo 3000 n100</li> - <li>Skypemate WC-103M</li> - </ul> - </section> - <section name="Headsets"> - The recommended headset model (i.e. headphones with microphone) is: - <ul> - <li>Logitech Clear Chat Style</li> - </ul> - Also the following headsets showed good results: - <ul> - <li>ClearChat PC Wireless (helps to suppress echo)</li> - <li>Logitech USB Desktop Microphone - Mikrophon (good sound, but bad echo cancellation)</li> - </ul> - <b>Note for Mac OS X users:</b> The build-in microphone normally has quite good quality and echo cancellation, so Mac OS X users often do not even require a headset. - </section> - <section name="Speakerphones"> - When several people participate from the same location, we recommend using the following speakerphone models: - <ul> - <li>Phoenix Audio Quattro2 USB Speakerphone MT301 (a single microphone + speakers can be used even with 20-30 people sitting in a room)</li> - <li>Phoenix DUET Executive</li> - <li>Jabra SPEAK410</li> - <li>Plantronics MCD 100M</li> - <li>Integrated Lenovo 3000 n100</li> - <li>Konftel 300</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>Hardware</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + <section name="Cameras"> + We recommend the following cameras: + <ul> + <li>Logitech QuickCam Sphere AF</li> + <li>Logitech QuickCam E3500</li> + <li>Samsung Pleomax PWC-7100</li> + <li>Genius Look320S</li> + <li>Integrated Lenovo 3000 n100</li> + <li>Skypemate WC-103M</li> + </ul> + </section> + <section name="Headsets"> + The recommended headset model (i.e. headphones with microphone) is: + <ul> + <li>Logitech Clear Chat Style</li> + </ul> + Also the following headsets showed good results: + <ul> + <li>ClearChat PC Wireless (helps to suppress echo)</li> + <li>Logitech USB Desktop Microphone - Mikrophon (good sound, but bad echo cancellation)</li> + </ul> + <b>Note for Mac OS X users:</b> The build-in microphone normally has quite good quality and echo cancellation, so Mac OS X users often do not even require a headset. + </section> + <section name="Speakerphones"> + When several people participate from the same location, we recommend using the following speakerphone models: + <ul> + <li>Phoenix Audio Quattro2 USB Speakerphone MT301 (a single microphone + speakers can be used even with 20-30 people sitting in a room)</li> + <li>Phoenix DUET Executive</li> + <li>Jabra SPEAK410</li> + <li>Plantronics MCD 100M</li> + <li>Integrated Lenovo 3000 n100</li> + <li>Konftel 300</li> + </ul> + </section> + </body> +</document> http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/RedminePlugin.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/RedminePlugin.xml b/openmeetings-server/src/site/xdoc/RedminePlugin.xml index 9c6aed2..c302720 100644 --- a/openmeetings-server/src/site/xdoc/RedminePlugin.xml +++ b/openmeetings-server/src/site/xdoc/RedminePlugin.xml @@ -1,34 +1,34 @@ -<?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>Redmine Plugin</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - <body> - <section name="OpenMeetings Plugin for Redmine"> - <p> - Current Development Snapshots for testing can be created from the sources: - <a href="https://github.com/openmeetings/openmeetings-redmine-plugin";>here</a>.<br/> - The page at redmine site is <a href="http://www.redmine.org/plugins/redmine-openmeetings";>here</a> - </p> - </section> - <section name="Features"> - <p>TBD</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>Redmine Plugin</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + <body> + <section name="OpenMeetings Plugin for Redmine"> + <p> + Current Development Snapshots for testing can be created from the sources: + <a href="https://github.com/openmeetings/openmeetings-redmine-plugin";>here</a>.<br/> + The page at redmine site is <a href="http://www.redmine.org/plugins/redmine-openmeetings";>here</a> + </p> + </section> + <section name="Features"> + <p>TBD</p> + </section> + </body> +</document> http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/ReleaseGuide.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/ReleaseGuide.xml b/openmeetings-server/src/site/xdoc/ReleaseGuide.xml index 8271385..db7ab1b 100644 --- a/openmeetings-server/src/site/xdoc/ReleaseGuide.xml +++ b/openmeetings-server/src/site/xdoc/ReleaseGuide.xml @@ -1,314 +1,314 @@ -<?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>Release Guide</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - - <body> - <section name="How to Build a Release of OpenMeetings"> - <subsection name="Required tools"> - <div> - <p>To build a binary release of OpenMeetings you need: </p> - <ul> - <li>Sun JDK8</li> - <li>Apache Maven 3.3.9</li> - <li> - SVN Command line client (Subversion 1.7 required!) - <a href="http://subversion.apache.org/packages.html"; target="_blank" rel="nofollow">http://subversion.apache.org/packages.html</a> - </li> - <li>A text editor</li> - <li>You need to be online! The build process actively downloads needed libraries and dependencies.</li> - <li>Valid certficate to be able to enter <a href="https://securesigning.websecurity.symantec.com/csportal/";>https://securesigning.websecurity.symantec.com/csportal/</a> - Please ask INFRA in case you need one. - </li> - </ul> - </div> - </subsection> - <subsection name="Prepare your Apache ID"> - <div> - <ul> - <li><b>Every release package must be signed with a PGP/GPG key.</b><br /> - So if you want to release a package your Apache Id must be - connected with a PGP key! - <br /> - <br /> - You might follow: - <br /> - <a - href="http://www.apache.org/dev/new-committers-guide.html#security-and-pgp"; - target="_blank">http://www.apache.org/dev/new-committers-guide.html#security-and-pgp - </a> - <br /> - <br /> - In short: - <ul> - <li>Create PGP key pairs (private + public) (and I recommend creating a Revoke Cert)</li> - <li>Upload the public key (either bei using the PGP Tool that you use - to create the key) or by using the web form to: - <a href="http://pgp.mit.edu/"; target="_blank" rel="nofollow">http://pgp.mit.edu/</a> - </li> - <li>Add the fingerprint string (something like "BF13 CF11 F9C9 0CBE - 4413 09AB 0055 16BF 93A3 0395") to your profile at - <a href="https://id.apache.org/"; target="_blank" rel="nofollow">https://id.apache.org/</a> - </li> - <li> - Wait for 6-8 hours, the server will search for a public key based - on your fingerprint, if success it will create a file with your - name at: - <br /> - <a href="https://people.apache.org/keys/committer/";>https://people.apache.org/keys/committer/</a> - </li> - <li> - If that is "success" then add your key to: - <br /> - <a href="https://git-wip-us.apache.org/repos/asf/openmeetings.git/KEYS?p=openmeetings.git;a=blob;f=KEYS;hb=HEAD";>https://git-wip-us.apache.org/repos/asf/openmeetings.git/KEYS?p=openmeetings.git;a=blob;f=KEYS;hb=HEAD</a> - <br /> - <br /> - and follow the instructions in the file. - </li> - </ul> - </li> - <li><b>Maven</b><br/> - <ul> - <li>Ensure you able to login to <a href="https://repository.apache.org/";>https://repository.apache.org</a></li> - <li> - Set up development environment as described here: <a href="http://www.apache.org/dev/publishing-maven-artifacts.html#dev-env";>Setup development environment</a><br/> - Don't forget to secure passwords as described here: <a href="http://maven.apache.org/guides/mini/guide-encryption.html#How_to_create_a_master_password";>Password Encryption</a> - </li> - - </ul> - </li> - </ul> - </div> - </subsection> - <subsection name="Step1 - Prepare files"> - <ul> - <li>Switch to the necessary branch: - <source> -git checkout BRANCH - </source> - </li> - <li> - Check that all files:<br /> - LICENSE, NOTICE, DISCLAIMER, CHANGELOG, README<br /> - are up to date and refer to the right version. - </li> - <li> - Update following files in OM documentation:<br/> - <tt>openmeetings-server/src/site/xdoc/index.xml</tt><br/> - <tt>openmeetings-server/src/site/xdoc/NewsArchive.xml</tt><br/> - <tt>openmeetings-server/src/site/xdoc/downloads.xml</tt><br/> - </li> - <li> - Create a TAG of the Git tree that you would like to release<br/> - Example: - - <source> -git tag 4.0.0RC1 -git push origin 4.0.0RC1 - </source> - </li> - <li> - <p>Get the source from your TAG: </p> - <source>git checkout $BRANCHORTAG</source> - <p>$BRANCHORTAG should be replaced with your new TAG</p> - </li> - <li> - <p>Update versions of all modules</p> - <source>mvn versions:set -DgenerateBackupPoms=false -DnewVersion=3.1.0</source> - </li> - <li>Deploy release artifacts to Maven - <ul> - <li> - <source> -mvn clean -mvn deploy -Pdeploy,rc - </source> - </li> - </ul> - </li> - <li> - <p>Run the command: </p> - <source>mvn clean install -P allModules,rc</source> - </li> - <li> - <p>Test building the source on windows and OSx or Linux</p> - <p>Test running the binary's</p> - </li> - <li> - <p> - Commit artifacts you have created with KEYS file to the - <tt>https://dist.apache.org/repos/dist/dev/openmeetings/</tt> - Proposed file structure for "Release Candidate 1" of 3.1.0 will be: - </p> - <source> -3.1.0 -3.1.0/rc1 -3.1.0/rc1/src -3.1.0/rc1/src/apache-openmeetings-3.1.0-src.zip -3.1.0/rc1/src/apache-openmeetings-3.1.0-src.tar.gz -3.1.0/rc1/src/apache-openmeetings-3.1.0-src.zip.sha -3.1.0/rc1/src/apache-openmeetings-3.1.0-src.zip.asc -3.1.0/rc1/src/apache-openmeetings-3.1.0-src.tar.gz.sha -3.1.0/rc1/src/apache-openmeetings-3.1.0-src.tar.gz.asc -3.1.0/rc1/bin -3.1.0/rc1/bin/apache-openmeetings-3.1.0.zip -3.1.0/rc1/bin/apache-openmeetings-3.1.0.tar.gz -3.1.0/rc1/bin/apache-openmeetings-3.1.0.zip.sha -3.1.0/rc1/bin/apache-openmeetings-3.1.0.zip.asc -3.1.0/rc1/bin/apache-openmeetings-3.1.0.tar.gz.sha -3.1.0/rc1/bin/apache-openmeetings-3.1.0.tar.gz.asc -3.1.0/rc1/CHANGELOG -3.1.0/rc1/KEYS - </source> - </li> - </ul> - </subsection> - - <subsection name="Step2 - VOTE and RESULT emails"> - <p> - Send a "VOTE" to the developer mailing list including links to release artifacts.<br /> - A VOTE always contains two parts:<br /> - Send an email to the developer mailing list with the subject line:<br /> - [VOTE] Apache OpenMeetings x.xx release<br /> - An example for such an email: - <a href="http://mail-archives.apache.org/mod_mbox/openmeetings-dev/201701.mbox/%3CCAJmbs8jZ7EiXoeBbG4ynvg30FPx2nAOJMypE2Qp-v-c63ayO9A%40mail.gmail.com%3E";>example Vote email</a> - <a href="http://s.apache.org/vote-2.0.0RC4";>example Vote email (Incubator)</a> - <br /> - After the vote is over, send a "RESULT" email to the list with the subject line:<br /> - [RESULT][VOTE] Apache OpenMeetings x.xx release<br /> - An example for such an email: - <a - href="http://mail-archives.apache.org/mod_mbox/openmeetings-dev/201701.mbox/%3CCAJmbs8gyvHuarzdVma%2BF6ap7RHBhhVciZp5Oi5JogQdLR6o0NA%40mail.gmail.com%3E";>example Result email</a> - <br /> - Votes on whether a package is ready to be released use majority approval -- i.e., at - least three PMC members must vote affirmatively for release, and there must be more - positive than negative votes. Releases may not be vetoed. Before voting +1 PMC members - are required to download the signed source code package, compile it as provided, and - test the resulting executable on their own platform, along with also verifying that - the package meets the requirements of the ASF policy on releases. - </p> - </subsection> - - <subsection name="Step3 - Sign web start application"> - <p>If VOTEs positive: Sign screen sharing web application and re-pack the release</p> - <ul> - <li>Go to the folder you check out your $BRANCHORTAG</li> - <li> - <p>Run the command: </p> - <source> -cd openmeetings-screenshare -mvn clean install -Prc,release - </source> - </li> - <li>Go to <a href="https://securesigning.websecurity.symantec.com/csportal/";>https://securesigning.websecurity.symantec.com/csportal/</a></li> - <li>Select "Signing Sets"</li> - <li>Select "Add signing set"</li> - <li>Enter "Signing set name" (must include "Apache OpenMeetings" and version) for ex. "Apache OpenMeetings 3.1.0-RELEASE"</li> - <li>Enter "Version" for ex. "3.1.0-RELEASE"</li> - <li>Select "Java Signing Sha256" as "Signing service"</li> - <li>Select "Upload files" and add all <b>jar</b> files from <tt>target/jnlp</tt></li> - <li>Select "Sign now"</li> - <li>Select "Type of signing" -> "Production"</li> - <li>Select "Sign"</li> - <li>Select "Download set"</li> - <li>Open binary artifacts of OM created on previous step (both <b>tar.gz</b> and <b>zip</b>)</li> - <li>Replace jar files inside artifacts <tt>webapps/openmeetings/screenshare</tt> with the signed ones</li> - <li> - Re-create artifact signatures - <p>Create sha256sum checksums</p> - <source> -#On OSX you might use this command to make a SHA checksum and store it to a file -shasum -a 256 -r apache-openmeetings-XXX-src.zip >apache-openmeetings-XXX-src.zip.sha256 - </source> - <source> -<![CDATA[ -#To create SHA hashes On Ubuntu: -for f in `ls -1 *.tar.gz *.zip`; do sha256sum $f > $f.sha256; done - -#To check SHA hashes On Ubuntu: -for f in `ls -1 *.tar.gz *.zip`; do sha256sum -c $f.sha256; done -]]> - </source> - <p> - Create signatures with the your KEY for every file, the KEY must be available at:<br /> - <a href="https://git-wip-us.apache.org/repos/asf/openmeetings.git/KEYS?p=openmeetings.git;a=blob;f=KEYS;hb=HEAD";> - https://git-wip-us.apache.org/repos/asf/openmeetings.git/KEYS?p=openmeetings.git;a=blob;f=KEYS;hb=HEAD - </a> - </p> - <source> -<![CDATA[ -#To create signatures On Ubuntu: -for f in `ls -1 *.tar.gz *.zip`; do gpg --armor --output $f.asc --detach-sig $f; done - -#To check signatures On Ubuntu: -for f in `ls -1 *.tar.gz *.zip`; do gpg --verify $f.asc; done -]]> - </source> - </li> - </ul> - <p>NOTE: "Type of signing" can be selected as "Test" to check everything works as expected</p> - - </subsection> - - <subsection name="Step4 - Distribute and announce"> - <p>If VOTEs positive: Upload the release </p> - <ul> - <li>Upload Artifacts with signatures created on the previous steps to - https://dist.apache.org/repos/dist/release/openmeetings/CURRENT_VERSION - </li> - <li>Close staging repo: - <ul> - <li>Go to: <a href="https://repository.apache.org/#stagingRepositories";>Staging Repositories</a></li> - <li>Select openmeetings staging repo and Close it with valid message:<br/> - for ex. "The VOTE about 3.1.2 release was successful" - </li> - <li>Select openmeetings staging repo and Release it with valid message:<br/> - for ex. "The VOTE about 3.1.2 release was successful" - </li> - </ul> - </li> - <li> - Wait 24 hours (until all Apache mirrors have synced the packages) - and send an announcement to the mailing list + blog and any other - channel. - </li> - <li> - Email announcements should have the subject line:<br /> - [ANNOUNCE] Apache OpenMeetings x.xx released - </li> - <li> - Update release section of DOAP file <tt>openmeetings-site/doap.rdf (https://git-wip-us.apache.org/repos/asf?p=openmeetings-site.git;a=blob;f=doap.rdf;hb=HEAD)</tt> - </li> - <li> - Add a section to <a href="downloads.html">downloads</a> website.<br /> - Make sure that the binary packages are linked using the mirror URL as base path ( - <b>not</b> http://www.apache.org/dist):<br /> - Mirror URL: - <a href="http://www.apache.org/dyn/closer.lua/openmeetings/";>http://www.apache.org/dyn/closer.lua/openmeetings/</a> - </li> - <li> - Release candidates should be deleted from <tt>https://dist.apache.org/repos/dist/dev/openmeetings/</tt><br/> - Old releases should be deleted from <tt>https://dist.apache.org/repos/dist/release/openmeetings/</tt> - </li> - </ul> - </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>Release Guide</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + + <body> + <section name="How to Build a Release of OpenMeetings"> + <subsection name="Required tools"> + <div> + <p>To build a binary release of OpenMeetings you need: </p> + <ul> + <li>Sun JDK8</li> + <li>Apache Maven 3.3.9</li> + <li> + SVN Command line client (Subversion 1.7 required!) + <a href="http://subversion.apache.org/packages.html"; target="_blank" rel="nofollow">http://subversion.apache.org/packages.html</a> + </li> + <li>A text editor</li> + <li>You need to be online! The build process actively downloads needed libraries and dependencies.</li> + <li>Valid certficate to be able to enter <a href="https://securesigning.websecurity.symantec.com/csportal/";>https://securesigning.websecurity.symantec.com/csportal/</a> + Please ask INFRA in case you need one. + </li> + </ul> + </div> + </subsection> + <subsection name="Prepare your Apache ID"> + <div> + <ul> + <li><b>Every release package must be signed with a PGP/GPG key.</b><br /> + So if you want to release a package your Apache Id must be + connected with a PGP key! + <br /> + <br /> + You might follow: + <br /> + <a + href="http://www.apache.org/dev/new-committers-guide.html#security-and-pgp"; + target="_blank">http://www.apache.org/dev/new-committers-guide.html#security-and-pgp + </a> + <br /> + <br /> + In short: + <ul> + <li>Create PGP key pairs (private + public) (and I recommend creating a Revoke Cert)</li> + <li>Upload the public key (either bei using the PGP Tool that you use + to create the key) or by using the web form to: + <a href="http://pgp.mit.edu/"; target="_blank" rel="nofollow">http://pgp.mit.edu/</a> + </li> + <li>Add the fingerprint string (something like "BF13 CF11 F9C9 0CBE + 4413 09AB 0055 16BF 93A3 0395") to your profile at + <a href="https://id.apache.org/"; target="_blank" rel="nofollow">https://id.apache.org/</a> + </li> + <li> + Wait for 6-8 hours, the server will search for a public key based + on your fingerprint, if success it will create a file with your + name at: + <br /> + <a href="https://people.apache.org/keys/committer/";>https://people.apache.org/keys/committer/</a> + </li> + <li> + If that is "success" then add your key to: + <br /> + <a href="https://git-wip-us.apache.org/repos/asf/openmeetings.git/KEYS?p=openmeetings.git;a=blob;f=KEYS;hb=HEAD";>https://git-wip-us.apache.org/repos/asf/openmeetings.git/KEYS?p=openmeetings.git;a=blob;f=KEYS;hb=HEAD</a> + <br /> + <br /> + and follow the instructions in the file. + </li> + </ul> + </li> + <li><b>Maven</b><br/> + <ul> + <li>Ensure you able to login to <a href="https://repository.apache.org/";>https://repository.apache.org</a></li> + <li> + Set up development environment as described here: <a href="http://www.apache.org/dev/publishing-maven-artifacts.html#dev-env";>Setup development environment</a><br/> + Don't forget to secure passwords as described here: <a href="http://maven.apache.org/guides/mini/guide-encryption.html#How_to_create_a_master_password";>Password Encryption</a> + </li> + + </ul> + </li> + </ul> + </div> + </subsection> + <subsection name="Step1 - Prepare files"> + <ul> + <li>Switch to the necessary branch: + <source> +git checkout BRANCH + </source> + </li> + <li> + Check that all files:<br /> + LICENSE, NOTICE, DISCLAIMER, CHANGELOG, README<br /> + are up to date and refer to the right version. + </li> + <li> + Update following files in OM documentation:<br/> + <tt>openmeetings-server/src/site/xdoc/index.xml</tt><br/> + <tt>openmeetings-server/src/site/xdoc/NewsArchive.xml</tt><br/> + <tt>openmeetings-server/src/site/xdoc/downloads.xml</tt><br/> + </li> + <li> + Create a TAG of the Git tree that you would like to release<br/> + Example: + + <source> +git tag 4.0.0RC1 +git push origin 4.0.0RC1 + </source> + </li> + <li> + <p>Get the source from your TAG: </p> + <source>git checkout $BRANCHORTAG</source> + <p>$BRANCHORTAG should be replaced with your new TAG</p> + </li> + <li> + <p>Update versions of all modules</p> + <source>mvn versions:set -DgenerateBackupPoms=false -DnewVersion=3.1.0</source> + </li> + <li>Deploy release artifacts to Maven + <ul> + <li> + <source> +mvn clean +mvn deploy -Pdeploy,rc + </source> + </li> + </ul> + </li> + <li> + <p>Run the command: </p> + <source>mvn clean install -P allModules,rc</source> + </li> + <li> + <p>Test building the source on windows and OSx or Linux</p> + <p>Test running the binary's</p> + </li> + <li> + <p> + Commit artifacts you have created with KEYS file to the + <tt>https://dist.apache.org/repos/dist/dev/openmeetings/</tt> + Proposed file structure for "Release Candidate 1" of 3.1.0 will be: + </p> + <source> +3.1.0 +3.1.0/rc1 +3.1.0/rc1/src +3.1.0/rc1/src/apache-openmeetings-3.1.0-src.zip +3.1.0/rc1/src/apache-openmeetings-3.1.0-src.tar.gz +3.1.0/rc1/src/apache-openmeetings-3.1.0-src.zip.sha +3.1.0/rc1/src/apache-openmeetings-3.1.0-src.zip.asc +3.1.0/rc1/src/apache-openmeetings-3.1.0-src.tar.gz.sha +3.1.0/rc1/src/apache-openmeetings-3.1.0-src.tar.gz.asc +3.1.0/rc1/bin +3.1.0/rc1/bin/apache-openmeetings-3.1.0.zip +3.1.0/rc1/bin/apache-openmeetings-3.1.0.tar.gz +3.1.0/rc1/bin/apache-openmeetings-3.1.0.zip.sha +3.1.0/rc1/bin/apache-openmeetings-3.1.0.zip.asc +3.1.0/rc1/bin/apache-openmeetings-3.1.0.tar.gz.sha +3.1.0/rc1/bin/apache-openmeetings-3.1.0.tar.gz.asc +3.1.0/rc1/CHANGELOG +3.1.0/rc1/KEYS + </source> + </li> + </ul> + </subsection> + + <subsection name="Step2 - VOTE and RESULT emails"> + <p> + Send a "VOTE" to the developer mailing list including links to release artifacts.<br /> + A VOTE always contains two parts:<br /> + Send an email to the developer mailing list with the subject line:<br /> + [VOTE] Apache OpenMeetings x.xx release<br /> + An example for such an email: + <a href="http://mail-archives.apache.org/mod_mbox/openmeetings-dev/201701.mbox/%3CCAJmbs8jZ7EiXoeBbG4ynvg30FPx2nAOJMypE2Qp-v-c63ayO9A%40mail.gmail.com%3E";>example Vote email</a> + <a href="http://s.apache.org/vote-2.0.0RC4";>example Vote email (Incubator)</a> + <br /> + After the vote is over, send a "RESULT" email to the list with the subject line:<br /> + [RESULT][VOTE] Apache OpenMeetings x.xx release<br /> + An example for such an email: + <a + href="http://mail-archives.apache.org/mod_mbox/openmeetings-dev/201701.mbox/%3CCAJmbs8gyvHuarzdVma%2BF6ap7RHBhhVciZp5Oi5JogQdLR6o0NA%40mail.gmail.com%3E";>example Result email</a> + <br /> + Votes on whether a package is ready to be released use majority approval -- i.e., at + least three PMC members must vote affirmatively for release, and there must be more + positive than negative votes. Releases may not be vetoed. Before voting +1 PMC members + are required to download the signed source code package, compile it as provided, and + test the resulting executable on their own platform, along with also verifying that + the package meets the requirements of the ASF policy on releases. + </p> + </subsection> + + <subsection name="Step3 - Sign web start application"> + <p>If VOTEs positive: Sign screen sharing web application and re-pack the release</p> + <ul> + <li>Go to the folder you check out your $BRANCHORTAG</li> + <li> + <p>Run the command: </p> + <source> +cd openmeetings-screenshare +mvn clean install -Prc,release + </source> + </li> + <li>Go to <a href="https://securesigning.websecurity.symantec.com/csportal/";>https://securesigning.websecurity.symantec.com/csportal/</a></li> + <li>Select "Signing Sets"</li> + <li>Select "Add signing set"</li> + <li>Enter "Signing set name" (must include "Apache OpenMeetings" and version) for ex. "Apache OpenMeetings 3.1.0-RELEASE"</li> + <li>Enter "Version" for ex. "3.1.0-RELEASE"</li> + <li>Select "Java Signing Sha256" as "Signing service"</li> + <li>Select "Upload files" and add all <b>jar</b> files from <tt>target/jnlp</tt></li> + <li>Select "Sign now"</li> + <li>Select "Type of signing" -> "Production"</li> + <li>Select "Sign"</li> + <li>Select "Download set"</li> + <li>Open binary artifacts of OM created on previous step (both <b>tar.gz</b> and <b>zip</b>)</li> + <li>Replace jar files inside artifacts <tt>webapps/openmeetings/screenshare</tt> with the signed ones</li> + <li> + Re-create artifact signatures + <p>Create sha256sum checksums</p> + <source> +#On OSX you might use this command to make a SHA checksum and store it to a file +shasum -a 256 -r apache-openmeetings-XXX-src.zip >apache-openmeetings-XXX-src.zip.sha256 + </source> + <source> +<![CDATA[ +#To create SHA hashes On Ubuntu: +for f in `ls -1 *.tar.gz *.zip`; do sha256sum $f > $f.sha256; done + +#To check SHA hashes On Ubuntu: +for f in `ls -1 *.tar.gz *.zip`; do sha256sum -c $f.sha256; done +]]> + </source> + <p> + Create signatures with the your KEY for every file, the KEY must be available at:<br /> + <a href="https://git-wip-us.apache.org/repos/asf/openmeetings.git/KEYS?p=openmeetings.git;a=blob;f=KEYS;hb=HEAD";> + https://git-wip-us.apache.org/repos/asf/openmeetings.git/KEYS?p=openmeetings.git;a=blob;f=KEYS;hb=HEAD + </a> + </p> + <source> +<![CDATA[ +#To create signatures On Ubuntu: +for f in `ls -1 *.tar.gz *.zip`; do gpg --armor --output $f.asc --detach-sig $f; done + +#To check signatures On Ubuntu: +for f in `ls -1 *.tar.gz *.zip`; do gpg --verify $f.asc; done +]]> + </source> + </li> + </ul> + <p>NOTE: "Type of signing" can be selected as "Test" to check everything works as expected</p> + + </subsection> + + <subsection name="Step4 - Distribute and announce"> + <p>If VOTEs positive: Upload the release </p> + <ul> + <li>Upload Artifacts with signatures created on the previous steps to + https://dist.apache.org/repos/dist/release/openmeetings/CURRENT_VERSION + </li> + <li>Close staging repo: + <ul> + <li>Go to: <a href="https://repository.apache.org/#stagingRepositories";>Staging Repositories</a></li> + <li>Select openmeetings staging repo and Close it with valid message:<br/> + for ex. "The VOTE about 3.1.2 release was successful" + </li> + <li>Select openmeetings staging repo and Release it with valid message:<br/> + for ex. "The VOTE about 3.1.2 release was successful" + </li> + </ul> + </li> + <li> + Wait 24 hours (until all Apache mirrors have synced the packages) + and send an announcement to the mailing list + blog and any other + channel. + </li> + <li> + Email announcements should have the subject line:<br /> + [ANNOUNCE] Apache OpenMeetings x.xx released + </li> + <li> + Update release section of DOAP file <tt>openmeetings-site/doap.rdf (https://git-wip-us.apache.org/repos/asf?p=openmeetings-site.git;a=blob;f=doap.rdf;hb=HEAD)</tt> + </li> + <li> + Add a section to <a href="downloads.html">downloads</a> website.<br /> + Make sure that the binary packages are linked using the mirror URL as base path ( + <b>not</b> http://www.apache.org/dist):<br /> + Mirror URL: + <a href="http://www.apache.org/dyn/closer.lua/openmeetings/";>http://www.apache.org/dyn/closer.lua/openmeetings/</a> + </li> + <li> + Release candidates should be deleted from <tt>https://dist.apache.org/repos/dist/dev/openmeetings/</tt><br/> + Old releases should be deleted from <tt>https://dist.apache.org/repos/dist/release/openmeetings/</tt> + </li> + </ul> + </subsection> + </section> + </body> +</document> http://git-wip-us.apache.org/repos/asf/openmeetings/blob/8e63647c/openmeetings-server/src/site/xdoc/RestAPISample.xml ---------------------------------------------------------------------- diff --git a/openmeetings-server/src/site/xdoc/RestAPISample.xml b/openmeetings-server/src/site/xdoc/RestAPISample.xml index 89710c8..30de9db 100644 --- a/openmeetings-server/src/site/xdoc/RestAPISample.xml +++ b/openmeetings-server/src/site/xdoc/RestAPISample.xml @@ -1,139 +1,139 @@ -<?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>REST API sample</title> - <author email="[email protected]">Apache OpenMeetings Team</author> - </properties> - <body> - <section name="Introduction"> - <p> For a detailed instruction which services, methods and params are available see the list in the <a href="/openmeetings-webservice/apidocs/index.html" target="_blank">SOAP/REST API</a> . - ALL methods that are implemented for the SOAP API are also available via REST. - </p> - <div> - you can query methods of each service using following suffixes - - <ul> - <li>SOAP: <tt>?wsdl</tt> suffix, for example <tt>http://localhost:5080/openmeetings/services/UserService?wsdl</tt></li> - <li>REST: as xml <tt>?_wadl</tt> for example <tt>http://localhost:5080/openmeetings/services/user?_wadl</tt></li> - <li>REST: as json <tt>?_wadl&type=json</tt> for example <tt>http://localhost:5080/openmeetings/services/user?_wadl&type=json</tt></li> - </ul> - <div class="bs-callout bs-callout-info"> - The full list of services with All WSDLs/WADLs is available at following URL: <tt>http://localhost:5080/openmeetings/services/services</tt> - </div> - </div> - </section> - <section name="How to get room hash via REST"> - <ul> - <li> - First of all you need to perform login and get authorized SID to perform authorized operations - <table> - <tr> - <td>Request</td> - <td>Error response</td> - <td>Successful response</td> - </tr> - <tr> - <td> -<source> -$.ajax({ - method: "GET", - url: "services/user/login", - data: {user: 'admin', pass: '12345'}, - dataType: "json" -}); -</source> - </td> - <td> -<source> -{ - "serviceResult": { - "code": -11, - "type": "ERROR" - } -} -</source> - </td> - <td> -<source> -{ - "serviceResult": { - "code": 1, - "message": "78189aff-d68d-458a-8840-5b18d15a50b0", - "type": "SUCCESS" - } -} -</source> - </td> - </tr> - </table> - </li> - <li> - In case of error you can get detailed error message in your language as result of following query - <tt>http://localhost:5080/openmeetings/services/error/<b>ERROR_ID</b>/<b>LANGUAGE_ID</b></tt> - (for ex. http://localhost:5080/openmeetings/services/error/<b>-11</b>/<b>9</b>) - </li> - <li>If your request was successful you will get your SID as <b>message</b> (78189aff-d68d-458a-8840-5b18d15a50b0)</li> - <li>Then you can use SID to generate room hash - <table> - <tr> - <td>Request</td> - <td>Successful response</td> - </tr> - <tr> - <td> -<source> -$.ajax({ - method: "POST", - url: "services/user/hash?sid=78189aff-d68d-458a-8840-5b18d15a50b0", - data: {user: JSON.stringify({ - firstname: 'John', - lastname: 'Doe', - externalId: 'uid1', - externalType: 'myCMS', - login: 'superjohn' - }), - options: JSON.stringify({ - roomId: 5, - moderator: true, - showAudioVideoTest: true - }) - }, - dataType: "json" -}) -</source> - </td> - <td> -<source> -{ - "serviceResult": { - "code": 0, - "message": "fa1f9381-bd03-42ae-9fd9-332b5f775a1b", - "type": "SUCCESS" - } -} -</source> - </td> - </tr> - </table> - </li> - <li>If your request was successful you will get your hash as <b>message</b> (fa1f9381-bd03-42ae-9fd9-332b5f775a1b)</li> - <li>Now you can use following URL to enter the room: <tt>http://localhost:5080/openmeetings/hash?secure=fa1f9381-bd03-42ae-9fd9-332b5f775a1b&language=1</tt></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>REST API sample</title> + <author email="[email protected]">Apache OpenMeetings Team</author> + </properties> + <body> + <section name="Introduction"> + <p> For a detailed instruction which services, methods and params are available see the list in the <a href="/openmeetings-webservice/apidocs/index.html" target="_blank">SOAP/REST API</a> . + ALL methods that are implemented for the SOAP API are also available via REST. + </p> + <div> + you can query methods of each service using following suffixes + + <ul> + <li>SOAP: <tt>?wsdl</tt> suffix, for example <tt>http://localhost:5080/openmeetings/services/UserService?wsdl</tt></li> + <li>REST: as xml <tt>?_wadl</tt> for example <tt>http://localhost:5080/openmeetings/services/user?_wadl</tt></li> + <li>REST: as json <tt>?_wadl&type=json</tt> for example <tt>http://localhost:5080/openmeetings/services/user?_wadl&type=json</tt></li> + </ul> + <div class="bs-callout bs-callout-info"> + The full list of services with All WSDLs/WADLs is available at following URL: <tt>http://localhost:5080/openmeetings/services/services</tt> + </div> + </div> + </section> + <section name="How to get room hash via REST"> + <ul> + <li> + First of all you need to perform login and get authorized SID to perform authorized operations + <table> + <tr> + <td>Request</td> + <td>Error response</td> + <td>Successful response</td> + </tr> + <tr> + <td> +<source> +$.ajax({ + method: "GET", + url: "services/user/login", + data: {user: 'admin', pass: '12345'}, + dataType: "json" +}); +</source> + </td> + <td> +<source> +{ + "serviceResult": { + "code": -11, + "type": "ERROR" + } +} +</source> + </td> + <td> +<source> +{ + "serviceResult": { + "code": 1, + "message": "78189aff-d68d-458a-8840-5b18d15a50b0", + "type": "SUCCESS" + } +} +</source> + </td> + </tr> + </table> + </li> + <li> + In case of error you can get detailed error message in your language as result of following query + <tt>http://localhost:5080/openmeetings/services/error/<b>ERROR_ID</b>/<b>LANGUAGE_ID</b></tt> + (for ex. http://localhost:5080/openmeetings/services/error/<b>-11</b>/<b>9</b>) + </li> + <li>If your request was successful you will get your SID as <b>message</b> (78189aff-d68d-458a-8840-5b18d15a50b0)</li> + <li>Then you can use SID to generate room hash + <table> + <tr> + <td>Request</td> + <td>Successful response</td> + </tr> + <tr> + <td> +<source> +$.ajax({ + method: "POST", + url: "services/user/hash?sid=78189aff-d68d-458a-8840-5b18d15a50b0", + data: {user: JSON.stringify({ + firstname: 'John', + lastname: 'Doe', + externalId: 'uid1', + externalType: 'myCMS', + login: 'superjohn' + }), + options: JSON.stringify({ + roomId: 5, + moderator: true, + showAudioVideoTest: true + }) + }, + dataType: "json" +}) +</source> + </td> + <td> +<source> +{ + "serviceResult": { + "code": 0, + "message": "fa1f9381-bd03-42ae-9fd9-332b5f775a1b", + "type": "SUCCESS" + } +} +</source> + </td> + </tr> + </table> + </li> + <li>If your request was successful you will get your hash as <b>message</b> (fa1f9381-bd03-42ae-9fd9-332b5f775a1b)</li> + <li>Now you can use following URL to enter the room: <tt>http://localhost:5080/openmeetings/hash?secure=fa1f9381-bd03-42ae-9fd9-332b5f775a1b&language=1</tt></li> + </ul> + </section> + </body> +</document>
