Merge branch 'master' of github.com:bigbluebutton/bigbluebutton.github.io

Author: ffdixon

_posts/2015-04-05-faq.md

@@ -215,9 +215,6 @@ To obtain a committer agreement, download [BigBlueButton Inc. Contributor Agreem
 
 Once we receive the signed Contributor Agreement, we can review your submission for inclusion in BigBlueButton.  The process for submission depends on whether it's fixing a bug (submitting a pull request) or whether it's an enhancement (submitting a feature).
 
-## Where should I report potential security issues?
-You can email Fred Dixon, the product manager for BigBlueButton, at ffdixon .at. bigbluebutton .dot. org.
-
 ### Submission of a pull request
 
 If you want to submit a pull request, your chances of acceptance are **greatly** improved if the following are true:
@@ -275,6 +272,9 @@ For documentation of code method -- especially those classes that provides an AP
 
 For Flex/ActionScript code, follow the [AsDoc](https://flex.apache.org/asdoc/) format.
 
+## Where should I report potential security issues?
+You can email Fred Dixon, the product manager for BigBlueButton, at ffdixon .at. bigbluebutton .dot. org.
+
 # Installation
 
 ## What are the minimum hardware requirements for the BigBlueButton Server
@@ -427,7 +427,7 @@ Members of our community periodically host stress tests for BigBlueButton, which
 * Configuration of BigBlueButton
 * Version of BigBlueButton
 
-The scalability of a BigBlueButton session also depends on what media users are sharing in a session.  If you have a session with 20 users and all sharing their webcam, this scenario will generate 400 streams (10 incoming streams to the server and 390 outgoing streams).  Alternatively, if in the same session there is only one person (the instructor) sharing their webcam, there will be 20 streams (1 incoming and 19 outgoing).
+The scalability of a BigBlueButton session also depends on what media users are sharing in a session.  If you have a session with 20 users and all sharing their webcam, this scenario will generate 400 streams (20 incoming streams to the server and 380 outgoing streams).  Alternatively, if in the same session there is only one person (the instructor) sharing their webcam, there will be 20 streams (1 incoming and 19 outgoing).
 
 If you have a session with 20 users and all share their microphones, there will be 20 two-way audio stream being mixed by in real-time by FreeSWITCH. Alternatively, if only one user (the instructor) shares their microphone and 19 join Listen Only, then there is only one stream mixed by FreeSWITCH (less CPU), and 19 one way streams shared to the user.
 
@@ -451,7 +451,7 @@ BigBlueButton also comes with an easy-to-use front-end called [Greenlight](/inst
 
 ### How do I change the hostname of my BigBlueButton server
 
-If you change the hostname (or IP address) of your BigBlueButton server, you can easily change all the related BigBlueButton configuration files using the [bbb-conf tool ](/install/bbb-conf.html).
+If you change the hostname (or IP address) of your BigBlueButton server, you can easily change all the related BigBlueButton configuration files using the [bbb-conf tool](/install/bbb-conf.html).
 
 ### We recommend running BigBlueButton on port 80/443
 
@@ -480,25 +480,25 @@ For UDP ports, clients must be able to connect on a port within the range 16384-
 
 ### Does BigBlueButton support tunneling
 
-Yes.  See [Cofigure the firewall](/install/install.html#configure-the-firewall-if-required).
+Yes.  See [Configure the firewall](/install/install.html#configure-the-firewall-if-required).
 
 ### Can I provide secure access to BigBlueButton
 
 There are multiple security mechanisms in BigBlueButton.  
 
-When the BigBlueButton server is secured with an transport level security (TLS) certificate, all content download from the server to the user's browser occurs via hypertext transport protocol secure (HTTPS).  We provide an installation script for BigBlueButton that can automate the setup of TLS certificate (see [bbb-install.sh](https://github.com/bigbluebutton/bbb-install)).
+When the BigBlueButton server is secured with an transport level security (TLS) certificate, all content download from the server to the user's browser occurs via hypertext transport protocol secure (HTTPS).  We provide an installation script for BigBlueButton that can automate the setup of the TLS certificate (see [bbb-install.sh](https://github.com/bigbluebutton/bbb-install)).
 
 When a front-end makes an API request to BigBlueButton, the BigBlueButton server validates the incoming server checksum computed from a shared secret (see [API Security Model](http://docs.bigbluebutton.org/dev/api.html#api-security-model)).  If the checksum match fails, the request is ignored.
 
-When the BigBlueButton client loads, it makes data connections back to the BigBlueButton server using a web socket connection encrypted HTTPS.  When the BigBlueButton shares the user's audio, video, or screen, the browser uses the built-in web real-time communication (WebRTC) libraries that transmit real-time protocol packets (RTP) over user datagram protocol (UDP) via Datagram Transport Layer Security (see [DTLS](https://en.wikipedia.org/wiki/Datagram_Transport_Layer_Security)).  Furthermore, to provide communications privacy for datagram protocols the media packets are  encrypted using Secure Real-Time Protocol (see [SRTP](https://en.wikipedia.org/wiki/Secure_Real-time_Transport_Protocol)).  
+When the BigBlueButton client loads, it makes data connections back to the BigBlueButton server using a web socket connection encrypted HTTPS.  When the BigBlueButton shares the user's audio, video, or screen, the browser uses the built-in web real-time communication (WebRTC) libraries that transmit real-time protocol packets (RTP) over user datagram protocol (UDP) via Datagram Transport Layer Security (see [DTLS](https://en.wikipedia.org/wiki/Datagram_Transport_Layer_Security)).  Furthermore, to provide communications privacy for datagram protocols the media packets are encrypted using the Secure Real-Time Protocol (see [SRTP](https://en.wikipedia.org/wiki/Secure_Real-time_Transport_Protocol)).
 
-As desribed above, by saying there are _multiple_ security mechanisms BigBlueButton, does this mean BigBlueButton offers secure collaboration?  No.  No system is really secure, there are only levels of security.  There are always opportunities to make BigBlueButton more secure with each release.  To understand how we prioritize features for a release (and how you can influence the priorities), see [When will feature X be implemented?](/support/faq.html#when-will-feature-x-be-implemented).
+As described above, by saying there are _multiple_ security mechanisms BigBlueButton, does this mean BigBlueButton offers secure collaboration?  No.  No system is really secure, there are only levels of security.  There are always opportunities to make BigBlueButton more secure with each release.  To understand how we prioritize features for a release (and how you can influence the priorities), see [When will feature X be implemented?](/support/faq.html#when-will-feature-x-be-implemented).
 
 ## Front Ends
 
 ### Does BigBlueButton come with a front end?
 
-Yes.  You can install [GreenLight](/install/greenlight-v2.html) on your server.  GreenLight let's users quickly and easily create meetings, invite others, join meetings, and manage the recordings.
+Yes.  You can install [GreenLight](/install/greenlight-v2.html) on your server.  GreenLight lets users quickly and easily create meetings, invite others, join meetings, and manage the recordings.
 
 ![greenlight-start](/images/gl-start.png)
 
@@ -548,9 +548,9 @@ The best approach is to see how others have integrated and adapt their code to y
 
 The BigBlueButton server does not support persistent or permanent sessions where users can leave and return the next day, for example, and have their slides and chat messages persist.
 
-This is by design.  Why is this the case?  This design makes it easy for system administrators to upgrade or replace a BigBlueButton server without migrating/updating any database.  As an analogy, the BigBlueButton server works like a web server.  When loading content from web server, you don't tell a web server "I need to load a file at 2:00 PM tomorrow"; rather, you just load a file when needed. The web server responds to the request and, when finished, it forgets about the request and moves onto the next.  
+This is by design.  Why is this the case?  This design makes it easy for system administrators to upgrade or replace a BigBlueButton server without migrating/updating any database.  As an analogy, the BigBlueButton server works like a web server.  When loading content from a web server, you don't tell a web server "I need to load a file at 2:00 PM tomorrow"; rather, you just load a file when needed. The web server responds to the request and, when finished, it forgets about the request and moves onto the next.
 
-It's similar with the BigBlueButton server.  The lifespan of a session on the BigBlueButton server begins when a front-end sends a ```create``` API request to the BigBlueButton server.  Once a room is created (the ```create``` request succeeded), users can join the session and interact within the session.  The session ends (and is cleared from the server's memory) when the last person leaves, whereupon BigBlueButton clears the session from memory.
+It's similar with the BigBlueButton server.  The lifespan of a session on the BigBlueButton server begins when a front-end sends a ```create``` API request to the BigBlueButton server.  Once a room is created (the ```create``` request succeeded), users can join the session and interact within the session.  The session ends (and is cleared from the server's memory) when the last person leaves.
 
 # Using BigBlueButton
 
@@ -596,7 +596,7 @@ If you upload a PDF document, all your fonts will come through with the document
 
 If you upload a Word or Power Point document that has special fonts, such as Chinese language, the document must first be converted by LibreOffice into PDF.  Unless you've configured the LibreOffice server running within BigBlueButton to have the necessary fonts, then you will see empty spaces (or boxes) for the missing fonts.
 
-To add the Japanese fonts, enter the following commands on the BigBlueButton server.
+To add Japanese fonts, enter the following commands on the BigBlueButton server.
 
 ```bash
 $ sudo apt-get install libreoffice-l10n-ja
@@ -618,7 +618,7 @@ See Ubuntu's documentation for [Webcam Troubleshooting](https://help.ubuntu.com/
 
 ### Why can't others hear me in the voice conference
 
-If others in the voice conference don't hear you when you speak, it's likely that the browser has picked the wrong microphone on your computer.  You can click the phone icon twice -- once to leave and a second time to rejoin -- to try joiing the audio again.  When you see the echo test, if you can't hear yourself, click "no" and select a different microphone.
+If others in the voice conference don't hear you when you speak, it's likely that the browser has picked the wrong microphone on your computer.  You can click the phone icon twice -- once to leave and a second time to rejoin -- to try joining the audio again.  When you see the echo test, if you can't hear yourself, click "no" and select a different microphone.
 
 ### Why do others only hear part of my audio
 
@@ -630,7 +630,7 @@ You can also change the settings on FreeSWITCH to lower default threshold for au
  /opt/freeswitch/conf/autoload_configs/conference.conf.xml
 ```
 
-and set energy-level to a lower value (.e.g 100)
+and set energy-level to a lower value (e.g. 100)
 
 ```xml
    <profile name="wideband">
@@ -649,7 +649,7 @@ If a remote user is using a laptop with a built-in microphone, you should not he
 
 If a student is causing echo, the best way to solve this problem, if you are logged in as a moderator, is to mute the user by clicking the microphone icon to the left of their name.
 
-Overall, the best solution is ask all users to use a headset -- this will ensure no background noise or echo.
+Overall, the best solution is to ask all users to use a headset -- this will ensure no background noise or echo.
 
 ### How do I get the best audio
 
@@ -665,7 +665,7 @@ In BigBlueButton, the external application that uses the BigBlueButton API can n
 
 There is no user interface for the presenter to turn on or turn off a recording.
 
-When instructed through the API call, the BigBlueButton server will record all of the meeting, from the time the first person joins to when the last person leaves.  A meeting may also end when it reaches it's duration or the [end](/dev/api.html#end) is called on the meeting.
+When instructed through the API call, the BigBlueButton server will record all of the meeting, from the time the first person joins to when the last person leaves.  A meeting may also end when it reaches its duration or the [end](/dev/api.html#end) is called on the meeting.
 
 ### What parts of the session does BigBlueButton record
 
@@ -675,11 +675,11 @@ BigBlueButton records all activity in the presentation, chat, webcams, and deskt
 
 BigBlueButton supports playback in Chrome and FireFox.
 
-In BigBlueButton, the audio from a recorded session is encoded into [Vorbis](http://en.wikipedia.org/wiki/Vorbis), an open source audio format that is not patent encumbered.  Playback of Vorbis audio is supported in FireFox and Chrome, but not IE and Safari.
+In BigBlueButton, the audio from a recorded session is encoded into [Vorbis](http://en.wikipedia.org/wiki/Vorbis), an open source audio format that is not patent-encumbered.  Playback of Vorbis audio is supported in FireFox and Chrome, but not IE and Safari.
 
-BigBlueButton will playback the webcams from a session using the WebM container, which, thanks to Google, provides a high-quality open source video codec VP8.  Playback of video in VP8 is supported by FireFox and Chrome, but not IE and Safari.   See [HTML5 video](http://en.wikipedia.org/wiki/HTML5_video) Wikipedia article.
+BigBlueButton will playback the webcams from a session using the WebM container, which, thanks to Google, provides a high-quality open source video codec VP8.  Playback of video in VP8 is supported by FireFox and Chrome, but not IE and Safari.   See the [HTML5 video](http://en.wikipedia.org/wiki/HTML5_video) Wikipedia article.
 
-### What is the disk space usage for storing 1 hour of recordings
+### What is the disk space usage for storing one hour of recordings
 
 Storage values for different types of session in BigBlueButton 0.81.
 
@@ -693,7 +693,7 @@ The file sizes are for a one hour session.  When a recorded session ends, BigBlu
 
 #### Archive
 
-For audio, the storage of the audio stream is 110 MB/h.  The storage is a .wav file
+For audio, the storage of the audio stream is 110 MB/h.  The storage is a .wav file.
 
 For audio + webcam, the additional storage is for saving each individual webcam stream.  A one hour webcam stream at the default resolution (320x240) is 20M.
 
@@ -705,13 +705,13 @@ For playback, the audio, webcams, and desktop share are processed into a single
 
 For audio only, the WebM file is 5.4M. There is an additional Vorbis Audio File that is 5M.
 
-For audio + webcam only, there is a single webM file that is 51M
+For audio + webcam only, there is a single webM file that is 51M.
 
 For audio + desktop sharing, there is a single WebM that is 72M.
 
 ### Can I see the total time of the session
 
-The information displayed during playback is browser specific.
+The information displayed during playback is browser-specific.
 
 In Chrome, the audio playback component shows only the current time index for the playback.  To see the overall length of the session, you can scrub to the end of the audio after the audio file has loaded.
 
@@ -736,11 +736,11 @@ When looking to download a recorded session, most expect a single link to downlo
 
 In contrast, BigBlueButton does not create a video file for playback.  Video files for a three hour lecture can get very large.  Instead, BigBlueButton creates an HTML5 page that references PNG images and audio, and time indexes the PNG images against the audio to match their display in the session.  The result is the source playback files are very small and can be hosted on any web server.  The drawback is there will be a pause for the browser to download all this content, but, once downloaded, there is no more load on the web server.
 
-# Developing for BigBlueButton
+# Developing BigBlueButton
 
 ## Setup
 
-### Setting up the Dev environment
+### Setting up the dev environment
 
 See [Developing BigBlueButton](/dev/setup.html) for full instructions.
 
@@ -754,7 +754,7 @@ We recommend you setup a Ubuntu 16.04 64-bit VM, using VMWare Fusion or Virtual
 
 Once you have the development environment setup, you can mount the VM drive to Windows. When you launch Eclipse of Flex Builder, simply create your workspace on the VM drive. This way you'll be developing in Windows with the source on the VM. Once you're ready to deploy, switch to the VM console and deploy using ant. We've found this is the easiest way to develop for BigBlueButton.
 
-### What if I want to develop for the Client only
+### What if I want to develop for the client only
 
 If you are just working on the client side, you need to edit the file config.xml (located in the src/conf folder) to point to a running instance of BigBlueButton. Change all the IP addresses in the file to the IP of your BBB server or BBB VM. In the entry for the Viewers Module, change the attribute host to host="conf/join-mock.xml". This will enable you to launch and test the client directly from the Flex environment, bypassing the Web component of BigBlueButton.
 
@@ -770,7 +770,7 @@ This is related to localization. Before you launch your client, you need to firs
 
 ### Users do not appear in the listeners window
 
-For a user to appear in the listener's window, the 3rd party application using the BigBlueButton API to create a room must pass a `voiceBridge` parameter with the `create` call.  See [create meeting](/dev/api.html#create) call.  This is done using the [built-in API demos](/install/install.html#6.-install-api-demos)
+For a user to appear in the listener's window, the 3rd party application using the BigBlueButton API to create a room must pass a `voiceBridge` parameter with the `create` call.  See [create meeting](/dev/api.html#create) call.  This is done using the [built-in API demos](/install/install.html#6.-install-api-demos).
 
 Next, BigBlueButton must successfully connect to FreeSWITCH's SIP port and FreeSWITCH's Event Socket Layer.  To resolve connection problems, see question below.
 
@@ -803,7 +803,7 @@ eth0      Link encap:Ethernet  HWaddr 12:31:33:22:25:c2
 
 See [audio is not working](/install/install.html#audio-not-working) for how to resolve this.
 
-### I have 2 microphones and want to choose one to join the voice conference
+### I have two microphones and want to choose one to join the voice conference
 
 When you're inside the client, right-click, go to Settings > Microphone Icon > select your microphone, and talk to see if it works by checking the volume bar.